Spanner mit SQLAlchemy ORM (GoogleSQL-Dialekt) integrieren
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
SQLAlchemy ist ein Python SQL-Toolkit und ein objektrelationaler Mapper.
Mit dem Spanner-Dialekt für SQLAlchemy können SQLAlchemy-Nutzer Spanner-Datenbanken verwenden. Der Dialekt basiert auf der Spanner API, die gemäß PEP-249 entwickelt wurde und mit SQLAlchemy-Versionen zwischen 1.1.13 und 1.3.23 sowie 2.0 kompatibel ist.
Spanner-Dialekt für SQLAlchemy einrichten
Wenn Sie den Spanner-Dialekt für SQLAlchemy in Ihrer Anwendung einrichten möchten, installieren Sie die sqlalchemy-spanner package.
pip3installsqlalchemy-spanner
Alternativ können Sie die Installation aus der Quelle ausführen.
Geben Sie als Authentifizierung für den Spanner-Dialekt für SQLAlchemy den Speicherort der JSON-Anmeldedaten für das Dienstkonto in der Umgebungsvariablen GOOGLE_APPLICATION_CREDENTIALS an. Andernfalls kann der Dialekt auch die Standardanmeldedaten verwenden, die in der gcloud-Befehlszeilen-Anwendung festgelegt sind.
Spanner-Dialekt für SQLAlchemy verwenden
Weitere Informationen zu den verfügbaren Funktionen, Einschränkungen des Dialects, Empfehlungen zur Verwendung des Dialects und Codebeispiele finden Sie in der Referenzdokumentation auf GitHub.
Nächste Schritte
Codebeispiele zur Verwendung des Spanner-Dialekts für SQLAlchemy
Repository für den Spanner-Dialekt für SQLAlchemy auf GitHub ansehen
Ein GitHub-Problem senden, um einen Fehler zu melden oder eine Frage zum Spanner-Dialekt für SQLAlchemy zu stellen
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Schwer verständlich","hardToUnderstand","thumb-down"],["Informationen oder Beispielcode falsch","incorrectInformationOrSampleCode","thumb-down"],["Benötigte Informationen/Beispiele nicht gefunden","missingTheInformationSamplesINeed","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-08-17 (UTC)."],[],[],null,["# Integrate Spanner with SQLAlchemy ORM (GoogleSQL dialect)\n\n[SQLAlchemy](https://www.sqlalchemy.org/) is a Python SQL toolkit and Object\nRelational Mapper.\n\nThe [Spanner dialect for SQLAlchemy](https://github.com/googleapis/python-spanner-sqlalchemy) lets\nSQLAlchemy users to use Spanner databases. The dialect is built on top\nof the [Spanner API](https://github.com/googleapis/python-spanner/tree/main/google/cloud/spanner_dbapi), which is designed in\naccordance with [PEP-249](https://www.python.org/dev/peps/pep-0249/), and is compatible with\nSQLAlchemy versions between [1.1.13](https://pypi.org/project/SQLAlchemy/1.1.13/) and\n[1.3.23](https://pypi.org/project/SQLAlchemy/1.3.23/), and [2.0](https://pypi.org/project/SQLAlchemy/2.0.0/).\n\n\n| **PostgreSQL interface note:** To use [PostgreSQL interface for Spanner](/spanner/docs/postgresql-interface) with SQLAlchemy, see [Integrate Spanner with SQLAlchemy 2 ORM (PostgreSQL-dialect)](/spanner/docs/use-sqlalchemy-pg).\n\n\u003cbr /\u003e\n\nSet up the Spanner dialect for SQLAlchemy\n-----------------------------------------\n\nTo set up the Spanner dialect for SQLAlchemy in your application, install the\n[`sqlalchemy-spanner package`](https://pypi.org/project/sqlalchemy-spanner/). \n\n pip3 install sqlalchemy-spanner\n\nAlternatively, you can install from source. \n\n git clone https://github.com/googleapis/python-spanner-sqlalchemy.git\n cd python-spanner-sqlalchemy\n python setup.py install\n\nAs authentication for the Spanner dialect for SQLAlchemy, provide the [service account\nJSON credentials](/docs/authentication/getting-started) file location in the\n`GOOGLE_APPLICATION_CREDENTIALS` environment variable. Otherwise, the dialect\ncan also use the default credentials set in the gcloud CLI\napplication.\n\nUse the Spanner dialect for SQLAlchemy\n--------------------------------------\n\nFor more information about the available features, limitations of the dialect,\nrecommendations on how to use the dialect, and for code samples, please consult\nthe [reference documentation](https://github.com/googleapis/python-spanner-sqlalchemy#readme) on\nGitHub.\n\nWhat's next\n-----------\n\n- Check out the [code examples](https://github.com/googleapis/python-spanner-sqlalchemy/blob/main/samples/snippets.py) on how to use the Spanner dialect for SQLAlchemy.\n- View the repository for the Spanner dialect for SQLAlchemy on [GitHub](https://github.com/googleapis/python-spanner-sqlalchemy).\n- File a [GitHub issue](https://github.com/googleapis/python-spanner-sqlalchemy/issues) to report a bug or ask a question about the Spanner dialect for SQLAlchemy.\n- Learn more about [SQLAlchemy](https://www.sqlalchemy.org/).\n- Learn more about [PyPI](https://pypi.org/).\n- Learn about authorization and authentication credentials in [Getting started with authentication](/docs/authentication/getting-started)."]]
