Skip to main content

Django backend for TiDB

Project description

TiDB dialect for Django


This adds compatibility for TiDB to Django.


pip install git+


Set 'ENGINE': 'django_tidb' in your settings to this:

    'default': {
        'ENGINE': 'django_tidb',
        'NAME': 'django',
        'USER': 'root',
        'PASSWORD': '',
        'HOST': '',
        'PORT': 4000,
DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
USE_TZ = False
SECRET_KEY = 'django_tests_secret_key'

Supported versions

  • TiDB 4.0 and newer
  • Django 3.x and 4.0
  • Python 3.6 and newer(must match Django's Python version requirement)


create your virtualenv with:

$ virtualenv venv
$ source venv/bin/activate

you can use the command deactivate to exit from the virtual environment.

run all integration tests.

$ DJANGO_VERSION=3.2.12 python

Migrate from previous versions

Releases on PyPi before 3.0.0 are published from repository This repository is new implementation and released under versions from 3.0.0. No backwards compatibility is ensured. The most significant points are:

  • Only Django 3.x and 4.0 are tested and supported.
  • Engine name is django_tidb instead of django_tidb.tidb.

Known issues

  • TiDB does not support FOREIGN KEY constraints(#18209).
  • TiDB does not support SAVEPOINT(#6840).

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-tidb-3.0.0.tar.gz (17.2 kB view hashes)

Uploaded Source

Built Distribution

django_tidb-3.0.0-py3-none-any.whl (20.0 kB view hashes)

Uploaded Python 3

Supported by

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