Django Meets Cloudflare D1: Integration and Setup

Django Meets Cloudflare D1: Integration and Setup

Integrating a reliable database with your Django application just got easier with Cloudflare D1. In this guide, we’ll walk you through the steps to connect your Django app to Cloudflare’s managed SQL database. By the end, you’ll have a robust and scalable backend ready to go.

Table of Contents

  1. Creating a new Django project
  2. Creating a D1 database
  3. Creating a Cloudflare API token
  4. Updating the project settings
  5. Final Result

1. Creating a new Django project

First, install dependencies with the following commands.

pip install django django-d1db

Create a blank project using the django-admin cli

django-admin startproject mysite
cd mysite

Now running python runserver should open a local server of Django in your computer.

2. Creating a D1 database

Assuming you already have a Cloudflare account, open the Cloudflare Dash and go to the D1 section under “Workers and Pages”.

Then click “Create database” followed by “Dashboard”, on this screen put your desired database name and click “Create”.

Creating a D1 Database

After clicking the “Create” button you will be redirected to the database details page, from this page copy and save the Database ID, you will need it later on.

D1 database details

Save your Cloudflare account id, by taking the first id in your current url:

For example in my address bar this is my current url:

So the first id present in my url and the account id is 990f15881883466384bfb1553f09096a.

3. Creating a Cloudflare API token

On the top-right conner of the dashboard, click the user icon and then “My Profile”.

Then Click “API Tokens” and finally “Create Token”.

Creating a Cloudflare API Token

After this scroll down and click “Get started” on the “Create custom Token” option.

In the token name enter your django app name for better visibility and select the permission:

You can leave the other fields in their default values, scroll down and click Continue to summary.

Creating a D1 API Token

Then click “Create Token” then copy and save the new token in a safe place.

4. Updating the project settings

Open the file and scroll down until you find the DATABASES dictionary.

Update it to look like this:

    'default': {
        'ENGINE': 'django_d1',
        'CLOUDFLARE_DATABASE_ID': '<database_id>',
        'CLOUDFLARE_ACCOUNT_ID': '<account_id>',
        'CLOUDFLARE_TOKEN': '<token>',

5. Final Result

From now on every SQL query you make in your django application will be executed on a D1 database.

You can now also apply the initial migrations required by django by running this command:

python migrate

This command will take a while to run, as your queries are now running on a remote server instead of your local instance.

You can inspect the django-d1db code in the github repo.