npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

target-clickhouse

v2.9.0

Published

A Singer target for Clickhouse

Downloads

159

Readme

Target Clickhouse

A Singer target for Clickhouse, for use with Singer streams generated by Singer taps, written in node js using singer-node.

Usage

Install

As npm package on host

npm install -g target-clickhouse

Docker image

docker pull ghcr.io/biron-bi/target-clickhouse

Registry page

Run

  1. Create a config file config.json with connection information and ingestion parameters.

    {
      "host": "localhost",
      "port": 8123,
      "database": "destination_database",
      "username": "user",
      "password": "averysecurepassword"
    }
  2. Run target-clickhouse against a Singer tap.

In the following exemples:

  • We echo state at the end of a 'state.jsonl' file

  • The file current_state.json contains last line of state.jsonl

  • The file config.json contains clickhouse connection informations

Npm package:

<tap-anything> --state current_state.json | target-clickhouse --config config.json >> state.jsonl

Docker:

In this exemple, container reads config file in a /config directory

<tap-anything> --state current_state.json | docker run --rm -i -a STDIN -a STDOUT -a STDERR -v "$(pwd):/config:ro" ghcr.io/biron-bi/target-clickhouse --config /config/config.json >> state.jsonl

Config.json

The fields available to be specified in the config file.

Mandatory fields

  • host
  • port
  • username
  • password
  • database

Optional fields

  • logging_level Default to "INFO"
  • subtable_separator Default to "__"
  • translate_values: Whether fields should be parsed again to allow conversion of specific values, e.g. True accepted as true. Default false
  • batch_size: Amount of records to read before sending to clickhouse. Default 100
  • finalize_concurrency: Amount of concurrent stream ingestion finalisation. Default 3
  • extra_active_tables: List of tables that are considered active even if not present in ACTIVE_STREAMS message. Default [] finalize_concurrency

Singer specification extension

Several features are supported that are not standard to the singer Spec:

  • Update schemas : Pass the repeatable CLI option --update-streams <stream> to specify streams for which you want to recreate tables (root and children).
  • Clean first : Specify clean_first: true in SCHEMA messages to wipe table content before each ingestion.
  • Cleaning column : Specify cleaning_column: "<column_name>" in SCHEMA messages to wipe table content that matches column value during ingestion. For instance, if column "date" is specified as cleaning column, and the value "2022-01-01" is encountered in a record, all rows with values "2022-01-01" are replaced with those contained in the stream
  • All key properties : Specify all_key_properties: {props: [], children: {}} in SCHEMA messages to specify primary keys for all children of a root table. This will allow children to create a foreign key to their parent (with the format _parent_<column>)

Sponsorship

Target Clickhouse is written and maintained by Biron https://birondata.com/

Acknowledgements

Special thanks to the people who built

License

Distributed under the AGPLv3