- Docs Home
- About TiDB Cloud
- Get Started
- Develop Applications
- Overview
- Quick Start
- Build a TiDB Developer Cluster
- CRUD SQL in TiDB
- Build a Simple CRUD App with TiDB
- Example Applications
- Connect to TiDB
- Design Database Schema
- Write Data
- Read Data
- Transaction
- Optimize
- Troubleshoot
- Reference
- Cloud Native Development Environment
- Manage Cluster
- Plan Your Cluster
- Create a TiDB Cluster
- Connect to Your TiDB Cluster
- Set Up VPC Peering Connections
- Use an HTAP Cluster with TiFlash
- Scale a TiDB Cluster
- Upgrade a TiDB Cluster
- Delete a TiDB Cluster
- Use TiDB Cloud API (Beta)
- Migrate Data
- Import Sample Data
- Migrate Data into TiDB
- Configure Amazon S3 Access and GCS Access
- Migrate from MySQL-Compatible Databases
- Migrate Incremental Data from MySQL-Compatible Databases
- Migrate from Amazon Aurora MySQL in Bulk
- Import or Migrate from Amazon S3 or GCS to TiDB Cloud
- Import CSV Files from Amazon S3 or GCS into TiDB Cloud
- Import Apache Parquet Files from Amazon S3 or GCS into TiDB Cloud
- Troubleshoot Access Denied Errors during Data Import from Amazon S3
- Export Data from TiDB
- Back Up and Restore
- Monitor and Alert
- Overview
- Built-in Monitoring
- Built-in Alerting
- Third-Party Monitoring Integrations
- Tune Performance
- Overview
- Analyze Performance
- SQL Tuning
- Overview
- Understanding the Query Execution Plan
- SQL Optimization Process
- Overview
- Logic Optimization
- Physical Optimization
- Prepare Execution Plan Cache
- Control Execution Plans
- TiKV Follower Read
- Coprocessor Cache
- Garbage Collection (GC)
- Tune TiFlash performance
- Manage User Access
- Billing
- Reference
- TiDB Cluster Architecture
- TiDB Cloud Cluster Limits and Quotas
- TiDB Limitations
- SQL
- Explore SQL with TiDB
- SQL Language Structure and Syntax
- SQL Statements
ADD COLUMN
ADD INDEX
ADMIN
ADMIN CANCEL DDL
ADMIN CHECKSUM TABLE
ADMIN CHECK [TABLE|INDEX]
ADMIN SHOW DDL [JOBS|QUERIES]
ALTER DATABASE
ALTER INDEX
ALTER TABLE
ALTER TABLE COMPACT
ALTER USER
ANALYZE TABLE
BATCH
BEGIN
CHANGE COLUMN
COMMIT
CHANGE DRAINER
CHANGE PUMP
CREATE [GLOBAL|SESSION] BINDING
CREATE DATABASE
CREATE INDEX
CREATE ROLE
CREATE SEQUENCE
CREATE TABLE LIKE
CREATE TABLE
CREATE USER
CREATE VIEW
DEALLOCATE
DELETE
DESC
DESCRIBE
DO
DROP [GLOBAL|SESSION] BINDING
DROP COLUMN
DROP DATABASE
DROP INDEX
DROP ROLE
DROP SEQUENCE
DROP STATS
DROP TABLE
DROP USER
DROP VIEW
EXECUTE
EXPLAIN ANALYZE
EXPLAIN
FLASHBACK TABLE
FLUSH PRIVILEGES
FLUSH STATUS
FLUSH TABLES
GRANT <privileges>
GRANT <role>
INSERT
KILL [TIDB]
MODIFY COLUMN
PREPARE
RECOVER TABLE
RENAME INDEX
RENAME TABLE
REPLACE
REVOKE <privileges>
REVOKE <role>
ROLLBACK
SELECT
SET DEFAULT ROLE
SET [NAMES|CHARACTER SET]
SET PASSWORD
SET ROLE
SET TRANSACTION
SET [GLOBAL|SESSION] <variable>
SHOW ANALYZE STATUS
SHOW [GLOBAL|SESSION] BINDINGS
SHOW BUILTINS
SHOW CHARACTER SET
SHOW COLLATION
SHOW [FULL] COLUMNS FROM
SHOW CREATE SEQUENCE
SHOW CREATE TABLE
SHOW CREATE USER
SHOW DATABASES
SHOW DRAINER STATUS
SHOW ENGINES
SHOW ERRORS
SHOW [FULL] FIELDS FROM
SHOW GRANTS
SHOW INDEX [FROM|IN]
SHOW INDEXES [FROM|IN]
SHOW KEYS [FROM|IN]
SHOW MASTER STATUS
SHOW PLUGINS
SHOW PRIVILEGES
SHOW [FULL] PROCESSSLIST
SHOW PROFILES
SHOW PUMP STATUS
SHOW SCHEMAS
SHOW STATS_HEALTHY
SHOW STATS_HISTOGRAMS
SHOW STATS_META
SHOW STATUS
SHOW TABLE NEXT_ROW_ID
SHOW TABLE REGIONS
SHOW TABLE STATUS
SHOW [FULL] TABLES
SHOW [GLOBAL|SESSION] VARIABLES
SHOW WARNINGS
SHUTDOWN
SPLIT REGION
START TRANSACTION
TABLE
TRACE
TRUNCATE
UPDATE
USE
WITH
- Data Types
- Functions and Operators
- Overview
- Type Conversion in Expression Evaluation
- Operators
- Control Flow Functions
- String Functions
- Numeric Functions and Operators
- Date and Time Functions
- Bit Functions and Operators
- Cast Functions and Operators
- Encryption and Compression Functions
- Locking Functions
- Information Functions
- JSON Functions
- Aggregate (GROUP BY) Functions
- Window Functions
- Miscellaneous Functions
- Precision Math
- Set Operations
- List of Expressions for Pushdown
- TiDB Specific Functions
- Clustered Indexes
- Constraints
- Generated Columns
- SQL Mode
- Table Attributes
- Transactions
- Views
- Partitioning
- Temporary Tables
- Cached Tables
- Character Set and Collation
- Read Historical Data
- System Tables
mysql
- INFORMATION_SCHEMA
- Overview
ANALYZE_STATUS
CLIENT_ERRORS_SUMMARY_BY_HOST
CLIENT_ERRORS_SUMMARY_BY_USER
CLIENT_ERRORS_SUMMARY_GLOBAL
CHARACTER_SETS
CLUSTER_INFO
COLLATIONS
COLLATION_CHARACTER_SET_APPLICABILITY
COLUMNS
DATA_LOCK_WAITS
DDL_JOBS
DEADLOCKS
ENGINES
KEY_COLUMN_USAGE
PARTITIONS
PROCESSLIST
REFERENTIAL_CONSTRAINTS
SCHEMATA
SEQUENCES
SESSION_VARIABLES
SLOW_QUERY
STATISTICS
TABLES
TABLE_CONSTRAINTS
TABLE_STORAGE_STATS
TIDB_HOT_REGIONS_HISTORY
TIDB_INDEXES
TIDB_SERVERS_INFO
TIDB_TRX
TIFLASH_REPLICA
TIKV_REGION_PEERS
TIKV_REGION_STATUS
TIKV_STORE_STATUS
USER_PRIVILEGES
VIEWS
- System Variables
- API Reference
- Storage Engines
- Dumpling
- Table Filter
- Troubleshoot Inconsistency Between Data and Indexes
- FAQs
- Release Notes
- Support
- Glossary
TiDB Cloud Quick Start
Estimated completion time: 20 minutes
This tutorial guides you through an easy way to get started with your TiDB Cloud. The content includes how to create a cluster, connect to a cluster, import data, and run queries.
Step 1. Create a TiDB cluster
You can either create a free Developer Tier cluster or a Dedicated Tier.
- Developer Tier
- Dedicated Tier
To create a free Developer Tier cluster, take the following steps:
If you do not have a TiDB Cloud account, click here to sign up for an account.
- For Google users, you can also sign up with Google. To do that, click Sign up with Google on the sign up page. Your email address and password will be managed by Google and cannot be changed using TiDB Cloud console.
- For GitHub users, you can also sign up with GitHub. To do that, click Sign up with GitHub on the sign up page. Your email address and password will be managed by GitHub and cannot be changed using TiDB Cloud console.
Log in to your TiDB Cloud account.
The plan selection page is displayed by default.
On the plan selection page, click Get Started for Free in the Developer Tier plan.
On the Create Cluster page, Developer Tier is selected by default. Update the default cluster name if necessary, and then select the region where you want to create your cluster.
Click Create.
The cluster creation process starts and the Security Settings dialog box is displayed.
In the Security Settings dialog box, set the root password and allowed IP addresses to connect to your cluster, and then click Apply.
Your TiDB Cloud cluster will be created in approximately 5 to 15 minutes.
To create a Dedicated Tier cluster, take the following steps:
If you do not have a TiDB Cloud account, click here to sign up for an account.
- For Google users, you can also sign up with Google. To do that, click Sign up with Google on the sign up page. Your email address and password will be managed by Google and cannot be changed using TiDB Cloud console.
- For GitHub users, you can also sign up with GitHub. To do that, click Sign up with GitHub on the sign up page. Your email address and password will be managed by GitHub and cannot be changed using TiDB Cloud console.
- For AWS Marketplace users, you can also sign up through AWS Marketplace. To do that, search for
TiDB Cloud
in AWS Marketplace, subscribe to TiDB Cloud, and then follow the onscreen instructions to set up your TiDB Cloud account.
Log in to your TiDB Cloud account.
The plan selection page is displayed by default.
On the plan selection page, click Get Full Access Today in the Dedicated Tier plan.
On the Create a Cluster page, Dedicated Tier is selected by default. Update the default cluster name and port number if necessary, choose a cloud provider and a region, and then click Next.
NoteIf you want to get a 14-day free trial of TiDB Cloud Dedicated Tier first, see Perform a Proof of Concept (PoC) with TiDB Cloud.
If this is the first cluster of your current project and CIDR has not been configured for this project, you need to set the project CIDR, and then click Next. If you do not see the project CIDR field, it means that CIDR has already been configured for this project.
NoteWhen setting the project CIDR, avoid any conflicts with the CIDR of the VPC where your application is located. The CIDR of a project cannot be modified once it is set.
Configure the cluster size for TiDB, TiKV, and TiFlash (optional) respectively, and then click Next.
Confirm the cluster information on the page and also the billing information in the lower-left corner.
Click Add Credit Card in the lower-right corner to add a credit card for your account.
Click Create.
The cluster creation process starts and the Security Settings dialog box is displayed.
In the Security Settings dialog box, set the root password and allowed IP addresses to connect to your cluster, and then click Apply.
Your TiDB Cloud cluster will be created in approximately 5 to 15 minutes.
Step 2. Connect to your TiDB cluster
Navigate to the Clusters page.
In the area of your newly created cluster, click Connect in the upper-right corner. A connection dialog box is displayed.
TipAlternatively, you can also click the name of your newly created cluster on the Clusters page and click Connect in the upper-right corner.
Under Step 2: Connect with a SQL client in the dialog box, click the tab of your preferred connection method, and then connect to your cluster with the connection string.
Note- For Developer Tier clusters, when you connect to your cluster, you must include the prefix for your cluster in the user name and wrap the name with quotation marks. For more information, see User name prefix.
- TiDB Cloud is MySQL-compatible, so you can connect to your cluster using any MySQL client tools. We recommend using mysql — The MySQL Command-Line Client or mysql — The MySQL Command-Line Client from MariaDB.
After logging into your TiDB cluster, you can use the following SQL statement to validate the connection:
SELECT TiDB_version();
If you see the release version information, you are ready to use your TiDB cluster.
Step 3. Import the sample data
We provide Capital Bikeshare sample data for you to easily import data and run sample queries.
Navigate to the Clusters page.
In the area of your newly created cluster, click Import Data in the upper-right corner. The Data Import Task page is displayed.
TipAlternatively, you can also click the name of your newly created cluster on the Clusters page and click Import Data in the upper-right corner.
Fill in the import parameters:
- AWS
- GCP
If your TiDB cluster is hosted by AWS (the Developer Tier is hosted by AWS by default), fill in the following parameters:
- Data Source Type:
AWS S3
. - Bucket URL: enter the sample data URL
s3://tidbcloud-samples/data-ingestion/
. - Data Format: select TiDB Dumpling.
- Setup Credentials: enter
arn:aws:iam::385595570414:role/import-sample-access
for Role-ARN. - Target Cluster: fill in the Username and Password fields.
- DB/Tables Filter: leave this field blank.
If your TiDB cluster is hosted by GCP, fill in the following parameters:
- Data Source Type:
Google Cloud Stroage
. - Bucket URL: enter the sample data URL
gcs://tidbcloud-samples-us-west1
. - Data Format: select TiDB Dumpling.
- Target Cluster: fill in the Username and Password fields.
- DB/Tables Filter: leave this field blank.
Click Import.
A warning message about the database resource consumption is displayed. For a newly created cluster, you can ignore the warning message.
Click Confirm.
TiDB Cloud starts validating whether it can access the sample data in the specified bucket URL. After the validation is completed and successful, the import task starts automatically.
The data import process will take 5 to 10 minutes. When the data import progress bar shows Success, you successfully import the sample data and the database schema in your database.
Step 4. Query data
When the process of importing data is completed, you can start to run some queries in your Terminal:
Use the
bikeshare
database and tables:USE bikeshare; SHOW tables;
Check the structure of the
trip
table:DESCRIBE trips;
Check how many records exist in the
trips
table:SELECT COUNT(*) FROM trips;
Check the entire trip history where the start station is "8th & D St NW":
SELECT * FROM trips WHERE start_station_name = '8th & D St NW';
Show the least ten popular bicycle stations for picking up:
SELECT start_station_name, COUNT(ride_id) as count from `trips` GROUP BY start_station_name ORDER BY count ASC LIMIT 10;