Python SDK

The SurrealDB SDK for Python is the primary SDK for interacting with SurrealDB from server-side applications, systems, and APIs, and data analysis and engineering tools. You can use the Python SDK to interact with your SurrealDB database instances, or to run SurrealDB as an embedded database within your Python application, with functionality for executing queries, managing data, running database functions, authenticating to the database, building user signup and authentication functionality, and subscribing to data changes with live queries. When connecting to remote database instances, connections automatically reconnect when terminated.

Important

The SDK requires Python version 3.8 or greater, and is available as a PyPI package.

Note

The SDK works seamlessly with SurrealDB versions v2.0.0 to v2.1.4, ensuring compatibility with the latest version.

Warning

This API is not yet fully stabilized and may be subject to change until the SDK reaches 1.0.0.

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 SurrealDB documentation repository.

Sources

• GitHub repository
• PyPI package