Managing Records - Semple Developer Docs

Once your client is initialized, you interact with records by scoping to a specific ModuleBuilder using the semple.module(moduleId) method.

Fetching Records

The SDK provides a fluent QueryBuilder for retrieving records. Use the .select() method, chain your filters or limits, and terminate with .execute().

const customerModule = semple.module("mod_customers_123");

const response = await customerModule
  .select()
  .limit(20)
  .execute();

console.log(`Returned ${response.records.length} records`);
console.log(`Next cursor: ${response.nextCursor}`);

QueryBuilder Methods

method

Filter records using a map of logical field IDs to exact values.

method

Set the maximum number of records to return.

method

Set the pagination cursor to fetch the next page of results.

method

required

Resolves the built query against the Semple Records Engine, returning a QueryResult.

Creating Records

To insert data, map your values precisely to the field names configured in your dashboard using the .insert() method.

const orderId = await semple.module("mod_orders_456").insert({
  "Total Amount": 150.00,
  "Status": "Pending",
  "Is Rush Delivery": true
});

console.log(`Created order with ID: ${orderId}`);

If you pass an invalid data type (e.g., a string into a number field), the SDK will throw an invalid_argument error. See Data Types for strict typing rules.

Updating Records

Update an existing record by providing its recordId. You only need to pass the fields you wish to modify; omitted fields remain unchanged.

const success = await semple.module("mod_orders_456").update("rec_8f73b2a1", {
  "Status": "Shipped",
  "Tracking Number": "1Z9999999999999999"
});

Getting a Single Record

Retrieve the full data for a single record using .get().

const record = await semple.module("mod_orders_456").get("rec_8f73b2a1");
console.log(record.data);

Deleting Records

Permanently remove a record from the database. This action cannot be undone.

const success = await semple.module("mod_orders_456").delete("rec_4d5e6f7g");

​Fetching Records

​QueryBuilder Methods

​Creating Records

​Updating Records

​Getting a Single Record

​Deleting Records

Fetching Records

QueryBuilder Methods

Creating Records

Updating Records

Getting a Single Record

Deleting Records