Skip to main content

Creating a Client

Core Operations

store

Store data with USDC payment.

query

Query data with filters.

health

Health check.

CRUD Operations

Create

Store documents in a collection.

Read (Single)

Find the latest version of a single document.

Read (Many)

Find multiple documents with filters.

Update

Find, modify, and re-store to append a new version.

Delete (Soft)

Find, set deleted flag, and re-store.

Count

Count matching documents.

Query Builder

queryBuilder

Create fluent query builder.

Task Management

getTaskStatus

Get task status.

waitForTaskCompletion

Wait for task.

SQL Interface

sql

Execute SQL queries against your collections.

sqlInsert

Execute SQL INSERT statements.

Predefined Queries

createQuery

Create a named, parameterized query that can be executed via a public endpoint.

executeQuery

Execute a predefined query (public endpoint, no auth required).

listQueries / getQuery / deleteQuery

Collection Management

createCollection

Create a collection with schema-based index configuration.

syncCollection

Sync a schema to the backend (creates new indexes, upsert behavior). Supports sharding configuration.

setupSharding

Configure sharding on an existing collection.

updateCollection

Update collection properties.

deleteCollection / getCollectionInfo

Data Retention

getRetention / setRetention

Events (TypeScript Only)

The TypeScript SDK supports event-based transaction tracking:

Next Steps

Query Builder

Fluent query API reference

Database Manager

Collections, indexes, and views