Skip to content

lnxpy/django-psdb-engine

Repository files navigation

django-psdb-engine

PyPI - Python Version PyPI - Downloads Made for - PlanetScale pre-commit.ci status

This package helps you interact with your PlanetScale databases in your Django projects in an easier way.

Usage

Install the package by running the following command.

pip install django-psdb-engine

And finally, update your DATABASES configuration and change the ENGINE field.

DATABASES = {
    'default': {
      'ENGINE': 'django_psdb_engine',
      ...,
      'OPTIONS': {'ssl': {'ca': ...}}
    }
}

Note: Since Django uses the UTF-8 charset and it points to utf8mb3 in MySQL and this charset is deprecated in MySQL 8, you may need to add {"charset": "utf8mb4"} and migrate your changes with no problem.

- 'OPTIONS': {'ssl': {'ca': ...}}
+ 'OPTIONS': {'ssl': {'ca': ...}, 'charset': 'utf8mb4'}

Requirements

  • django >= 2.2
  • mysqlclient >= 2.1.0

License

Free software: MIT license