swiftbase_db_sdk

Overview

swiftbase_db_sdk is an SDK that developers can use to communicate with the Swiftbase DB service, a NoSQL database service provided by the Swiftbase PaaS. It provides all the features needed to perform common database operations, such as inserting, updating, retrieving, and deleting records.

Usage

To use the SDK, import the main module:

const { SwiftbaseDb } = require("swiftbase_db_sdk");

Then, create a data access object (DAO) by instantiating the SwiftbaseDb class, passing in your authentication token:

const dao = new SwiftbaseDb.default("YOUR_AUTH_TOKEN");

Once the DAO is created, you can start interacting with the Swiftbase DB service:

• Insert a record:

dao.model("my_model").insert({
  name: "John Doe",
  email: "[email protected]",
});

If the model does not exist, it will be created automatically.

• Find all records:

const records = await dao.model("my_model").find();

• Find a specific record:

const record = await dao
  .model("my_model")
  .find({ email: "[email protected]" });

• Update a record:

dao
  .model("my_model")
  .update({
    name: "Jane Doe",
  })
  .where({ email: "[email protected]" });

• Delete a record:

dao.model("my_model").delete({ email: "[email protected]" });

Examples

Here are some examples of how to use the SDK:

// Insert a record
const dao = new SwiftbaseDb("YOUR_AUTH_TOKEN");
dao.model("my_model").insert({
  name: "John Doe",
  email: "[email protected]",
});

// Find all records
const records = await dao.model("my_model").find();

// Find a specific record
const record = await dao
  .model("my_model")
  .find({ email: "[email protected]" });

// Update a record
dao
  .model("my_model")
  .update({
    name: "Jane Doe",
  })
  .where({ email: "[email protected]" });

// Delete a record
dao.model("my_model").delete({ email: "[email protected]" });

Documentation

swiftbase documentation

Contributor

Bisrat Awoke

License

MIT

Keywords

Swiftbase node