Skip to main content

Django Cassandra Engine - the Cassandra backend for Django

Project description

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

Latest version Downloads CI Code climate

Features

  • integration with latest python-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 (NEW!)

Plans (TODO)

  • User model stored in Cassandra (auth module)

  • Admin panel for Cassandra models

  • Forms

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 cassandra.cqlengine.models import Model
    
    class ExampleModel(Model):
        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!

Documentation

The documentation can be found online here.

License

Copyright (c) 2014-2016, 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.

Source Distribution

django-cassandra-engine-0.11.1.tar.gz (14.9 kB view hashes)

Uploaded Source

Built Distribution

django_cassandra_engine-0.11.1-py2-none-any.whl (24.1 kB view hashes)

Uploaded Python 2

Supported by

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