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

Conversation

Icemap
Copy link
Member

@Icemap Icemap commented Dec 14, 2022

First-time contributors' checklist

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • master (the latest development version)
  • v6.6 (TiDB 6.6 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.4 (TiDB 6.4 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@Icemap Icemap added missing-translation-status This PR does not have translation status info. area/develop This PR relates to the area of TiDB App development. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. needs-cherry-pick-release-6.2 needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. labels Dec 14, 2022
@ti-chi-bot
Copy link
Member

[REVIEW NOTIFICATION]

This pull request has not been approved.

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 14, 2022
@Oreoxmt Oreoxmt requested review from Oreoxmt and removed request for shichun-0415 December 15, 2022 03:31
@Oreoxmt Oreoxmt added the translation/doing This PR's assignee is translating this PR. label Dec 15, 2022
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Dec 15, 2022
@ti-chi-bot ti-chi-bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Dec 16, 2022
@Oreoxmt Oreoxmt self-requested a review December 16, 2022 08:25
@ti-chi-bot ti-chi-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 3, 2023
@ti-chi-bot ti-chi-bot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 4, 2023
@@ -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

@@ -0,0 +1,91 @@
---
title: QuickSight Integration Guide
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.

Comment on lines +36 to +51
- [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.
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 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**:

Comment on lines +90 to +91

For more Amazon QuickSight usage, refer to [Amazon QuickSight User Guide](https://docs.aws.amazon.com/quicksight/latest/user/welcome.html).
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

@Oreoxmt Oreoxmt self-requested a review January 4, 2023 09:54
@ti-chi-bot
Copy link
Member

@Icemap: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@ti-chi-bot ti-chi-bot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 17, 2023
@qiancai
Copy link
Collaborator

qiancai commented Feb 24, 2023

Removed the needs-cherry-pick-release-6.3 label because the v6.3 docs have been archived at https://docs-archive.pingcap.com/tidb/v6.3 and will no longer receive new updates.

@qiancai
Copy link
Collaborator

qiancai commented Apr 6, 2023

Removed the needs-cherry-pick-release-6.4 label because the v6.4 docs have been archived at https://docs-archive.pingcap.com/tidb/v6.4 and will no longer receive new updates.

Copy link

ti-chi-bot bot commented Jan 26, 2024

@Icemap: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 3222a8b link true /test pull-verify

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ Oreoxmt
❌ Icemap


Icemap seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/develop This PR relates to the area of TiDB App development. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. needs-cherry-pick-release-6.5 Should cherry pick this PR to release-6.5 branch. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. translation/doing This PR's assignee is translating this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants