Django Cassandra Engine

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for r4fek from gravatar.com r4fek

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License, Other/Proprietary License (2-clause BSD)
  • Author: Rafał Furmański
  • Tags django, cassandra, engine, backend, driver, wrapper, database, nonrel, cqlengine
  • Requires: Python >=3.8, <4.0
Classifiers

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 workflow

Discord: https://discord.gg/pxunMGmDNc

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.		 NoiSek
NoiSek

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': '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

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

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page