Database

A secure client library for MongoDB & MySQL API

Install

JavaScript

npm i @appstitch/database

Flutter

appstitch_database: ^1.0.0

Install peer dependencies

JavaScript

npm i @appstitch/core

Flutter

appstitch_core: ^2.0.0

Usage

API

Method	Type	Description	Platform
collection	Collection Name	Interchangeable with table	MongoDB & MySQL
table	Table Name	Interchangeable with collection	MongoDB & MySQL
id	ID, FieldName (Optional)	Set the ID for a specific document/record. FieldName is only required for MySQL	MongoDB & MySQL
where	Field, OperatorType, Value	A query object used to filter documents	MongoDB & MySQL
limit	number	Limits the number of documents. Default 50	MongoDB & MySQL
include	Field Array	Return specific fields.	MongoDB & MySQL
exclude	Field Array	Prevent specific fields from being returned	MongoDB & MySQL
startAfter	number	Skips the first n documents/records	MongoDB & MySQL
orderBy	Field, Direction	Specified order for results	MongoDB & MySQL
join	Source Field, Destination Table, Destination Field, JoinType	Used to combine rows from two or more tables	MySQL

Read Operations

Get by ID

JavaScript

// MongoDB

db.collection("Users")
  .id("7b5f87cfb6ce44f98c82a1c6")
  .then(result => {
     if(result.success)
     {
        const user = result.doc;
     }
     else
     {
        // handle error
     }
  })
  
// MySQL

db.table("Users")
  .id("7b5f87cfb6ce44f98c82a1c6", "UserID")
  .then(result => {
     if(result.success)
     {
        const user = result.doc;
     }
     else
     {
        // handle error
     }
  })

Flutter

// MongoDB 

final result = await db
        .collection("Users")
        .id("7b5f87cfb6ce44f98c82a1c6")
        .fetch();

    if (result.success!) {
        user = User.fromJson(result.doc!);
    } else {
        // handle error
    }
    
    
// MySQL

final result = await db
        .table("Users")
        .id("7b5f87cfb6ce44f98c82a1c6", "UserID")
        .fetch();

    if (result.success!) {
        user = User.fromJson(result.doc!);
    } else {
        // handle error
    }

collection("users") and table("users") is interchangable and has the same effect. Appstitch offers a linguistic convention for both the NoSQL and SQL world

Get multiple documents

JavaScript

// MongoDB

db.collection("Users")
  .where("City", "==", "NewYork")  
  .then(result => {
     if(result.success)
     {
        const user = result.doc;
     }
     else
     {
        // handle error
     }
  })

Flutter

final result = await db
        .collection("Users")
        .where("City", OperatorType.equal, "NewYork")    
        .limit(25)    
        .fetch();

    if (result.success!) {
        user = User.fromJson(result.doc!);
    } else {
        // handle error
    }

Write Operations

Insert

JavaScript

db.collection("Users")
    .insert({name : "Bruce", city : "Gotham"})
    .then(result => {
        if (result.success) {
            const userID = result.id;
        } else {
            // handle error
        }
    })

Flutter

final user = User(
        name: "Clark K",
        city: "Metropolis")


final result = await db
        .collection("users")
        .insert(user);

if (result.success!) {
    final userID = result.id!;
} else {
    // handle error
}

Update

JavaScript

const result =  db
               .collection("users")
               .doc(userID)
               .update({city : "New York"})
               .then(result => {
                 if (result.success) {
                   // success 
                 } else {
                     // handle error
                 }
               })

Flutter

 final result = await db
               .collection("users")
               .doc(userID)
               .update(user.toJson());

if (result.success!) {
  print("Successfully Updated");
} else {
    // handle error
}

Delete

JavaScript

const result =  db
               .collection("users")
               .doc(userID)
               .update({city : "New York"})
               .then(result => {
                 if (result.success) {
                   // success 
                 } else {
                     // handle error
                 }
               })

Flutter

 final result = await db
    .collection("users")
    .id(userID)
    .delete();

if (result.success!) {
    // success
} else {
    // handle error
}

Algolia Integration

Appstitch can be used to keep your Algolia indices in sync. Just pass syncData with any write operation.

The Algolia index will need to have the identical name (and case) as your collection/table

Algolia example

JavaScript

db.collection("Users")
    .insert(
    {name : "Bruce", city : "Gotham"}, 
    {syncData : true} // <-- User will be created in Algolia 
    )
    .then(result => {
        if (result.success) {
            const userID = result.id;
        } else {
            // handle error
        }
    })

Flutter

const opts = WriteOptions(syncData: true)

final result = await db
        .collection("users")
        .insert(
        user,
        opts // <-- User will be created in Algolia 
        );

if (result.success!) {
    final userID = result.id!;
} else {
    // handle error
}