-
Notifications
You must be signed in to change notification settings - Fork 300
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2509 from eugeneoshepkov/feat/embeddable-docs
Add Embeddable integration docs
- Loading branch information
Showing
2 changed files
with
149 additions
and
81 deletions.
There are no files selected for viewing
67 changes: 67 additions & 0 deletions
67
docs/en/integrations/data-visualization/embeddable-and-clickhouse.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| --- | ||
| sidebar_label: Embeddable | ||
| slug: /en/integrations/embeddable | ||
| keywords: [clickhouse, embeddable, connect, integrate, ui] | ||
| description: Embeddable is a developer toolkit for building fast, interactive, fully-custom analytics experiences directly into your app. | ||
| --- | ||
|
|
||
| import ConnectionDetails from '@site/docs/en/_snippets/_gather_your_details_http.mdx'; | ||
|
|
||
| # Connecting Embeddable to ClickHouse | ||
|
|
||
| In [Embeddable](https://embeddable.com/) you define [Data Models](https://trevorio.notion.site/Data-modeling-35637bbbc01046a1bc47715456bfa1d8) and [Components](https://trevorio.notion.site/Using-components-761f52ac2d0743b488371088a1024e49) in code (stored in your own code repository) and use our **SDK** to make these available for your team in the powerful Embeddable **no-code builder.** | ||
|
|
||
| The end result is the ability to deliver fast, interactive customer-facing analytics directly in your product; designed by your product team; built by your engineering team; maintained by your customer-facing and data teams. Exactly the way it should be. | ||
|
|
||
| Built-in row-level security means that every user only ever sees exactly the data they’re allowed to see. And two levels of fully-configurable caching mean you can deliver fast, realtime analytics at scale. | ||
|
|
||
|
|
||
| ## 1. Gather your connection details | ||
| <ConnectionDetails /> | ||
|
|
||
| ## 2. Create a ClickHouse connection type | ||
|
|
||
| You add a database connection using Embeddable API. This connection is used to connect to your ClickHouse service. You can add a connection using the following API call: | ||
|
|
||
| ```javascript | ||
| // for security reasons, this must *never* be called from your client-side | ||
| fetch('https://api.embeddable.com/api/v1/connections', { | ||
| method: 'POST', | ||
| headers: { | ||
| 'Content-Type': 'application/json', | ||
| Accept: 'application/json', | ||
| Authorization: `Bearer ${apiKey}` /* keep your API Key secure */, | ||
| }, | ||
| body: JSON.stringify({ | ||
| name: 'my-clickhouse-db', | ||
| type: 'clickhouse', | ||
| credentials: { | ||
| host: 'my.clickhouse.host', | ||
| user: 'clickhouse_user', | ||
| port: 8443, | ||
| password: '*****', | ||
| }, | ||
| }), | ||
| }); | ||
|
|
||
|
|
||
| Response: | ||
| Status 201 { errorMessage: null } | ||
| ``` | ||
|
|
||
| The above represents a `CREATE` action, but all `CRUD` operations are available. | ||
|
|
||
| The `apiKey` can be found by clicking “**Publish**” on one of your Embeddable dashboards. | ||
|
|
||
| The `name` is a unique name to identify this connection. | ||
| - By default your data models will look for a connection called “default”, but you can supply your models with different `data_source` names to support connecting different data models to different connections (simply specify the data_source name in the model) | ||
|
|
||
| The `type` tells Embeddable which driver to use | ||
|
|
||
| - Here you'll want to use `clickhouse`, but you can connect multiple different datasources to one Embeddable workspace so you may use others such as: `postgres`, `bigquery`, `mongodb`, etc. | ||
|
|
||
| The `credentials` is a javascript object containing the necessary credentials expected by the driver | ||
| - These are securely encrypted and only used to retrieve exactly the data you have described in your data models. | ||
| Embeddable strongly encourage you to create a read-only database user for each connection (Embeddable will only ever read from your database, not write). | ||
|
|
||
| In order to support connecting to different databases for prod, qa, test, etc (or to support different databases for different customers) you can assign each connection to an environment (see [Environments API](https://www.notion.so/Environments-API-497169036b5148b38f7936aa75e62949?pvs=21)). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters