Repository files navigation

Connector to use CrateDB as a database in Django ORM.

uv

uv add cratedb-django

pipx

pipx install cratedb-django

Once the library is installed, use it in yoursettings.py, e.g.

DATABASES= {"default": {"ENGINE":"cratedb_django","SERVERS": ["localhost:4200"],    }}

After that, for a model to be used in CrateDB, you need to useCrateModel as a base class.

fromdjango.dbimportmodelsfromcratedb_django.modelsimportCrateModelclassMetrics(CrateModel):id=models.TextField(primary_key=True,db_default=UUID())value=models.IntegerField()

Django migrations can be run in CrateDB, default django migrations are tested.In spite of that, we recommend that you run anything transactional in a transactional database,like PostgresSQL and use CrateDB as your analytical database.

• unique=True. CrateDB only supports unique constraints on primary keys, any model field with unique=truewill emit a warning to stdout.

This project is open-source under a MIT license.