NoSQL JavaScript SDK

# NoSQL JavaScript SDK

# Overview

NoSQL is a *Catalyst CloudScale* component that offers a fully managed, non-relational data storage feature that enables you to store semi-structured, unstructured, and disparate data of your application in either document-type or key-value based JSON format.

The *NoSQL JavaScript SDK* package enables you to perform CRUD operations in your NoSQL tables in your project. You can fetch the metadata of your NoSQL tables, as well as query tables or indexes of tables by specifying query conditions.

### Prerequisites

You need to install the following package to be able to use the NoSQL SDK methods.

npm install @zcatalyst/nosql

Info: Ensure that you have applied the required authentication configuration to use the SDK methods of this component.

### Import Requirement

You need to import the following module to use the NoSQL SDK methods.

const { NoSQL } = require('@zcatalyst/nosql');//NoSQL module

### List of SDK Methods

The following table contains the list of SDK methods that can be used to perform operations in the NoSQL tables through code.

<table border="1" cellpadding="8" cellspacing="0">
  <thead>
    <tr>
      <th>Category</th>
      <th>SDK Method</th>
      <th>Required Scope</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>General Operations</td>
      <td>Create a NoSQL Instance</td>
      <td>Not required</td>
    </tr>
    <tr>
      <td>NoSQL Operations</td>
      <td>
        <ul>
            <li>Get table metadata
              <ul>
                <li>Get table metadata with Table ID</li>
                <li>Get table metadata with Table Name</li>
                <li>Get metadata of all tables</li>
              </ul>
            </li>
            <li>Get table instance
              <ul>
                <li>Get instance with Table ID</li>
                <li>Get instance with Table Name</li>
                <li>Get instance with Table details</li>
              </ul>
            </li>
            <li>Construct NoSQL item</li>
            <li>Insert items in table</li>
            <li>Manipulate NoSQL Items</li>
            <li>Update items in table</li>
            <li>Fetch items from table</li>
            <li>Query table</li>
            <li>Query index</li>
            <li>Delete items from table</li>
        </ul>
      </td>
      <td>Admin</td>
    </tr>
  </tbody>
</table>

NoSQL is a Catalyst CloudScale component that offers a fully managed, non-relational data storage feature that enables you to store semi-structured, unstructured, and disparate data of your application in either document-type or key-value based JSON format.

The NoSQL JavaScript SDK package enables you to perform CRUD operations in your NoSQL tables in your project. You can fetch the metadata of your NoSQL tables, as well as query tables or indexes of tables by specifying query conditions.

Prerequisites

You need to install the following package to be able to use the NoSQL SDK methods.

copy
$npm install @zcatalyst/nosql

Info: Ensure that you have applied the required authentication configuration to use the SDK methods of this component.

Import Requirement

You need to import the following module to use the NoSQL SDK methods.

copy

         const { NoSQL } = require('@zcatalyst/nosql');//NoSQL module

List of SDK Methods

The following table contains the list of SDK methods that can be used to perform operations in the NoSQL tables through code.

Category	SDK Method	Required Scope
General Operations	Create a NoSQL Instance	Not required
NoSQL Operations	Get table metadata Get table metadata with Table ID Get table metadata with Table Name Get metadata of all tables Get table instance Get instance with Table ID Get instance with Table Name Get instance with Table details Construct NoSQL item Insert items in table Manipulate NoSQL Items Update items in table Fetch items from table Query table Query index Delete items from table	Admin

Last Updated 2026-07-02 14:51:41 +0530 IST

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit

Catalyst CloudScale NoSQL Help Documentation Java SDK Documentation NodeJS SDK Documentation Python SDK Documentation REST API Documentation

Modular JavaScript SDK

SDK Operations

NoSQL JavaScript SDK

Prerequisites

Import Requirement

List of SDK Methods