Django backend for CockroachDB
Project description
CockroachDB backend for Django
Prerequisites
You must install either:
-
psycopg2, which has some prerequisites of its own.
The binary package is a practical choice for development and testing but in production it is advised to use the package built from sources.
Install and usage
Use the version of django-cockroachdb that corresponds to your version of Django. For example, to get the latest compatible release for Django 3.1.x:
pip install django-cockroachdb==3.1.*
The minor release number of Django doesn't correspond to the minor release number of django-cockroachdb. Use the latest minor release of each.
Configure the Django DATABASES setting similar to this:
DATABASES = {
'default': {
'ENGINE': 'django_cockroachdb',
'NAME': 'django',
'USER': 'root',
'PASSWORD': '',
'HOST': 'localhost',
'PORT': '26257',
# If connecting with SSL, remove the PASSWORD entry above and include
# the section below, replacing the file paths as appropriate.
'OPTIONS': {
'sslmode': 'require',
'sslrootcert': '/certs/ca.crt',
'sslcert': '/certs/client.myprojectuser.crt',
'sslkey': '/certs/client.myprojectuser.key',
},
},
}
Notes on Django fields
-
IntegerFielduses the same storage asBigIntegerFieldsoIntegerFieldis introspected byinspectdbasBigIntegerField. -
AutoFieldandBigAutoFieldare both stored as integer (64-bit) withDEFAULT unique_rowid().
Notes on Django QuerySets
-
QuerySet.explain()acceptsverbose,types,opt,vec, anddistsqloptions which correspond to CockroachDB's parameters. For example:>>> Choice.objects.explain(opt=True, verbose=True) 'scan polls_choice\n ├── columns: id:1 question_id:4 choice_text:2 votes:3\n ├── stats: [rows=1]\n ├── cost: 1.1\n ├── key: (1)\n ├── fd: (1)-->(2-4)\n └── prune: (1-4)'
FAQ
Why do I get the error psycopg2.errors.InvalidName: no database specified?
You may need to create the database.
You can use cockroach sql --insecure on the command line to get a SQL prompt.
Known issues and limitations (as of CockroachDB 20.1.7)
-
CockroachDB can't disable constraint checking, which means certain things in Django like forward references in fixtures aren't supported.
-
Migrations have some limitations. CockroachDB doesn't support:
- changing column type
- dropping or changing a table's primary key
-
Known Bugs:
-
Unsupported queries:
- Mixed type addition in SELECT:
unsupported binary operator: <int> + <float> - UPDATE float column with integer column:
value type int doesn't match type FLOAT8 of column <name> - Division that yields a different type:
unsupported binary operator: <int> / <int> (desired <int>) - The power() database function doesn't accept negative exponents:
power(): integer out of range - The
StdDevandVarianceaggregates aren't supported. - sum() doesn't support arguments of different types:
sum(): unsupported binary operator: <float> + <int> - greatest() doesn't support arguments of different types:
greatest(): expected <arg> to be of type <type>, found type <other type> SmallAutoFieldgenerates values that are too large for any corresponding foreign keys.- The
SHA224andSHA384database functions aren't supported.
- Mixed type addition in SELECT:
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-cockroachdb-3.1.1.tar.gz.
File metadata
- Download URL: django-cockroachdb-3.1.1.tar.gz
- Upload date:
- Size: 16.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ac0525a743a967467098ac07f55fe2a5c7a8229c76886d9740c6cd89972f0ce6 |
|
| MD5 | b358104748c738f22146b95302160ad3 |
|
| BLAKE2b-256 | cb9fd3d22b8680b60934a7b3facf0692c14dbcbc599ea0e8f0a23df43db93197 |
File details
Details for the file django_cockroachdb-3.1.1-py3-none-any.whl.
File metadata
- Download URL: django_cockroachdb-3.1.1-py3-none-any.whl
- Upload date:
- Size: 22.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.9.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 58db33a819e8a1f49fe3907611503f4da331a0fba9e8d6e73a9696190808ee81 |
|
| MD5 | f7ac24b19d315fa6638609ea96b77f52 |
|
| BLAKE2b-256 | b10d131df4c5c1219c3a94c8f255c718c317d4dcdfb46be29bfeb05fdb2945ae |
