Skip to content

🛢️ Using Clickhouse as a Source in Ferry

Ferry allows you to ingest data from a Clickhouse database and move it to different destinations like data warehouses, APIs, or other databases.

📌 Prerequisites

Before using Clickhouse as a source, ensure:

  • Clickhouse is running and accessible.
  • You have a valid connection string (clickhouse://user:password@host:port/databasehttp_port=<http_port>&secure=<secure_toggle>).
  • The required table exists in your database.

source_uri Format

To connect Ferry to a Clickhouse database, use the following connection string format:

plaintext
  clickhouse://user:password@host:port/databasehttp_port=<http_port>&secure=<secure_toggle>

Parameters:

  • <user> – Clickhouse username.
  • <password> – Clickhouse password.
  • <host> – Database host (e.g., localhost or db.example.com).
  • <port> – Clickhouse port (default: 9000).
  • <database-name> – Name of the database.
  • <http_port> – HTTP Port - default is 8123
  • <secure_toggle> – HTTP is ecure or not - 0 or 1

source_table_name Format

plaintext
  public.users

Released under the MIT License.