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.
ImportantThe SDK requires Python version
3.8or greater, and is available as a PyPI package.
CautionThis SDK is not yet compatible with
v2.xof SurrealDB. If you want to use the SDK you must be usingv1.xof SurrealDB.
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.
