Looking for more information about how to use CockroachDB with Django? Check out this step-by-step tutorial to learn more.<\/b>
\nThis tutorial is intended to be a quick ramp-up on CockroachDB with Django. In case you’re searching for a proper Django tutorial, this is not it. At the time of writing, django-cockroachdb library is available in two versions, (2 and 3). This tutorial will cover version 3, and is inspired by the Digital Ocean tutorial using Django with PostgreSQL. I am going to highlight the steps where this tutorial differs from the original. For everything else, we will assume the tutorial is followed as is. I originally wrote this post two years ago and had since updated it as CockroachDB RBAC is no longer an enterprise-only feature so we can skip that step. I’m also including steps to launch a Docker instance to make this more portable and comprehensive. I am going to run a Docker container with Ubuntu and expose port 8080 for the DB Console, port 26257 for the SQL shell, and port 8000 for my Django application. I will install CockroachDB and run the Django app inside the container. In a terminal, execute the following command to launch this container: docker run -d -p 8080:8080 -p 26257:26257 -p 8000:8000 —name django -i -t ubuntu \/bin\/bash Then execute the following command to connect to the interactive shell inside this container: docker exec -it django bash The first thing we want to do is install some necessary dependencies. apt-get update && apt-get install python3-pip python3-dev libpq-dev vim curl wget virtualenv -y Then follow these instructions to install CockroachDB. Once installed, we can launch a single node cluster. cockroach start-single-node —insecure —background You should be able to access the DB Console on your host at http:\/\/localhost:8080. cockroach sql —insecure Create a database for the project: CREATE DATABASE myproject; Set the desired database as default: SET DATABASE = myproject; Since we\u2019re using CRDB in insecure mode, the password field is empty. Create the Django project user. CREATE USER myprojectuser; Create a role for our Django app. CREATE ROLE django; Verify role is created. Grant privileges to the Django role you created. GRANT CREATE, INSERT, UPDATE, SELECT ON DATABASE myproject TO django; Add myprojectuser to Django role. GRANT django TO myprojectuser; Now you can verify access to CRDB using newly created user. >\\q cockroach sql —insecure —database=myproject —user=myprojectuser Now we\u2019re ready to install django and cockroachdb library. pip3 install django psycopg2 django-cockroachdb We are ready to create a Django project. django-admin startproject myproject. Here, you will populate CRDB properties instead of PostgreSQL. This is a sample configuration. In case you want something more secure, the pypi page for the django_cockroachdb adapter has samples for SSL. Also, check out my own docker compose repo in case you want a sample that works with Kerberos authentication. python3 manage.py makemigrations python3 manage.py migrate At this point you should see some new Django databases created in the cluster. python3 manage.py createsuperuser python3 manage.py runserver 0.0.0.0:8000 Navigate to http:\/\/localhost:8000\/ on your host. This concludes the tutorial. You can stop the container and remove it by issuing the following commands: docker kill django docker container rm django We’ve come a long way since 2019 and a lot of things are much simpler now. We no longer need an enterprise license to take advantage of SQL roles and we are much better suited working with third party libraries like Django.<\/p>\n