Python SDK

The SurrealDB SDK for Python enables simple and advanced querying of a remote or embedded database.

The SurrealDB SDK for Python lets you connect to SurrealDB from any Python application. It supports both synchronous and asynchronous workflows, connecting to remote instances over WebSocket or HTTP, and running embedded databases in-process. The SDK provides methods for querying, managing data and authentication, and subscribing to real-time updates with live queries.

Important

The SDK requires Python 3.10 or later, and is available as a PyPI package.

Note

The latest version of the SDK is 2.0.0.
The SDK works with SurrealDB versions v2.0.0 to v3.2.0, ensuring compatibility with the latest version.

Getting started

Installation

Install the SDK and add it to your project.

Getting started guide

Connect to SurrealDB and run your first queries.

Learn

Concepts

Guides for connecting, authenticating, querying, and working with data.

API Reference

Complete reference for the SDK's methods, types, and errors.

Contributing

To contribute to the SDK code, submit an Issue or Pull Request in the surrealdb.py repository. To contribute to this documentation, submit an Issue or Pull Request in the docs.surrealdb.com repository.

Getting started

Learn

Contributing

Sources