Docs fixes

This commit is contained in:
M1ha-Shvn 2021-03-15 13:25:11 +05:00
parent 4f7289ce9a
commit bfb51e9336

View File

@ -4,7 +4,8 @@ At the begging I expect, that you already have:
1. [ClickHouse](https://clickhouse.tech/docs/en/) (with [ZooKeeper](https://zookeeper.apache.org/), if you use replication) 1. [ClickHouse](https://clickhouse.tech/docs/en/) (with [ZooKeeper](https://zookeeper.apache.org/), if you use replication)
2. Relational database used with [Django](https://www.djangoproject.com/). For instance, [PostgreSQL](https://www.postgresql.org/) 2. Relational database used with [Django](https://www.djangoproject.com/). For instance, [PostgreSQL](https://www.postgresql.org/)
3. [Django database set up](https://docs.djangoproject.com/en/3.0/ref/databases/) 3. [Django database set up](https://docs.djangoproject.com/en/3.0/ref/databases/)
4. [Intermediate storage](storages.md) set up. For instance, [Redis](https://redis.io/). 4. [Intermediate storage](storages.md) set up. For instance, [Redis](https://redis.io/)
5. [Celery set up](https://docs.celeryproject.org/en/stable/django/first-steps-with-django.html) in order to sync data automatically.
## Configuration ## Configuration
Add required parameters to [Django settings.py](https://docs.djangoproject.com/en/3.0/topics/settings/): Add required parameters to [Django settings.py](https://docs.djangoproject.com/en/3.0/topics/settings/):
@ -20,8 +21,13 @@ Add required parameters to [Django settings.py](https://docs.djangoproject.com/e
You can also change other [configuration parameters](configuration.md) depending on your project. You can also change other [configuration parameters](configuration.md) depending on your project.
#### Example #### Example
* if you already have a celery workflow:
```python ```python
INSTALLED_APPS = (
# Your apps may go here
'django_clickhouse',
# Your apps may go here
)
# django-clickhouse library setup # django-clickhouse library setup
CLICKHOUSE_DATABASES = { CLICKHOUSE_DATABASES = {
# Connection name to refer in using(...) method # Connection name to refer in using(...) method
@ -50,43 +56,6 @@ You can also change other [configuration parameters](configuration.md) depending
} }
} }
``` ```
* if you don't have a celery workflow:
create a `celery.py` file in `mysite/mysite/celery.py`:
```python
import os
from datetime import timedelta
from celery import Celery
# set the default Django settings module for the 'celery' program.
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")
app = Celery("podafarini")
# Using a string here means the worker doesn't have to serialize
# the configuration object to child processes.
# - namespace='CELERY' means all celery-related configuration keys
# should have a `CELERY_` prefix.
app.config_from_object("django.conf:settings", namespace="CELERY")
# Load task modules from all registered Django app configs.
app.autodiscover_tasks()
app.conf.beat_schedule = {
"clickhouse_auto_sync": {
"task": "django_clickhouse.tasks.clickhouse_auto_sync",
"schedule": timedelta(seconds=2), # Every 2 seconds
"options": {"expires": 1, "queue": "clickhouse"},
}
}
```
`mysite/mysite/__init__.py`:
```python
# This will make sure the app is always imported when
# Django starts so that shared_task will use this app.
from .celery import app as celery_app
__all__ = ("celery_app",)
```
## Adopting django model ## Adopting django model
Read [ClickHouseSyncModel](models.md#djangomodel) section. Read [ClickHouseSyncModel](models.md#djangomodel) section.
@ -115,8 +84,10 @@ from my_app.models import User
class ClickHouseUser(ClickHouseModel): class ClickHouseUser(ClickHouseModel):
django_model = User django_model = User
# Uncomment the line below if you want your models to sync between databases
# need_sync = True # Uncomment the line below if you want your models to be synced automatically
# sync_enabled = True
id = fields.UInt32Field() id = fields.UInt32Field()
first_name = fields.StringField() first_name = fields.StringField()
birthday = fields.DateField() birthday = fields.DateField()