---
title: "Query Index"
url: https://docs.catalyst.zoho.com/en/sdk/nodejs/v2/cloud-scale/nosql/query-index/
description: "Catalyst NoSQL is a fully-managed, powerful database that provides you with a non-relational, non-SQL means of data storage. This page describes the SDK method to query a NoSQL index."
last_updated: 2026-09-08T11:07:33Z
service: Cloud Scale
type: general
related_links:
  - name: "NoSQL"
    url: /en/cloud-scale/help/nosql/introduction
  - name: "Table Keys"
    url: /en/cloud-scale/help/nosql/components/#table-keys
  - name: "JavaScript SDK"
    url: /en/sdk/javascript/v1/cloudscale/nosql/query-index/
---

# Query Index in NoSQL

> **Note:** This SDK is currently in deprecation. Migrate to [JavaScript SDK](https://docs.catalyst.zoho.com/en/sdk/javascript/v1/cloudscale/nosql/query-index/) now.

Catalyst enables you to query a [NoSQL](https://docs.catalyst.zoho.com/en/cloud-scale/help/nosql/introduction/) index and retrieve data by identifying the items using the [primary keys](https://docs.catalyst.zoho.com/en/cloud-scale/help/nosql/components/#table-keys) of the index. Indexing allows you to execute alternate queries on the table data without making use of the primary keys of the main table. You can configure indexes from the Catalyst console. You can use just the partition key or a combination of the partition key and sort key of the index to retrieve an item. 

> **Note:** Catalyst enables you to retrieve a maximum of 100 items in bulk from a NoSQL table with pagination from a single SDK operation. You must use the `start_key` token received in the SDK response and construct the logic for pagination.

You can define the key condition that identifies the item by specifying the attributes, their required values, and the supported operator to be used. The supported operators are represented as shown below.

<table class="content-table nosql-components-table">

<thead>
        <tr>
            <th class="w10p">Operators</th>
            <th class="w10p">Notation</th>
        </tr>
</thead>
<tbody>
    <tr>
        <td>CONTAINS</td>
        <td>`contains`</td>
    </tr>
    <tr>
        <td>NOT_CONTAINS</td>
        <td>`not_contains`</td>
    </tr>
    <tr>
        <td>BEGINS_WITH</td>
        <td>`begins_with`</td>
    </tr>
    <tr>
       <td>ENDS_WITH</td>
        <td>`ends_with`</td>
    </tr>
    <tr>
        <td>IN</td>
        <td>`in`</td>
    </tr>
    <tr>
        <td>NOT_IN</td>
        <td>`not_in`</td>
    </tr>
    <tr>
        <td>BETWEEN</td>
        <td>`between`</td>
    </tr>
    <tr>
        <td>NOT_BETWEEN</td>
        <td>`not_between`</td>
    </tr>
    <tr>
        <td>EQUALS</td>
        <td>`equals`</td>
    </tr>
    <tr>
        <td>NOT_EQUALS</td>
        <td>`not_equals`</td>
    </tr>
	<tr>
        <td>GREATER_THAN</td>
        <td>`greater_than`</td>
    </tr>
	<tr>
        <td>LESS_THAN</td>
        <td>`less_than`</td>
    </tr>
	<tr>
        <td>GREATER_THAN_OR_EQUALS</td>
        <td>`greater_equal`</td>
    </tr>
	<tr>
        <td>LESSER_THAN_OR_EQUALS</td>
        <td>`less_equal`</td>
    </tr>
	<tr>
        <td>AND</td>
        <td>`AND`</td>
    </tr>
	<tr>
        <td>OR</td>
        <td>`OR`</td>
    </tr>
</tbody>
</table>

In the example below, the query is executed by identifying the items using the index `FruitIdentifier` 's partition key `fruitColor` and specifying the condition value as "yellow". The query is done using the `queryIndex()` method.

Catalyst NoSQL also lets you define other elements of the query, such as using `consistent_read` to indicate if the read operation must be done using the master or a slave cluster, limiting the number of rows to be returned, and specifying the sorting order as ascending. 

> **Note:** In the master-slave replication, the master contains all the data of the database, and the slave contains copies from the master. Performing a read operation from the slave can reduce the overall cost with the trade-off being a minor delay in the updated data being reflected.

The `no-sql` library from  the `zcatalyst-sdk-node` package is required to define the NoSQL item.

```javascript
const { NoSQLMarshall, NoSQLEnum } = require('zcatalyst-sdk-node/lib/no-sql');
const { NoSQLOperator } = NoSQLEnum;
//Query a NoSQL table index to fetch the items identified by the partition key fruitColour with the value "yellow"
const queriedIndexItems = await table.queryIndex('FruitIdentifier', {
//Define the key condition to query the items with
key_condition: {
attribute: 'fruitColor',
//Define the supported operator to be used
operator: NoSQLOperator.EQUALS,
value: NoSQLMarshall.makeString('yellow')
},
// Set consistent_read to true to query from master. If set to false, it is queried from slave.
consistent_read: true,
//Limit the number of rows to be returned by specifying a value
limit: 15,
// Set forward_scan to true to sort the results in ascending order. Otherwise, it is sorted in the descending order.
forward_scan: true
});
```