Skip to main content

Django backend for YugabyteDB

Project description

Prerequisites

  • GCC

  • Python 3.8 and above

  • Psycopg2-yugabytedb (recommended)

  • Django 3.2 or above

Need for Django Backend for YugabyteDB

YugabyteDB needs a separate backend for Django. This is because of mainly 3 reasons.

  • Django tries to create Inet data types as primary keys in Django test suites. Since this is not supported, we map Inet types to varchar(15) and varchar(39) in the YB backend.

  • We also need it to support type change from int to BigInt and numeric(m,n) to double precision. This is required for Django DB migrations. For now, the YB backend ignores these type changes.

  • The Django PostgreSQL Backend does not support the Load Balance, even when used with YugabyteDB smart driver.

Installing from Pypi

Install the django-yugabytedb package with the command:

$ pip install django-yugabytedb

Installing in Python Virtual Environment From Source

The django-yugabytedb package can also be installed from source:

$ git clone https://github.com/yugabyte/yb-django.git

$ python -m pip install -r <repo_path>/yb-django/requirements.txt

$ python -m pip install -e <repo_path>/yb-django/

Check if it is installed correctly:

$ pip list —local

Use the backend with your Application

Update the DATABASES setting in your Django project’s settings to point to YB server using Django YB backend:

DATABASES = {
    'default': {
        'ENGINE': 'django_yugabytedb',
        'NAME': 'yugabyte',
        'HOST': 'localhost',
        'PORT': 5433,
        'USER': 'yugabyte',
    }
}

To use Cluster Aware Load Balance:

DATABASES = {
    'default': {
        'ENGINE': 'django_yugabytedb',
        'NAME': 'yugabyte',
        'HOST': 'localhost',
        'PORT': 5433,
        'USER': 'yugabyte',
        'LOAD_BALANCE': 'True'
    }
}

To use Topology Aware Load Balance:

DATABASES = {
    'default': {
        'ENGINE': 'django_yugabytedb',
        'NAME': 'yugabyte',
        'HOST': 'localhost',
        'PORT': 5433,
        'USER': 'yugabyte',
        'LOAD_BALANCE': 'True',
        'TOPOLOGY_KEYS': 'cloud1.region1.zone1'
    }
}

Known bugs and issues

  • The creation of indexes in YugabyteDB is a little slow.

  • Since Inet is mapped to varchar in the backend, comparison between data in the inet column wth Inet type will fail.

  • For YugabyteDB verions earlier than 2.9, the savepoint feature is not supported.

  • Dropping of Primary keys are not supported

  • Alter table Add column Unique is not yet supported.

  • Backfilling of existing rows when new column is added with default value is not yet implemented in yugabytedb.

  • Type change from int to BigInt and numeric(m,n) to double precision is not yet supported.

  • ALTER INDEX not supported yet.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_yugabytedb-4.2.0.1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

django_yugabytedb-4.2.0.1-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file django_yugabytedb-4.2.0.1.tar.gz.

File metadata

  • Download URL: django_yugabytedb-4.2.0.1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.17

File hashes

Hashes for django_yugabytedb-4.2.0.1.tar.gz
Algorithm Hash digest
SHA256 2c03362c54b190ec935ee6d057ed39ba7db90c02b6e773698ba1d5248f8a4c94
MD5 7ca5b2e01c9f2f60d733998b12b0d4da
BLAKE2b-256 18fff93d21e5c7e5ad9618018750938b2c573c8a0e12d2ccd09e021caa725ec0

See more details on using hashes here.

File details

Details for the file django_yugabytedb-4.2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_yugabytedb-4.2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0679be0e052e2eb65edb1a7d262692eafb8dff0c59741c8102559f1efa9c0b03
MD5 3e662b932aa4b2aef73af46c1a5d370f
BLAKE2b-256 992ef4a022a82a0dce8ad3a88d28f00713e8969cead16d54f3faa82e5e18ced8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page