Skip to main content

Django Cassandra Engine - the Cassandra backend for Django

Project description

Django Cassandra Engine - the Cassandra backend for Django

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

Latest version CI

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

Sponsors

Help support ongoing development and maintenance by sponsoring Django Cassandra Engine.

Our Sponsors:

Astra DB
Astra DB

Use Django with DataStax Astra DB - built on Apache Cassandra.

Installation

Recommended installation:

pip install django-cassandra-engine

Basic Usage

  1. Add django_cassandra_engine to INSTALLED_APPS in your settings.py file:

     INSTALLED_APPS = ('django_cassandra_engine',) + INSTALLED_APPS
    
  2. 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
                 }
             }
         }
     }
    
  3. 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)
    
  4. Run ./manage.py sync_cassandra

  5. 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': 'db_name',
            'TEST_NAME': 'db_name',
            'USER': username,
            'PASSWORD': password,
            'OPTIONS': {
                'connection': {
                    'cloud': {
                        'secure_connect_bundle': '/path/to/secure/bundle.zip'
                    },
                }
            }
        }
    }

Documentation

The documentation can be found online here.

License

Copyright (c) 2014-2021, Rafał Furmański.

All rights reserved. Licensed under BSD 2-Clause License.

Project details


Download files

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

Files for django-cassandra-engine, version 1.6.3
Filename, size File type Python version Upload date Hashes
Filename, size django-cassandra-engine-1.6.3.tar.gz (31.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page