Create Account

LLM-friendly URL
POST
https://api.luzmo.com/0.1.0/account
API call form
Examples
List of examples
  • Create a plugin connection
  • Athena connection creation.
  • BigQuery connection creation.
  • Clickhouse connection creation.
  • Databricks connection creation.
  • ElasticSearch connection creation.
  • MariaDB connection creation.
  • MongoDB connection creation.
  • MySQL connection creation.
  • Oracle connection creation.
  • PostgreSQL connection creation.
  • Presto connection creation.
  • Redshift connection creation.
  • SAP Hana connection creation.
  • Snowflake connection creation with key-pair authentication.
  • Snowflake connection creation with username-password authentication.
  • SQL Server connection creation.
  • Azure Synapse connection creation.
  • Trino connection creation.
Description

This will create a connection to a Clickhouse database. You'll need to provide a host, key and token:

  • host: this is the host where your Clickhouse database is exposed. Note that only https is allowed here in order to securely transfer data over the wire. The structure of the host url expects: https://url-to-clickhouse-db:port/database By default, the plugin will connect to the 'default' database and the 443 port. By providing a database after the '/' you can configure which database to connect to.

  • key: the username that will be used to connect to your ClickHouse cluster.

  • token: the password to connect to your ClickHouse cluster

Notes :

  1. The Clickhouse connector uses the HTTP API interface (typically running on port 8123) to connect.

  2. If you use tables with the Distributed table engine some Luzmo-charts might fail when distributed_product_mode is deny . This should only occur, however, if you link the table to another table and use that link in a chart. In that case make sure to set the distributed_product_mode to another option that makes sense for you within your Clickhouse cluster. If you are using Clickhouse Cloud you can safely ignore this setting.

  3. To ensure that e.g. only the Luzmo application can access your Clickhouse instance, it is highly recommended to whitelist Luzmo's range of static IP addresses. You should whitelist Luzmo's range of IP addresses as described here .

Install
npm install @luzmo/nodejs-sdk
Example Request
Shell Node Java .NET Python PHP 
import Luzmo from '@luzmo/nodejs-sdk';
const client = new Luzmo({
  api_key: '<your Luzmo API key>',
  api_token: '<your Luzmo API token>',
  host: 'https://api.luzmo.com'
});


const response = await client.create('account',
  {
    provider: "clickhouse",
    name: "Clickhouse connection",
    properties: {
      host: "https://url-to-clickhouse-db:port/database",
      key: "username",
      token: "password"
    }
  }
);
Open in API Form
Example Response
200
400
500
{
  "properties": {
    "key": "play",
    "host": "https://play.clickhouse.com:443/"
  },
  "id": "737770df-6292-49b1-aa8d-239d10f78a35",
  "provider": "clickhouse",
  "date": "2024-08-01T16:48:10.866Z",
  "identifier": null,
  "expiry": null,
  "scope": null,
  "host": null,
  "name": "Clickhouse connection",
  "description": null,
  "port": null,
  "active": true,
  "invalid": false,
  "cache": 0,
  "synced": false,
  "version": null,
  "datasets_meta_sync_interval": 1,
  "datasets_meta_sync_enabled": true,
  "created_at": "2024-08-01T16:48:10.866Z",
  "updated_at": "2024-08-01T16:48:10.903Z",
  "user_id": "e64a9830-0dad-4b11-a6d4-23972c124020",
  "plugin_id": "182b7059-0ad3-42dc-9a0d-4ea716e4f92a",
  "shareable_id": "c82684f3-09aa-4b05-a82f-c1ac9d83662a"
}