Django Cassandra Engine - the Cassandra backend for Django

All tools you need to start your journey with Apache Cassandra and Django Framework!

workflow

Features

integration with latest python-driver and optionally dse-driver from DataStax
working flush, migrate, sync_cassandra, inspectdb and dbshell commands
support for creating/destroying test database
accepts all Cqlengine and cassandra.cluster.Cluster connection options
automatic connection/disconnection handling
works well along with relational databases (as secondary DB)
storing sessions in Cassandra
working django forms
usable admin panel with Cassandra models
support DataStax Astra cloud hosted Cassandra

Installation

Recommended installation:

pip install django-cassandra-engine

Basic Usage

Add django_cassandra_engine to INSTALLED_APPS in your settings.py file:

 INSTALLED_APPS = ('django_cassandra_engine',) + INSTALLED_APPS

Change DATABASES setting:

 DATABASES = {
     'default': {
         'ENGINE': 'django_cassandra_engine',
         'NAME': 'db',
         'TEST_NAME': 'test_db',
         'HOST': 'db1.example.com,db2.example.com',
         'OPTIONS': {
             'replication': {
                 'strategy_class': 'SimpleStrategy',
                 'replication_factor': 1
             }
         }
     }
 }

Define some model:

 # myapp/models.py

 import uuid
 from cassandra.cqlengine import columns
 from django_cassandra_engine.models import DjangoCassandraModel

 class ExampleModel(DjangoCassandraModel):
     example_id    = columns.UUID(primary_key=True, default=uuid.uuid4)
     example_type  = columns.Integer(index=True)
     created_at    = columns.DateTime()
     description   = columns.Text(required=False)

Run ./manage.py sync_cassandra
Done!

Connect to Cassandra with a Cloud Config bundle

To connect to a hosted Cassandra cluster that provides a secure connection bundle (ex. DataStax Astra) change the DATABASES setting of your settings.py:

    DATABASES = {
        'default': {
            'ENGINE': 'django_cassandra_engine',
            'NAME': 'keyspace_name',
            'TEST_NAME': 'table_name',
            'USER': 'token',
            'PASSWORD': token_value,
            'OPTIONS': {
                'connection': {
                    'cloud': {
                        'secure_connect_bundle': '/path/to/secure/bundle.zip'
                    },
                }
            }
        }
    }

Documentation

The documentation can be found online here.

License

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_cassandra_engine-1.10.0.tar.gz (29.7 kB view details)

Uploaded Jun 11, 2025 Source

File details

Details for the file django_cassandra_engine-1.10.0.tar.gz.

File metadata

Download URL: django_cassandra_engine-1.10.0.tar.gz
Upload date: Jun 11, 2025
Size: 29.7 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/4.0.2 CPython/3.10.5

File hashes

Hashes for django_cassandra_engine-1.10.0.tar.gz
Algorithm	Hash digest
SHA256	`a633d8843e933a5cd2164e1f21fc8a960e7526684ebd6236eba9eb53eae53ef4`
MD5	`b571fca8371ba543c9b6bd6de3ccea15`
BLAKE2b-256	`22c26daf16e085658dd9c75dcfb55861ef28f5e7ec7c918cb3bce4ca766128a5`