Como autenticação para o dialeto Spanner para SQLAlchemy, forneça o local do arquivo credenciais JSON da conta de serviço na variável de ambiente GOOGLE_APPLICATION_CREDENTIALS. Caso contrário, o dialeto
também poderá usar as credenciais padrão definidas no aplicativo
CLI gcloud.
Usar o dialeto Spanner para o SQLAlchemy
Para mais informações sobre os recursos disponíveis, as limitações do dialeto,
as recomendações sobre como usar o dialeto e para amostras de código, consulte
a documentação de referência no
GitHub.
A seguir
Confira os exemplos de código sobre como usar o
dialeto Spanner para SQLAlchemy.
Confira o repositório do dialeto Spanner para SQLAlchemy no
GitHub.
Registre um problema no GitHub para relatar um bug ou fazer uma
pergunta sobre o dialeto Spanner para SQLAlchemy.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 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)."]]
