roq-clickhouse#

Links#

Purpose#

Monitor event-logs streamed to a filesystem
Upload history to a Clickhouse timeseries database.

Conda#

Using Conda

Install

$ mamba install \
  --channel https://roq-trading.com/conda/stable \
  roq-clickhouse

Run

$ roq-clickhouse \
      --name "clickhouse" \
      --service_listen_address "$TCP_LISTEN_PORT" \
      --event_log_dir "$EVENT_LOG_DIR" \
      --flagfile "$FLAG_FILE"

Flags#

Using Flags

CLI

$ roq-clickhouse --help

Event-logs

`--event_log_dir`	One or more event-log directories
`--event_log_exclude`	One or more exclude regex patterns
`--event_log_include`	One or more include regex patterns

ClickHouse

`--uri`	ClickHouse URI, e.g. tcp://localhost:8123
`--username`	Username (optional)
`--password`	Password (optional)
`--retention_policy_time_to_live_days`	Time-to-live (in days) (optional)

Tools

--print_ddl

Print the basic DDL script (useful for manually creating a database).

Environments#

localhost

# flagfile

--uri=http://localhost:8123
--database_name=roq
--create_database=True
--retention_policy_time_to_live_days=2