Python

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.

The SDK requires Python 3.10 or later.

Note

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

Getting started

Installation

Install the SDK using pip and import it into your project.

Quickstart

Connect to SurrealDB and perform your first queries in minutes.

Learn

Concepts

Understand how to connect, authenticate, query, and work with data types.

API Reference

Complete reference for all classes, 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