-
Notifications
You must be signed in to change notification settings - Fork 283
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 #1543 from ClickHouse/quicksight-connection
Quicksight connection docs
- Loading branch information
Showing
19 changed files
with
183 additions
and
109 deletions.
There are no files selected for viewing
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,11 @@ | ||
| 1. After creating your ClickHouse Cloud Service, on the credentials screen, select the MySQL tab | ||
|  | ||
| 2. Toggle the switch to enable the MySQL interface for this specific service. This will expose port `3306` for this service and prompt you with your MySQL connection screen that include your unique MySQL username. The password will be the same as the service's default user password. | ||
|  | ||
| Alternatively, in order to enable the MySQL interface for an existing service: | ||
| 3. Ensure your service is in `Running` state then click on the "View connection string" button for the service you want to enable the MySQL interface for | ||
|  | ||
| 4. Toggle the switch to enable the MySQL interface for this specific service. This will prompt you to enter the default password. | ||
|  | ||
| 5. After entering the password, you will get prompted the MySQL connection string for this service | ||
|  |
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,87 @@ | ||
| Please refer to [the official documentation](https://clickhouse.com/docs/en/interfaces/mysql) | ||
| on how to set up a ClickHouse server with enabled MySQL interface. | ||
|
|
||
| Aside from adding an entry to the server's `config.xml` | ||
|
|
||
| ```xml | ||
| <clickhouse> | ||
| <mysql_port>9004</mysql_port> | ||
| </clickhouse> | ||
| ``` | ||
|
|
||
| it is also _required_ to use | ||
| [Double SHA1 password encryption](https://clickhouse.com/docs/en/operations/settings/settings-users#user-namepassword) | ||
| for the user that will be using MySQL interface. | ||
|
|
||
| Generating a random password encrypted with Double SHA1 from the shell: | ||
|
|
||
| ```shell | ||
| PASSWORD=$(base64 < /dev/urandom | head -c16); echo "$PASSWORD"; echo -n "$PASSWORD" | sha1sum | tr -d '-' | xxd -r -p | sha1sum | tr -d '-' | ||
| ``` | ||
|
|
||
| The output should look like the following: | ||
|
|
||
| ``` | ||
| LZOQYnqQN4L/T6L0 | ||
| fbc958cc745a82188a51f30de69eebfc67c40ee4 | ||
| ``` | ||
|
|
||
| The first line is the generated password, and the second line is the hash we could use to configure ClickHouse. | ||
|
|
||
| Here is an example configuration for `mysql_user` that uses the generated hash: | ||
|
|
||
| `/etc/clickhouse-server/users.d/mysql_user.xml` | ||
|
|
||
| ```xml | ||
| <users> | ||
| <mysql_user> | ||
| <password_double_sha1_hex>fbc958cc745a82188a51f30de69eebfc67c40ee4</password_double_sha1_hex> | ||
| <networks> | ||
| <ip>::/0</ip> | ||
| </networks> | ||
| <profile>default</profile> | ||
| <quota>default</quota> | ||
| </mysql_user> | ||
| </users> | ||
| ``` | ||
|
|
||
| Replace `password_double_sha1_hex` entry with your own generated Double SHA1 hash. | ||
|
|
||
| Additionally, it is recommended to use `use_mysql_types_in_show_columns` | ||
| to show the native MySQL types instead of ClickHouse ones in `SHOW [FULL] COLUMNS` query results, | ||
| which allows BI tools to properly introspect the database schema when using MySQL connectors. | ||
|
|
||
| For example: | ||
|
|
||
| `/etc/clickhouse-server/users.d/mysql_user.xml` | ||
|
|
||
| ```xml | ||
| <profiles> | ||
| <default> | ||
| <use_mysql_types_in_show_columns>1</use_mysql_types_in_show_columns> | ||
| </default> | ||
| </profiles> | ||
| ``` | ||
|
|
||
| or assign it to a different profile instead of the default one. | ||
|
|
||
| If you have the `mysql` binary available, you can test the connection from the commandline. | ||
| Using the sample username (`mysql_user`) and password (`LZOQYnqQN4L/T6L0`) from above the command line would be: | ||
|
|
||
| ```bash | ||
| mysql --protocol tcp -h localhost -u mysql_user -P 9004 --password=LZOQYnqQN4L/T6L0 | ||
| ``` | ||
|
|
||
| ``` | ||
| mysql> show databases; | ||
| +--------------------+ | ||
| | name | | ||
| +--------------------+ | ||
| | INFORMATION_SCHEMA | | ||
| | default | | ||
| | information_schema | | ||
| | system | | ||
| +--------------------+ | ||
| 4 rows in set (0.00 sec) | ||
| Read 4 rows, 603.00 B in 0.00156 sec., 2564 rows/sec., 377.48 KiB/sec. | ||
| ``` |
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
59 changes: 59 additions & 0 deletions
59
docs/en/integrations/data-visualization/quicksight-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,59 @@ | ||
| --- | ||
| sidebar_label: QuickSight | ||
| slug: /en/integrations/quicksight | ||
| keywords: [clickhouse, aws, amazon, quicksight, connect, integrate, ui] | ||
| description: Amazon QuickSight powers data-driven organizations with unified business intelligence (BI) at hyperscale. | ||
| --- | ||
|
|
||
| import MySQLCloudSetup from '@site/docs/en/_snippets/_clickhouse_mysql_cloud_setup.mdx'; | ||
| import MySQLOnPremiseSetup from '@site/docs/en/_snippets/_clickhouse_mysql_on_premise_setup.mdx'; | ||
|
|
||
| # QuickSight | ||
|
|
||
| QuickSight can connect to ClickHouse Cloud or on-premise ClickHouse setup via MySQL interface using the official MySQL data source. | ||
|
|
||
| ## ClickHouse Cloud Setup | ||
| <MySQLCloudSetup /> | ||
|
|
||
| ## On-premise ClickHouse Server Setup | ||
| <MySQLOnPremiseSetup /> | ||
|
|
||
| ## Connecting QuickSight to ClickHouse | ||
|
|
||
| First of all, go to https://quicksight.aws.amazon.com, navigate to Datasets and click "New dataset": | ||
|
|
||
| <img src={require('./images/quicksight_01.png').default} class="image" alt="Creating a new dataset" style={{width: '75%', 'background-color': 'transparent'}}/> | ||
| <br/> | ||
|
|
||
| Search for the official MySQL connector bundled with QuickSight (named just **MySQL**): | ||
|
|
||
| <img src={require('./images/quicksight_02.png').default} class="image" alt="MySQL connector search" style={{width: '75%', 'background-color': 'transparent'}}/> | ||
| <br/> | ||
|
|
||
| Specify your connection details. Please note that MySQL interface port is 9004 by default, | ||
| and it might be different depending on your server configuration. | ||
|
|
||
| <img src={require('./images/quicksight_03.png').default} class="image" alt="Specifying the connection details" style={{width: '75%', 'background-color': 'transparent'}}/> | ||
| <br/> | ||
|
|
||
| Now, you have two options on how to fetch the data from ClickHouse. First, you could select a table from the list: | ||
|
|
||
| <img src={require('./images/quicksight_04.png').default} class="image" alt="Selecting a table from the list" style={{width: '75%', 'background-color': 'transparent'}}/> | ||
| <br/> | ||
|
|
||
| Alternatively, you could specify a custom SQL to fetch your data: | ||
|
|
||
| <img src={require('./images/quicksight_05.png').default} class="image" alt="Using custom SQL to fetch the data" style={{width: '75%', 'background-color': 'transparent'}}/> | ||
| <br/> | ||
|
|
||
| By clicking "Edit/Preview data", you should be able to see the introspected table structure or adjust your custom SQL, if that's how you decided to access the data: | ||
|
|
||
| <img src={require('./images/quicksight_06.png').default} class="image" alt="Viewing the introspected table structure" style={{width: '75%', 'background-color': 'transparent'}}/> | ||
| <br/> | ||
|
|
||
| Now you can proceed with publishing your dataset and creating a new visualization! | ||
|
|
||
| ## Known limitations | ||
|
|
||
| - Median aggregation does not work. See [#53066](https://github.com/ClickHouse/ClickHouse/issues/53066) for more details. | ||
| - String types might not be recognized properly when `use_mysql_types_in_show_columns` setting is enabled. See [#52777](https://github.com/ClickHouse/ClickHouse/issues/52777) for more details. |
Oops, something went wrong.