ToolJet/docs/versioned_docs/version-2.33.0/data-sources/clickhouse.md
Akshay 2d08d889de
Release: Community changes (v2.34.0) (#9226)
* add custom resolvers info and editable row selection info (#9057)

* fix system requirements icon

* add auth info for webhooks and fix casing

* add regex custom validation info (#9068)

* [docs]: Marketplace 1.7 updates (#9085)

* [docs] Amazon redshift plugin

* make minor improvements

* add and update docs for marketplace 1.7

* update order of plugins in overview to match sidebar

* create new version

---------

Co-authored-by: Shubhendra <withshubh@gmail.com>

* add the latest version in the versions.json file (#9094)

* [docs]: Update PDF component (#9088)

* update PDF component

* merged with develop and added changes to the new version

* update docs favicon: (#9118)

* [docs] SSO revamp (#9031)

* add method to set default language

* update image settings through custom css and update screenshots for getting started and tooljet concepts (#9158)

* fix read documentation button

* fix formatting for setup icons (#9172)

* fix sidebar link for aws lambda

* Update static media (#9175)

* updated the screenshots

* reduced the gif size

* reverted the package.json file

* edited the zoomed in images and replaced some gifs with screenshots

* removed one gif

* update static media

* update file names

* update toolbar

* fix file names

* fix: dynamodb img path

* update media for org management dashboard

* fix: casing and formatting

* update workspace constant media

* update media in workspace settings and github

* update github sso

* minor change to github sso docs

* minor fix

* update google sso

* change includeCurrentVersion flag to false

---------

Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>

* Feature: Engagespot plugin (#9012)

* feat(plugins): added engagespot plugin

* feat(docs): added engagespot plugin docs

* chore(engagespot-plugin): revised copywritings

* Feature: Databricks data source (#9174)

* plugin-created

* Databricks integration

* icon, error handling

* removed unrelated changes from marketplace and frontend package-lock.json removed runAsync and maxRows timeouts pending

* timeout implementation

* socket timeout and error handling

* resolve comments

* resolve comments2

* solved render issue test connection improvements

* solved undefined error

* fix TJDB not null value fail for is operation (#9055)

* fix TJDB not null value fail for is operation

* handling not null and null case insenstive values

* Support for marketplace plugin deploy on render preview app (#9221)

* Fix for marketplace error on render preview app

* add marketplace build command

* Adding new workflow for building marketplace plugin

* removed render app creation

* [:docs] Add documentation for Databricks plugin (#9224)

* add docs for databricks

* update databricks docs

* update docs

* remove ref to clusters

* bump to v2.34.0

* Fixed data source cypress failure (#9227)

* updated spec with required text

* updated mongodb and import spec

* updated import spec

---------

Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>
Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com>
Co-authored-by: Midhun G S <gsmithun4@gmail.com>
Co-authored-by: Shubhendra <withshubh@gmail.com>
Co-authored-by: Aman Regu <amanregu@gmail.com>
Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com>
Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com>
Co-authored-by: Jobin Jose <129726530+jobin-logidots@users.noreply.github.com>
Co-authored-by: Syed Mohammad Akhtar Rizvi <85864291+ShazanRizvi@users.noreply.github.com>
Co-authored-by: blank0537 <111295371+blank0537@users.noreply.github.com>
Co-authored-by: Mekhla Asopa <59684099+Mekhla-Asopa@users.noreply.github.com>
2024-03-29 19:13:26 +05:30

4.8 KiB

id title
clickhouse ClickHouse

ClickHouse

ToolJet can connect to the ClickHouse to read and write data.

:::info ToolJet uses this NodeJS client for ClickHouse. :::

Connection

To establish a connection with the Clickhouse data source, you can either click on the +Add new data source button located on the query panel or navigate to the Data Sources page through the ToolJet dashboard.

ToolJet requires the following to connect to your ClickHouse Database:

  • Username
  • Password
  • Host
  • Port
  • Database Name
  • Protocol
  • Use Post
  • Trim Query
  • Use Gzip
  • Debug
  • Raw
ClickHouse connection

Querying ClickHouse

After setting up the ClickHouse data source, you can click on the + button of the query manager and select the ClickHouse data source that you added in the previous step to create a new query.

:::info For more details on clickhouse visit Clickhouse docs. :::

Supported Operations:

SQL Query

Use this to operation to enter ClickHouse SQL Statements. These statements represent various kinds of action you can perform using SQL queries.

Example SQL queries

  • SELECT:

    SELECT * from test array;
    
    ClickHouse SQL Statement operation
  • CREATE:

    CREATE TABLE test array3 (
    	date Date,
    	str String,
    	arr Array(String),
    	arr2 Array (Date)
    	arr3 Array(UInt32) ,
    	id1 UUID
    )ENGINE=MergeTree () ORDER BY(str)
    
    ClickHouse SQL Statement operation
  • ALTER TABLE(add column)

    ALTER TABLE test array1 ADD COLUMN Added2 UInt32;
    
    ClickHouse SQL Statement operation
  • SELECT WITH WHERE CLAUSE

    SELECT * FROM test array1 WHERE str='Somethingl...'
    
    ClickHouse SQL Statement operation
  • UPDATE

    ALTER TABLE test_array1 UPDATE arr = (12] WHERE str='Somethingl...'
    
    ClickHouse SQL Statement operation
  • DELETE

    ALTER TABLE test_array1 DELETE WHERE str= 'Somethingl...'
    
    ClickHouse SQL Statement operation
  • NORMAL INSERT

    1. Step 1 - Creating Table
    CREATE TABLE test array4 (
    name String,
    date Date
     )ENGINE=MergeTree () ORDER BY (name)
    
    ClickHouse SQL Statement operation
    1. Step 2 - Insert
    INSERT INTO test_array4 (*) VALUES ('juvane', '1996-01-13')
    
    ClickHouse SQL Statement operation

    :::info Giving Primary Key

    CREATE TABLE db.table_name
    (
    	name1 type1, name2 type2, ...,
    	PRIMARY KEY(expr1[, expr2,...])]
    )
    ENGINE = engine;
    
    OR
    
    CREATE TABLE db.table_name
    (
    	name1 type1, name2 type2, ...
    )
    ENGINE = engine
    PRIMARY KEY(expr1[, expr2,...]);
    

    :::

Insert array of objects

Use this operation for inserting array of objects.

Required Parameters:

  • Body
  • Fields
  • Table name

Example Body value:

[
  {
    date: "2018-01-01",
    str: "Something1...",
    arr: [],
    arr2: ["1985-01-02", "1985-01-03"],
    arr3: [1, 2, 3, 4, 5],
    id1: "102a05cb-8aaf-4f11-a442-20c3558e4384",
  },
  {
    date: "2018-02-01",
    str: "Something2...",
    arr: ["5670000000", "Something3..."],
    arr2: ["1985-02-02"],
    arr3: [],
    id1: "c2103985-9a1e-4f4a-b288-b292b5209de1",
  },
];
ClickHouse Insert array of objects operation