Skip to content

Integrate with Amazon QuickSight #11616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,9 @@
- [Use Backup Resource](/tidb-cloud/terraform-use-backup-resource.md)
- [Use Restore Resource](/tidb-cloud/terraform-use-restore-resource.md)
- [Vercel](/tidb-cloud/integrate-tidbcloud-with-vercel.md)
- [Amazon AppFlow](/develop/dev-guide-aws-appflow-integration.md)
- Amazon
- [Amazon AppFlow](/develop/dev-guide-aws-appflow-integration.md)
- [Amazon QuickSight](/develop/dev-guide-aws-quicksight-integration.md)
- Reference
- TiDB Cluster Architecture
- [Overview](/tidb-architecture.md)
Expand Down
1 change: 1 addition & 0 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
- [Known Incompatibility Issues with Third-Party Tools](/develop/dev-guide-third-party-tools-compatibility.md)
- [ProxySQL Integration Guide](/develop/dev-guide-proxysql-integration.md)
- [Amazon AppFlow Integration Guide](/develop/dev-guide-aws-appflow-integration.md)
- [Amazon QuickSight Integration Guide](/develop/dev-guide-aws-quicksight-integration.md)
- Deploy
- [Software and Hardware Requirements](/hardware-and-software-requirements.md)
- [Environment Configuration Checklist](/check-before-deployment.md)
Expand Down
91 changes: 91 additions & 0 deletions develop/dev-guide-aws-quicksight-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
---
title: QuickSight Integration Guide
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: QuickSight Integration Guide
title: Integrate TiDB with Amazon QuickSight

summary: Learn how to integrate TiDB Cloud Dedicated Tier with Amazon QuickSight.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
summary: Learn how to integrate TiDB Cloud Dedicated Tier with Amazon QuickSight.
summary: Introduce how to integrate TiDB with Amazon QuickSight step by step.

---

# Integrate TiDB with Amazon QuickSight

This document provides a general introduction to Amazon QuickSight and describes how to integrate Amazon QuickSight with TiDB.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This document provides a general introduction to Amazon QuickSight and describes how to integrate Amazon QuickSight with TiDB.
This document briefly introduces Amazon QuickSight and describes how to integrate TiDB with Amazon QuickSight using a TiDB Cloud Dedicated Tier cluster as an example.


If you are interested in learning more about TiDB and Amazon QuickSight, you can find some useful links as follows:

