Skip to content
Sign In

API Reference

/

Core Classes

Core classes

The connection, session, transaction, and query execution classes that make up the SDK's core surface.

The core classes cover connecting to SurrealDB, scoping work to a session or a transaction, and executing queries. Every other part of the SDK is reached through one of these.

  • Surreal - The main entry point for connecting to and interacting with a SurrealDB instance.

  • SurrealSession - Session-scoped context with authentication and query execution.

  • SurrealQueryable - The query execution methods shared by sessions and transactions.

  • SurrealTransaction - Atomic transaction support for executing multiple queries.

  • SurrealApi - Methods for invoking user-defined API endpoints.

  • Query builders - The builder returned by each query method

  • Data types - Value classes used in queries and results

  • Errors - Error classes raised by these methods

Was this page helpful?