Query builders

Query methods on a session or transaction return a builder rather than a plain promise. Each builder exposes chainable methods for configuring the operation, and is awaited to execute it.

Builders

• •

  SelectPromise - Configures SELECT queries.

• •

  CreatePromise - Configures CREATE operations.

• •

  UpdatePromise - Configures UPDATE operations.

• •

  UpsertPromise - Configures UPSERT operations (insert or replace).

• •

  InsertPromise - Configures INSERT operations.

• •

  DeletePromise - Configures DELETE operations.

• •

  RelatePromise - Configures RELATE operations for graph relationships.

• •

  Query - Executes raw SurrealQL, with streaming and batch processing support.

• •

  LivePromise - Manages real-time live query subscriptions.

• •

  RunPromise - Executes SurrealDB functions and SurrealML models.

• •

  ApiPromise - Executes user-defined API calls.

See also

• •

  Core classes - The classes these builders are created from

• •

  Executing queries - Conceptual overview with examples

• •

  SurrealQL statements - The query language reference