10000 GitHub - googleapis/python-spanner-django at 09150a164f0efa511fa4caa1a4593fcd7b06ee26
[go: up one dir, main page]
Skip to content

googleapis/python-spanner-django

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

536 Commits
.github
.github
 
 
.kokoro
.kokoro
 
 
assets
assets
 
 
django_spanner
django_spanner
 
 
docs
docs
 
 
examples
examples
 
 
testing
testing
 
 
tests
tests
 
 
.coveragerc
.coveragerc
 
 
.gitignore
.gitignore
 
 
.repo-metadata.json
.repo-metadata.json
 
 
.trampolinerc
.trampolinerc
 
 
CHANGELOG.md
CHANGELOG.md
 
 
CODE_OF_CONDUCT.md
CODE_OF_CONDUCT.md
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE
LICENSE
 
 
README.rst
README.rst
 
 
SECURITY.md
SECURITY.md
 
 
create_test_instance.py
create_test_instance.py
 
 
django_test_apps.txt
django_test_apps.txt
 
 
django_test_suite.sh
django_test_suite.sh
 
 
django_test_suite_3.2.sh
django_test_suite_3.2.sh
 
 
foreign_key_test.sh
foreign_key_test.sh
 
 
noxfile.py
noxfile.py
 
 
owlbot.py
owlbot.py
 
 
pyproject.toml
pyproject.toml
 
 
renovate.json
renovate.json
 
 
run_testing_worker.py
run_testing_worker.py
 
 
setup.cfg
setup.cfg
 
 
setup.py
setup.py
 
 
version.py
version.py
 
 

Repository files navigation

Cloud Spanner support for Django

GA pypi versions

Cloud Spanner is the world's first fully managed relational database service to offer both strong consistency and horizontal scalability for mission-critical online transaction processing (OLTP) applications. With Cloud Spanner you enjoy all the traditional benefits of a relational database; but unlike any other relational database service, Cloud Spanner scales horizontally to hundreds or thousands of servers to handle the biggest transactional workloads.

Quick Start

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Google Cloud Spanner API.
  4. Setup Authentication.

This package provides a 3rd-party database backend for using Cloud Spanner with the Django ORM. It uses the Cloud Spanner Python client library under the hood.

Installation

Install this library in a virtualenv using pip. virtualenv is a tool to create isolated Python and Django environments. The basic problem it addresses is one of dependencies and versions, and indirectly permissions.

With virtualenv, it's possible to install this library without needing system install permissions, and without clashing with the installed system dependencies.

Supported versions

The library supports Django 2.2, and Django 3.2. Both versions are long-term support (LTS) releases for the Django project<https://www.djangoproject.com/download/#supported-versions>_. The minimum required Python version is 3.6.

pip3 install django==3.2

Installing the package

To install from PyPI:

pip3 install django-google-spanner

To install from source:

< CEE0 div class="highlight highlight-source-shell notranslate position-relative overflow-auto" dir="auto" data-snippet-clipboard-copy-content="git clone git@github.com:googleapis/python-spanner-django.git cd python-spanner-django pip3 install -e .">
git clone git@github.com:googleapis/python-spanner-django.git
cd python-spanner-django
pip3 install -e .

Creating a Cloud Spanner instance and database

If you don't already have a Cloud Spanner database, or want to start from scratch for a new Django application, you can create a new instance and database using the Google Cloud SDK:

gcloud spanner instances create $INSTANCE --config=regional-us-central1 --description="New Django Instance" --nodes=1
gcloud spanner databases create $DB --instance $INSTANCE

Configuring settings.py

This package provides a Django application named django_spanner. To use the Cloud Spanner database backend, the application needs to installed and configured:

  • Add django_spanner as the first entry in INSTALLED_APPS:

    INSTALLED_APPS = [
    'django_spanner',
    ...
]

  • Edit the DATABASES setting to point to an existing Cloud Spanner database:

    DATABASES = {
    'default': {
        'ENGINE': 'django_spanner',
        'PROJECT': '$PROJECT',
        'INSTANCE': '$INSTANCE',
        'NAME': '$DATABASE',
    }
}

Set credentials and project environment variables

You'll need to download a service account JSON key file and point to it using an environment variable:

export GOOGLE_APPLICATION_CREDENTIALS=/path/to/keyfile.json
export GOOGLE_CLOUD_PROJECT=gcloud_project

Apply the migrations

Please run:

$ python3 manage.py migrate

That'll take a while to run. After this you should be able to see the tables and indexes created in your Cloud Spanner console.

Create a Django admin user

First you’ll need to create a user who can login to the admin site. Run the following command:

$ python3 manage.py createsuperuser

which will then produce a prompt which will allow you to create your super user

Username: admin
Email address: admin@example.com
Password: **********
Password (again): **********
Superuser created successfully.

Login as admin

Now, run the server

python3 manage.py runserver

Then visit http://127.0.0.1:8000/admin/

Create and register your first model

Please follow the guides in https://docs.djangoproject.com/en/2.2/intro/tutorial02/#creating-models to create and register the model to the Django’s automatically-generated admin site.

How it works

Overall design

"Overall Design"

Internals

"Internals"

Executing a query

Here is an example of how to add a row for Model Author, save it and later query it using Django

>>> author_kent = Author( first_name="Arthur", last_name="Kent", rating=Decimal("4.1"),)
>>> author_kent.save()
>>> qs1 = Author.objects.all().values("first_name", "last_name")

How to contribute

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information on how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See the Code of Conduct for more information.

Limitations

Spanner has certain limitations of its own. The full set of limitations is documented here. It is recommended that you go through that list.

Django spanner has a set of limitations as well, which you can find here.

Features from spanner that are not supported in Django-spanner are listed here.

About

Cloud Spanner database backend for Django

Resources

Readme

License

BSD-3-Clause license

Code of conduct

Code of conduct

Security policy

Security policy
Activity
Custom properties

Stars

92 stars

Watchers

66 watching

Forks

31 forks
Report repository

Releases 14

v4.0.2 Latest
Jun 10, 2025
+ 13 releases

Packages

No packages published

Contributors 28
+ 14 contributors

Languages

0