- [TiDB Cloud](https://docs.pingcap.com/tidbcloud)
- [TiDB Developer Guide](/develop/dev-guide-overview.md)
- [Amazon QuickSight Documentation](https://docs.aws.amazon.com/quicksight/latest/user/welcome.html)

## What is Amazon QuickSight?

[Amazon QuickSight](https://aws.amazon.com/quicksight/) is a cloud-scale business intelligence (BI) service that you can use to deliver easy-to-understand insights to the people who you work with, wherever they are. Amazon QuickSight connects to your data in the cloud and combines data from many different sources. In a single data dashboard, QuickSight can include AWS data, third-party data, big data, spreadsheet data, SaaS data, B2B data, and more. As a fully managed cloud-based service, Amazon QuickSight provides enterprise-grade security, global availability, and built-in redundancy. It also provides the user-management tools that you need to scale from 10 users to 10,000, all with no infrastructure to deploy or manage.

## Why Amazon QuickSight integration?

Every day, the people in your organization make decisions that affect your business. When they have the right information at the right time, they can make the choices that move your company in the right direction.

Here are some of the benefits of using Amazon QuickSight for analytics, data visualization, and reporting:

- The in-memory engine, called SPICE, responds with blazing speed.
- No upfront costs for licenses and a low total cost of ownership (TCO).
- Collaborative analytics with no need to install an application.
- Combine a variety of data into one analysis.
- Publish and share your analysis as a dashboard.
- Control features available in a dashboard.
- No need to manage granular database permissions—dashboard viewers can see only what you share.

## Prerequisites

- [TiDB Cluster](#create-tidb-cluster)
- [Amazon QuickSight Account](https://portal.aws.amazon.com/billing/signup?client=quicksight&fid=441BE2A63D1F1F56-313F2AF2462BDF3C&redirect_url=https%3A%2F%2Fquicksight.aws.amazon.com%2Fsn%2Fconsole%2Fsignup#/start&refid=ha_awssm-evergreen-free_tier)

## Create TiDB Cluster

TiDB (/’taɪdiːbi:/, "Ti" stands for Titanium) is an open-source NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability.

<CustomContent platform="tidb">

If you don't have a TiDB cluster, you can follow the [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md) to create a TiDB cluster.

</CustomContent>

Here is the way to create a playground TiDB cluster. In this section, create a TiDB cluster using [TiDB Cloud Dedicated Tier](https://docs.pingcap.com/tidbcloud/select-cluster-tier#dedicated-tier). But you can create your TiDB cluster anywhere. Just ensure that Amazon QuickSight can connect to your TiDB cluster.

You can follow the document to [Create a TiDB Cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster), to create a TiDB Cloud Dedicated Tier cluster.
Comment on lines +36 to +51
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [TiDB Cluster](#create-tidb-cluster)
- [Amazon QuickSight Account](https://portal.aws.amazon.com/billing/signup?client=quicksight&fid=441BE2A63D1F1F56-313F2AF2462BDF3C&redirect_url=https%3A%2F%2Fquicksight.aws.amazon.com%2Fsn%2Fconsole%2Fsignup#/start&refid=ha_awssm-evergreen-free_tier)
## Create TiDB Cluster
TiDB (/’taɪdiːbi:/, "Ti" stands for Titanium) is an open-source NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It is MySQL compatible and features horizontal scalability, strong consistency, and high availability.
<CustomContent platform="tidb">
If you don't have a TiDB cluster, you can follow the [Quick Start Guide for the TiDB Database Platform](/quick-start-with-tidb.md) to create a TiDB cluster.
</CustomContent>
Here is the way to create a playground TiDB cluster. In this section, create a TiDB cluster using [TiDB Cloud Dedicated Tier](https://docs.pingcap.com/tidbcloud/select-cluster-tier#dedicated-tier). But you can create your TiDB cluster anywhere. Just ensure that Amazon QuickSight can connect to your TiDB cluster.
You can follow the document to [Create a TiDB Cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster), to create a TiDB Cloud Dedicated Tier cluster.
Before integrating Amazon QuickSight with TiDB, make sure the following requirements are met.
### An Amazon QuickSight Account
You are expected to have an account in Amazon QuickSight. If you do not have an account, you can follow the [Setting up for Amazon QuickSight](https://docs.aws.amazon.com/quicksight/latest/user/setting-up.html) to sign up.
### A TiDB cluster
<CustomContent platform="tidb">
You are expected to have a TiDB cluster. To create a TiDB cluster, you can do one of the following:
- [Create an on-premises TiDB cluster](/quick-start-with-tidb.md)
- [Create a TiDB Cloud cluster](https://docs.pingcap.com/tidbcloud/create-tidb-cluster)
</CustomContent>
<CustomContent platform="tidb-cloud">
You are expected to have an account and a cluster in TiDB Cloud. If you do not have any, refer to [Create a TiDB Cloud cluster](/tidb-cloud/create-tidb-cluster.md).
</CustomContent>
This document uses a TiDB Cloud Dedicated Tier cluster as an example. The following section applies to all TiDB clusters as long as Amazon QuickSight can connect to your TiDB cluster.


## Integrate Amazon QuickSight and TiDB

1. You need to [get an account](https://portal.aws.amazon.com/billing/signup?client=quicksight&fid=441BE2A63D1F1F56-313F2AF2462BDF3C&redirect_url=https%3A%2F%2Fquicksight.aws.amazon.com%2Fsn%2Fconsole%2Fsignup#/start&refid=ha_awssm-evergreen-free_tier) for [Amazon QuickSight](https://aws.amazon.com/quicksight). If you register successfully, you can see a page like this.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. You need to [get an account](https://portal.aws.amazon.com/billing/signup?client=quicksight&fid=441BE2A63D1F1F56-313F2AF2462BDF3C&redirect_url=https%3A%2F%2Fquicksight.aws.amazon.com%2Fsn%2Fconsole%2Fsignup#/start&refid=ha_awssm-evergreen-free_tier) for [Amazon QuickSight](https://aws.amazon.com/quicksight). If you register successfully, you can see a page like this.
1. Sign in to [Amazon QuickSight](https://quicksight.aws.amazon.com/). If you do not have an account, you can click **Sign up for QuickSight** to create an account. The following screenshot shows the page after you successfully signed up:


![aws quicksight register](/media/develop/aws-quicksight-register.png)

2. Click **Go to Amazon QuickSight**. It will jump to the [home page of Amazon QuickSight](https://quicksight.aws.amazon.com/sn/start/analyses).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Click **Go to Amazon QuickSight**. It will jump to the [home page of Amazon QuickSight](https://quicksight.aws.amazon.com/sn/start/analyses).
2. Click **Go to Amazon QuickSight**. The [home page of Amazon QuickSight](https://quicksight.aws.amazon.com/sn/start/analyses) is displayed:


![aws quicksight home page](/media/develop/aws-quicksight-home.png)

3. In the **Datasets** tab, click **New dataset**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. In the **Datasets** tab, click **New dataset**.
3. In the left navigation pane, click the **Datasets** tab and then click **New dataset** in the upper-right corner of the window.


![aws quicksight new dataset](/media/develop/aws-quicksight-new-dataset.png)

4. And you can select the **MySQL** card. Because TiDB is highly compatible with the MySQL protocol and supports [most MySQL syntax and features](/mysql-compatibility.md), most MySQL connection libraries are compatible with TiDB.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. And you can select the **MySQL** card. Because TiDB is highly compatible with the MySQL protocol and supports [most MySQL syntax and features](/mysql-compatibility.md), most MySQL connection libraries are compatible with TiDB.
4. Then, select the **MySQL** card. Because TiDB is highly compatible with the MySQL protocol and supports [most MySQL syntax and features](/mysql-compatibility.md), most MySQL connection libraries are compatible with TiDB.


![aws quicksight new dataset mysql type](/media/develop/aws-quicksight-mysql-card.png)

5. In the dialog, input your TiDB cluster message. And click **Validate connection**. Amazon QuickSight will use the TiDB cluster properties you just input, try to connect the TiDB cluster.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
5. In the dialog, input your TiDB cluster message. And click **Validate connection**. Amazon QuickSight will use the TiDB cluster properties you just input, try to connect the TiDB cluster.
5. In the **New MySQL data source** dialog, enter your TiDB cluster connection information. Then, click **Validate connection**, and Amazon QuickSight will use these connection properties to connect to your TiDB cluster.


![aws quicksight tidb properties](/media/develop/aws-quicksight-tidb-props.png)

6. It shows validated, then clicks **Create data source** (If some errors occur, please check your TiDB cluster is available, and reachable to Amazon QuickSight).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
6. It shows validated, then clicks **Create data source** (If some errors occur, please check your TiDB cluster is available, and reachable to Amazon QuickSight).
6. After **Validated** appears, you can click **Create data source**. If any error occurs, you need to check whether your TiDB cluster is available and reachable to Amazon QuickSight.


![aws quicksight tidb checked](/media/develop//aws-quicksight-tidb-checked.png)

7. Then you can see the tables in the database you specify. In this section, just click **Select** for demonstration. You can edit/preview it, or use SQL to retrieve a result set. For example, you can choose Commercial Open Source Software (COSS) [publicly announced global VC Funding Investments dataset](https://docs.google.com/spreadsheets/d/1Bz0lxWzwW8q9AUSO5HgRrUyfR47em6YQW4h8PF_vRmE/edit#gid=666389338) that stored in `coss_invest` table within TiDB Cluster (PingCAP don't offer this data, just for a demonstrate).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
7. Then you can see the tables in the database you specify. In this section, just click **Select** for demonstration. You can edit/preview it, or use SQL to retrieve a result set. For example, you can choose Commercial Open Source Software (COSS) [publicly announced global VC Funding Investments dataset](https://docs.google.com/spreadsheets/d/1Bz0lxWzwW8q9AUSO5HgRrUyfR47em6YQW4h8PF_vRmE/edit#gid=666389338) that stored in `coss_invest` table within TiDB Cluster (PingCAP don't offer this data, just for a demonstrate).
7. Then, the tables in your TiDB cluster are displayed. You can click **Edit/Preview data** or **Use custom SQL** to modify the dataset and then click **Select** to choose tables. The following screenshot uses the [`coss_invest` table](https://docs.google.com/spreadsheets/d/1Bz0lxWzwW8q9AUSO5HgRrUyfR47em6YQW4h8PF_vRmE/edit#gid=666389338) as the dataset:


![aws quicksight table](/media/develop/aws-quicksight-table.png)

8. In this case, select **Directly query your data** and click **Visualize**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
8. In this case, select **Directly query your data** and click **Visualize**.
8. After choosing the `coss_invest` table, select **Directly query your data** and then click **Visualize**.


![aws quicksight dataset creation finish](/media/develop/aws-quicksight-dataset-finish.png)

9. Data is successfully imported. And you can just click these buttons. You can see a pie chart for **Total percentage of investment in commercial open source softwares by Venture Capitalists**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
9. Data is successfully imported. And you can just click these buttons. You can see a pie chart for **Total percentage of investment in commercial open source softwares by Venture Capitalists**.
9. After the data is successfully imported, you can navigate to the **Visualize** page, and then click the following buttons to generate a pie chart for **Total percentage of investment in commercial open source software by Venture Capitalists**:


![aws quicksight pie chart](/media/develop/aws-quicksight-pie-chart.png)

For more Amazon QuickSight usage, refer to [Amazon QuickSight User Guide](https://docs.aws.amazon.com/quicksight/latest/user/welcome.html).
Comment on lines +90 to +91
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For more Amazon QuickSight usage, refer to [Amazon QuickSight User Guide](https://docs.aws.amazon.com/quicksight/latest/user/welcome.html).

Duplicate with L14

Binary file added media/develop/aws-quicksight-dataset-finish.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-home.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-mysql-card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-new-dataset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-pie-chart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-register.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-tidb-checked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/develop/aws-quicksight-tidb-props.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.