From 0aabe9d87e676b56fb874641e5f4e0d52d4306c2 Mon Sep 17 00:00:00 2001 From: Queeny Date: Wed, 5 Sep 2018 11:33:20 +0800 Subject: [PATCH] readme, quickstart: reorganize the quick start structure (#594) * readme, quickstart: reorganize the quick start structure * QUICKSTART: add a link to try tidb * trytidb: add more information * Address comments * Address comments * quickstart: add a blank line --- QUICKSTART.md | 10 ++++++---- README.md | 4 +++- try-tidb.md | 6 ++++-- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/QUICKSTART.md b/QUICKSTART.md index 2ff85c3db8441..10d231e952c78 100644 --- a/QUICKSTART.md +++ b/QUICKSTART.md @@ -1,6 +1,6 @@ --- title: TiDB Quick Start Guide -summary: Learn how to deploy a TiDB cluster quickly. +summary: Learn how to quickly start a TiDB cluster. category: quick start --- @@ -8,7 +8,7 @@ category: quick start This guide introduces how to deploy and monitor a TiDB cluster on your local drive using Docker Compose for experimenting and testing. -**Warning:** Deploying TiDB using Docker Compose can only be used for experimental purposes. For production usage, [use Ansible to deploy the TiDB cluster](op-guide/ansible-deployment.md). +> **Warning:** Deploying TiDB using Docker Compose can only be used for experimental purposes. For production usage, [use Ansible to deploy the TiDB cluster](op-guide/ansible-deployment.md). ## Prerequisites @@ -50,11 +50,13 @@ Congratulations! You have deployed a TiDB cluster! You can see messages in your You can now test your TiDB server using one of the following methods: -- Use the MySQL client to connect to TiDB to read and write data: +- Use the MySQL client to connect to TiDB: ``` mysql -h 127.0.0.1 -P 4000 -u root ``` - + + You can [try TiDB](try-tidb.md) to explore the SQL statements. + - Use Grafana to view the status of the cluster via [http://localhost:3000](http://localhost:3000) with the default account name and password: `admin` and `admin`. - Use [TiDB-Vision](https://github.com/pingcap/tidb-vision), a cluster visualization tool, to see data transfer and load-balancing inside your cluster via [http://localhost:8010](http://localhost:8010). diff --git a/README.md b/README.md index 2b93486af25cb..87a6ceffbd56f 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,9 @@ + About TiDB - [TiDB Introduction](overview.md#tidb-introduction) - [TiDB Architecture](overview.md#tidb-architecture) -- [TiDB Quick Start Guide](QUICKSTART.md) ++ Quick Start + - [TiDB Quick Start Guide](QUICKSTART.md) + - [Basic SQL Statements](try-tidb.md) - [TiDB Tutorial](https://www.pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) + TiDB User Guide + TiDB Server Administration diff --git a/try-tidb.md b/try-tidb.md index b08ae56daa452..a41ab4b877cbc 100644 --- a/try-tidb.md +++ b/try-tidb.md @@ -1,12 +1,14 @@ --- title: Try TiDB -summary: Some examples on how to test a TiDB cluster. +summary: Learn about the basic SQL statements for the TiDB database. category: try tidb --- # Try TiDB -This guide demonstrates some basic CRUD operations of TiDB that you can perform in the terminal after you successfully deployed a TiDB cluster. +After you successfully deploy a TiDB cluster, you can run SQL statements in TiDB. Because TiDB is compatible with MySQL, you can use THE MySQL client to connect to TiDB and run MySQL statements directly in most of the cases. For more information, see [Compatibility with MySQL](sql/mysql-compatibility.md). + +This page includes some basic SQL statements such as CRUD operations. For a complete list of the statements, see [TiDB SQL Syntax Diagram](https://pingcap.github.io/sqlgram/). ## Create, show, and drop a database