Aurora DSQL adapter for Django

This is the adapter for enabling development of Django applications using Aurora DSQL.

Requirements

Django

Aurora DSQL adapter for Django supports Django 4.2+ with the following versions:

• Django 4.2.x (LTS)
• Django 5.0.x
• Django 5.1.x
• Django 5.2.x (LTS)

Boto3

Aurora DSQL Django adapter needs boto3 to work. Follow the Boto3 installation guide to install Boto3

Required Python versions

aurora_dsql_django requires Python 3.9 or later.

Please see the link below for more detail to install Python:

• Python Installation

AWS credentials

Aurora DSQL Django adapter generates the IAM db auth token for every connection. DB auth token is generated using AWS credentials. You must have configured valid AWS credentials to be able to use the adapter. If not the connection to the cluster will not succeed.

Getting Started

First, install the adapter using pip:

pip install aurora_dsql_django

Define Aurora DSQL as the Engine for the Django App

Change the DATABASES variable in settings.py of your Django app. An example is show below

   DATABASES = {
        'default': {
            'HOST': '<your_cluster_id>.dsql.<region>.on.aws',
            'USER': 'admin', # or another user you have defined
            'NAME': 'postgres',
            'ENGINE': 'aurora_dsql_django',
            'OPTIONS': {
                'sslmode': 'require',
                'region': 'us-east-2',
                # (optional) Defaults to 'default' profile if nothing is set
                'aws_profile': 'user aws custom profile name' 
                # (optional) Default is 900 seconds i.e., 15 mins 
                'expires_in': <token expiry time time in seconds> 
                # (optional) If sslmode is 'verify-full' then use sslrootcert
                # variable to set the path to server root certificate
                # If no path is provided, the adapter looks into system certs
                # NOTE: Do not use it with 'sslmode': 'require'
                'sslrootcert': '<root certificate path>'
            }
        }
    }

For more info follow the Aurora DSQL with Django example

Features and Limitations

• Adapter Behavior - How the Aurora DSQL adapter for Django modifies Django behavior for Aurora DSQL compatibility
• Known Issues - Known limitations and workarounds

Development

Install uv and then:

$ git clone https://github.com/awslabs/aurora-dsql-django
$ cd aurora-dsql-django
$ uv sync --extra test --extra dev

uv will automatically install the correct Python version and manage the virtual environment.

Running Tests

You can run the unit tests with this command:

$ pytest --cov=aurora_dsql_django aurora_dsql_django/tests/unit/ --cov-report=xml

You can run the integration tests with this command:

$ export CLUSTER_ENDPOINT=<your cluster endpoint>
$ export DJANGO_SETTINGS_MODULE=aurora_dsql_django.tests.test_settings
$ pytest -v aurora_dsql_django/tests/integration/

Documentation

Sphinx is used for documentation. You can generate HTML locally with the following:

$ uv sync --extra test --extra dev
$ uv run sphinx-build docs/source build

Getting Help

Please use these community resources for getting help.

• Open a support ticket with AWS Support.
• If you think you may have found a bug, please open an issue.

Opening Issues

If you encounter a bug with the Aurora DSQL Django adapter, we would like to hear about it. Please search the existing issues and see if others are also experiencing the issue before opening a new issue. When opening a new issue please follow the template.

The GitHub issues are intended for bug reports and feature requests. For help and questions with using Aurora DSQL Django adapter, please make use of the resources listed in the Getting Help section. Keeping the list of open issues lean will help us respond in a timely manner.

License

This library is licensed under the Apache 2.0 License.