/catalyst-nosql

Overview

Catalyst NoSQL is a key-value store organized into tables. Each table requires a partition key (and optionally a sort key) defined at creation time. Items are typed attribute maps built with the NoSQLItem builder — not plain JSON objects.

Pre-requisite: Create the table in the console (Console → Cloud Scale → NoSQL) before writing SDK code. The table name and partition-key column name must be known.

Data model

SDK Operations (Node.js)

const { NoSQLItem, NoSQLMarshall, NoSQLEnum } = require('zcatalyst-sdk-node/lib/no-sql');
const { NoSQLOperator, NoSQLUpdateOperationType } = NoSQLEnum;

const nosql = catalystApp.nosql();
// nosql.table(name) returns an instance without an API call
const table = nosql.table('UserProfiles');
// Table name from Console → Cloud Scale → NoSQL

// --- INSERT ---
// insertItems(...items) — spread one or more INoSQLInsertItem objects
await table.insertItems({
  item: new NoSQLItem()
    .addString('userId', 'u123')        // partition key
    .addString('name', 'Alice')
    .addNumber('age', 30)
    .addBoolean('active', true)
});

// --- FETCH by key ---
// fetchItem({ keys }) — keys can be a single NoSQLItem or an array for batch fetch
const result = await table.fetchItem({
  keys: new NoSQLItem().addString('userId', 'u123')
});
// result.toJSON() → INoSQLResponse with result.create/get/update/delete arrays

// --- UPDATE ---
// updateItems(...updates) — keys identifies the item; update_attributes describes what to change
await table.updateItems({
  keys: new NoSQLItem().addString('userId', 'u123'),
  update_attributes: [
    {
      operation_type: NoSQLUpdateOperationType.PUT,
      attribute_path: ['name'],
      update_value: NoSQLMarshall.makeString('Alice Smith')
    }
  ]
});

// --- DELETE ---
// deleteItems(...deletes) — keys must include the partition key (and sort key if table has one)
await table.deleteItems({
  keys: new NoSQLItem().addString('userId', 'u123')
});

// --- QUERY ---
// queryTable({ key_condition, limit? }) — must include partition-key equality as condition
const queryResult = await table.queryTable({
  key_condition: {
    attribute: ['userId'],
    operator: NoSQLOperator.EQUALS,
    value: NoSQLMarshall.makeString('u123')
  },
  limit: 50
});

NoSQLItem builder cheat-sheet

When to Use NoSQL vs Data Store

Common Errors