Metadata-Version: 2.1
Name: django-cockroachdb
Version: 3.0.2
Summary: Django backend for CockroachDB
Home-page: https://github.com/cockroachdb/django-cockroachdb
Maintainer: Cockroach Labs
Maintainer-email: python@cockroachlabs.com
License: UNKNOWN
Project-URL: Source, https://github.com/cockroachdb/django-cockroachdb
Project-URL: Tracker, https://github.com/cockroachdb/django-cockroachdb/issues
Description: # CockroachDB backend for Django
        
        ## Prerequisites
        
        You must install either:
        
        * [psycopg2](https://pypi.org/project/psycopg2/), which has some
          [prerequisites](https://www.psycopg.org/docs/install.html#prerequisites) of
          its own.
        
        * [psycopg2-binary](https://pypi.org/project/psycopg2-binary/)
        
        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.0.x:
        
        `pip install django-cockroachdb==3.0.*`
        
        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:
        
        ```python
        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
        
        1. `CharField`'s `max_length` is ignored. It uses the same storage as
           `TextField` so `CharField` is introspected by `inspectdb` as `TextField`.
        
        2. `IntegerField` uses the same storage as `BigIntegerField` so `IntegerField`
           is introspected by `inspectdb` as `BigIntegerField`.
        
        3. `AutoField` and `BigAutoField` are both stored as
           [integer](https://www.cockroachlabs.com/docs/stable/int.html) (64-bit) with
           [`DEFAULT unique_rowid()`](https://www.cockroachlabs.com/docs/stable/functions-and-operators.html#id-generation-functions).
        
        ## Notes on Django QuerySets
        
        1. [`QuerySet.explain()`](https://docs.djangoproject.com/en/stable/ref/models/querysets/#explain)
           accepts `verbose`, `types`, `opt`, `vec`, and `distsql` options which
           correspond to [CockroachDB's parameters](https://www.cockroachlabs.com/docs/stable/explain.html#parameters).
           For example:
        
            ```python
            >>> 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](https://www.cockroachlabs.com/docs/stable/create-database.html).
        You can use `cockroach sql --insecure` on the command line to get a SQL prompt.
        
        ## Known issues and limitations (as of CockroachDB 20.1.4)
        
        1. CockroachDB [can't disable constraint checking](https://github.com/cockroachdb/cockroach/issues/19444),
           which means certain things in Django like forward references in fixtures
           aren't supported.
        
        2. Migrations have some limitations. CockroachDB doesn't support:
        
           1. [changing column type](https://github.com/cockroachdb/cockroach/issues/9851)
           2. dropping or changing a table's primary key
        
        3. Known Bugs:
           1. [Timezones after 2038 use incorrect DST settings](https://github.com/cockroachdb/django-cockroachdb/issues/124).
        
        4. Unsupported queries:
           1. [Mixed type addition in SELECT](https://github.com/cockroachdb/django-cockroachdb/issues/19):
              `unsupported binary operator: <int> + <float>`
           2. [UPDATE float column with integer column](https://github.com/cockroachdb/django-cockroachdb/issues/20):
              `value type int doesn't match type FLOAT8 of column <name>`
           3. [Division that yields a different type](https://github.com/cockroachdb/django-cockroachdb/issues/21):
              `unsupported binary operator: <int> / <int> (desired <int>)`
           4. [The power() database function doesn't accept negative exponents](https://github.com/cockroachdb/django-cockroachdb/issues/22):
              `power(): integer out of range`
           5. The `StdDev` and `Variance` aggregates
              [aren't supported](https://github.com/cockroachdb/django-cockroachdb/issues/25).
           6. [sum() doesn't support arguments of different types](https://github.com/cockroachdb/django-cockroachdb/issues/73):
              `sum(): unsupported binary operator: <float> + <int>`
           7. [greatest() doesn't support arguments of different types](https://github.com/cockroachdb/django-cockroachdb/issues/74):
              `greatest(): expected <arg> to be of type <type>, found type <other type>`
           8. [`SmallAutoField` generates values that are too large for any corresponding foreign keys](https://github.com/cockroachdb/django-cockroachdb/issues/84).
           9. [The `SHA224` and `SHA384` database functions aren't supported](https://github.com/cockroachdb/django-cockroachdb/issues/81).
        
        ## Additional issues and limitations in CockroachDB 19.2.x (as of 19.2.9)
        
        1. Savepoints aren't supported. This means a few things:
           1. Django's [transaction.atomic()](https://docs.djangoproject.com/en/stable/topics/db/transactions/#django.db.transaction.atomic)
              can't be nested.
           2. Django's `TestCase` works like `TransactionTestCase`. That is,
              transactions aren't used to speed up the former.
        
        2. Known Bugs:
           1. [The extract() function doesn't respect the time zone.](https://github.com/cockroachdb/django-cockroachdb/issues/47)
           2. [Interval math across daylight saving time is incorrect.](https://github.com/cockroachdb/django-cockroachdb/issues/54)
           3. [`date_trunc('week', <value>)` truncates to midnight Sunday rather than Monday](https://github.com/cockroachdb/django-cockroachdb/issues/92)
           4. [date_trunc() results are incorrectly localized.](https://github.com/cockroachdb/django-cockroachdb/issues/32)
           5. [cast() timestamptz to time doesn't respect the time zone.](https://github.com/cockroachdb/django-cockroachdb/issues/37)
           6. [Interval math may be incorrect on date columns.](https://github.com/cockroachdb/django-cockroachdb/issues/53)
        
        3. Unsupported queries:
           1. [extract() doesn't support interval columns (DurationField)](https://github.com/cockroachdb/django-cockroachdb/issues/29):
              `unknown signature: extract(string, interval)`
           2. [The log() function doesn't support custom bases](https://github.com/cockroachdb/django-cockroachdb/issues/50):
              `unknown signature: extract(string, interval)`
           3. [timezone() doesn't support UTC offsets](https://github.com/cockroachdb/django-cockroachdb/issues/97):
              `timezone(): unknown time zone UTC...`
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
