SurrealDB Docs Logo

Enter a search query

Back to home
Overview Installation Quick start Data Types
Methods
Introduction authenticate close connect - Surreal create delete info insert insert_relation invalidate kill let live merge patch query select signin signup subscribe_live unset update upsert use
Concepts
Introduction Create a new connection Handle authentication Set parameters Data manipulation Real-Time data streaming Run SurrealQL queries
surrealdb/surrealdb.py
Overview
Python

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.10 or greater, and is available as a PyPI package.

Note

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

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

Edit this page on GitHub
Installation