django-clickhouse/docs/basic_information.md

Basic information

About

This project's goal is to build Yandex ClickHouse database into Django project.
It is based on infi.clickhouse-orm library.

Features

• Multiple ClickHouse database configuration in settings.py
• ORM to create and manage ClickHouse models.
• ClickHouse migration system.
• Scalable serialization of django model instances to ORM model instances.
• Effective periodical synchronization of django models to ClickHouse without loosing data.
• Synchronization process monitoring.

Requirements

• Python 3
• Django 1.7+
• Yandex ClickHouse
• infi.clickhouse-orm
• pytz
• six
• typing
• psycopg2
• celery
• statsd

Optional libraries

• redis-py for RedisStorage
• django-pg-returning for optimizing registering updates in PostgreSQL
• django-pg-bulk-update for performing effective bulk update and create operations in PostgreSQL

Installation

Install via pip:
pip install django-clickhouse (not released yet)
or via setup.py:
python setup.py install