重要

古いバージョンの TiDB データベース (TiDB {{ curdocVersion }}) のドキュメントを表示しています。TiDBデータベースの最新の安定バージョンを使用することをお勧めします。

重要

このページは英語版のページを機械翻訳しています。原文はこちらからご覧ください。

TiDBデータベースプラットフォームのクイックスタートガイド

このガイドでは、TiDBの使用を開始する最も簡単な方法について説明します。非実稼働環境の場合、次のいずれかの方法でTiDBデータベースをデプロイできます。

ローカルテストクラスタをデプロイする（macOSおよびLinuxの場合）
単一のマシンでの実稼働展開をシミュレートする（Linuxのみ）

ノート：
TiDB、TiUP、およびTiDBダッシュボードは、使用法の詳細をPingCAPと共有して、製品を改善する方法を理解するのに役立ちます。共有される内容と共有を無効にする方法の詳細については、テレメトリーを参照してください。
このガイドで提供されている展開方法は、クイックスタートのみを目的としており、本番環境向けではありません。
オンプレミスの本番クラスタをデプロイするには、本番インストールガイドを参照してください。
KubernetesにTiDBをデプロイするには、 KubernetesでTiDBを使い始めるを参照してください。
クラウドでTiDBを管理するには、 TiDB Cloudクイックスタートを参照してください。

ローカルテストクラスタをデプロイする

シナリオ：単一のmacOSまたはLinuxサーバーを使用してテストするために、ローカルTiDBクラスタをすばやくデプロイします。このようなクラスタをデプロイすることにより、TiDBの基本アーキテクチャと、TiDB、TiKV、PD、および監視コンポーネントなどのコンポーネントの操作を学習できます。

macOS
Linux

分散システムとして、基本的なTiDBテストクラスタは通常、2つのTiDBインスタンス、3つのTiKVインスタンス、3つのPDインスタンス、およびオプションのTiFlashインスタンスで構成されます。 TiUP Playgroundを使用すると、次の手順を実行してテストクラスタをすばやく構築できます。

TiUPをダウンロードしてインストールします。

curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

次のメッセージが表示された場合は、TiUPが正常にインストールされています。

Successfully set mirror to https://tiup-mirrors.pingcap.com
Detected shell: zsh
Shell profile:  /Users/user/.zshrc
/Users/user/.zshrc has been modified to add tiup to PATH
open a new terminal or source /Users/user/.zshrc to use it
Installed path: /Users/user/.tiup/bin/tiup
===============================================
Have a try:     tiup playground
===============================================

上記の出力のシェルプロファイルパスに注意してください。次のステップでパスを使用する必要があります。

グローバル環境変数を宣言します。
ノート：
インストール後、TiUPは対応するシェルプロファイルファイルの絶対パスを表示します。パスに応じて、次のsourceのコマンドで${your_shell_profile}を変更する必要があります。この場合、 ${your_shell_profile}はステップ1の出力からの/Users/user/.zshrcです。
```
source ${your_shell_profile}
```
現在のセッションでクラスタを開始します。
- 1つのTiDBインスタンス、1つのTiKVインスタンス、1つのPDインスタンス、および1つのTiFlashインスタンスを使用して最新バージョンのTiDBクラスタを起動する場合は、次のコマンドを実行します。
```
tiup playground
```
- TiDBのバージョンと各コンポーネントのインスタンス数を指定する場合は、次のようなコマンドを実行します。
```
tiup playground v5.4.2 --db 2 --pd 3 --kv 3
```
  このコマンドは、バージョンクラスタをローカルマシンにダウンロードして、v5.4.2などで起動します。最新バージョンを表示するには、 tiup list tidbを実行します。
  このコマンドは、クラスタのアクセスメソッドを返します。
```
CLUSTER START SUCCESSFULLY, Enjoy it ^-^
To connect TiDB: mysql --comments --host 127.0.0.1 --port 4001 -u root -p (no password)
To connect TiDB: mysql --comments --host 127.0.0.1 --port 4000 -u root -p (no password)
To view the dashboard: http://127.0.0.1:2379/dashboard
PD client endpoints: [127.0.0.1:2379 127.0.0.1:2382 127.0.0.1:2384]
To view Prometheus: http://127.0.0.1:9090
To view Grafana: http://127.0.0.1:3000
```
  ノート：
  - v5.2.0以降、TiDBはAppleM1チップを使用するマシンでのtiup playgroundの実行をサポートします。
  - このように操作された遊び場の場合、テスト展開が終了した後、TiUPは元のクラスタデータをクリーンアップします。コマンドを再実行すると、新しいクラスタが取得されます。
  - データをストレージに永続化する場合は、 tiup --tag <your-tag> playground ...を実行します。詳しくはTiUPリファレンスガイドをご覧ください。
TiDBにアクセスするための新しいセッションを開始します。
- TiUPクライアントを使用してTiDBに接続します。
```
tiup client
```
- MySQLクライアントを使用してTiDBに接続することもできます。
```
mysql --host 127.0.0.1 --port 4000 -u root
```
http://127.0.0.1:9090でTiDBのPrometheusダッシュボードにアクセスします。
http://127.0.0.1:2379/dashboardにアクセスしTiDBダッシュボード。デフォルトのユーザー名はrootで、パスワードは空です。
http://127.0.0.1:3000を介してTiDBのGrafanaダッシュボードにアクセスします。デフォルトのユーザー名とパスワードはどちらもadminです。
（オプション）分析用にTiFlashにデータをロードする。
テスト展開後にクラスタをクリーンアップします。
1. Control + Cを押して、上記のTiDBサービスを停止します。
2. サービスが停止した後、次のコマンドを実行します。
```
tiup clean --all
```

ノート：
TiUP Playgroundはデフォルトで127.0.0.1をリッスンし、サービスはローカルでのみアクセス可能です。サービスを外部からアクセスできるようにする場合は、 --hostパラメーターを使用してリスニングアドレスを指定し、ネットワークインターフェイスカード（NIC）を外部からアクセス可能なIPアドレスにバインドします。

TiUPをダウンロードしてインストールします。

curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

次のメッセージが表示された場合は、TiUPが正常にインストールされています。

Successfully set mirror to https://tiup-mirrors.pingcap.com
Detected shell: zsh
Shell profile:  /Users/user/.zshrc
/Users/user/.zshrc has been modified to add tiup to PATH
open a new terminal or source /Users/user/.zshrc to use it
Installed path: /Users/user/.tiup/bin/tiup
===============================================
Have a try:     tiup playground
===============================================

上記の出力のシェルプロファイルパスに注意してください。次のステップでパスを使用する必要があります。

グローバル環境変数を宣言します。
ノート：
インストール後、TiUPは対応するシェルプロファイルファイルの絶対パスを表示します。パスに応じて、次のsourceのコマンドで${your_shell_profile}を変更する必要があります。
```
source ${your_shell_profile}
```
現在のセッションでクラスタを開始します。
- 1つのTiDBインスタンス、1つのTiKVインスタンス、1つのPDインスタンス、および1つのTiFlashインスタンスを使用して最新バージョンのTiDBクラスタを起動する場合は、次のコマンドを実行します。
```
tiup playground
```
- TiDBのバージョンと各コンポーネントのインスタンス数を指定する場合は、次のようなコマンドを実行します。
```
tiup playground v5.4.2 --db 2 --pd 3 --kv 3
```
  このコマンドは、バージョンクラスタをローカルマシンにダウンロードして、v5.4.2などで起動します。最新バージョンを表示するには、 tiup list tidbを実行します。
  このコマンドは、クラスタのアクセスメソッドを返します。
```
CLUSTER START SUCCESSFULLY, Enjoy it ^-^
To connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root -p (no password) --comments
To view the dashboard: http://127.0.0.1:2379/dashboard
PD client endpoints: [127.0.0.1:2379]
To view the Prometheus: http://127.0.0.1:9090
To view the Grafana: http://127.0.0.1:3000
```
  ノート：
  このように操作された遊び場の場合、テスト展開が終了した後、TiUPは元のクラスタデータをクリーンアップします。コマンドを再実行すると、新しいクラスタが作成されます。データをストレージに永続化する場合は、 tiup --tag <your-tag> playground ...を実行します。詳しくはTiUPリファレンスガイドをご覧ください。
TiDBにアクセスするための新しいセッションを開始します。
- TiUPクライアントを使用してTiDBに接続します。
```
tiup client
```
- MySQLクライアントを使用してTiDBに接続することもできます。
```
mysql --host 127.0.0.1 --port 4000 -u root
```
http://127.0.0.1:9090でTiDBのPrometheusダッシュボードにアクセスします。
http://127.0.0.1:2379/dashboardにアクセスしTiDBダッシュボード。デフォルトのユーザー名はrootで、パスワードは空です。
http://127.0.0.1:3000を介してTiDBのGrafanaダッシュボードにアクセスします。デフォルトのユーザー名とパスワードはどちらもadminです。
（オプション）分析用にTiFlashにデータをロードする。
テスト展開後にクラスタをクリーンアップします。
1. Control+Cを押してプロセスを停止します。
2. サービスが停止した後、次のコマンドを実行します。
```
tiup clean --all
```

ノート：
TiUP Playgroundはデフォルトで127.0.0.1をリッスンし、サービスはローカルでのみアクセス可能です。サービスを外部からアクセスできるようにする場合は、 --hostパラメーターを使用してリスニングアドレスを指定し、ネットワークインターフェイスカード（NIC）を外部からアクセス可能なIPアドレスにバインドします。

単一のマシンでの実稼働展開をシミュレートする

シナリオ：完全なトポロジを備えた最小のTiDBクラスタを体験し、単一のLinuxサーバーでの運用展開手順をシミュレートします。

このセクションでは、TiUPで最小のトポロジのYAMLファイルを使用してTiDBクラスタをデプロイする方法について説明します。

準備

次の要件を満たすターゲットマシンを準備します。

CentOS7.3以降のバージョンがインストールされている
Linux OSはインターネットにアクセスできます。インターネットは、TiDBおよび関連するソフトウェアインストールパッケージをダウンロードするために必要です。

最小のTiDBクラスタトポロジは次のとおりです。

ノート：
次のインスタンスのIPアドレスは、IPの例としてのみ機能します。実際の展開では、IPを実際のIPに置き換える必要があります。

実例	カウント	IP	Configuration / コンフィグレーション
TiKV	3	10.0.1.1 10.0.1.1 10.0.1.1	ポートとディレクトリ間の競合を回避する
TiDB	1	10.0.1.1	デフォルトのポートグローバルディレクトリ構成
PD	1	10.0.1.1	デフォルトのポートグローバルディレクトリ構成
TiFlash	1	10.0.1.1	デフォルトのポートグローバルディレクトリ構成
モニター	1	10.0.1.1	デフォルトのポートグローバルディレクトリ構成

ターゲットマシンのその他の要件：

root人のユーザーとそのパスワードが必要です
ターゲットマシンのファイアウォールサービスを停止します、またはTiDBクラスタノードに必要なポートを開きます
現在、TiUPクラスタはx86_64（AMD64）およびARMアーキテクチャーへのTiDBのデプロイをサポートしています。
- AMD64ではCentOS7.3以降のバージョンを使用することをお勧めします
- ARMではCentOS7.61810を使用することをお勧めします

デプロイ

ノート：
通常のユーザーまたはroot人のユーザーとしてターゲットマシンにログインできます。次の手順では、例としてrootユーザーを使用します。

TiUPをダウンロードしてインストールします。

curl --proto '=https' --tlsv1.2 -sSf https://tiup-mirrors.pingcap.com/install.sh | sh

グローバル環境変数を宣言します。
ノート：
インストール後、TiUPは対応するシェルプロファイルファイルの絶対パスを表示します。パスに応じて、次のsourceのコマンドで${your_shell_profile}を変更する必要があります。
```
source ${your_shell_profile}
```
TiUPのクラスタコンポーネントをインストールします。
```
tiup cluster
```
TiUPクラスタがすでにマシンにインストールされている場合は、ソフトウェアバージョンを更新します。
```
tiup update --self && tiup update cluster
```
rootユーザー特権を使用して、 sshdのサービスの接続制限を増やします。これは、TiUPが複数のマシンでの展開をシミュレートする必要があるためです。
1. /etc/ssh/sshd_configを変更し、 MaxSessionsを20に設定します。
2. sshdのサービスを再起動します。
```
service sshd restart
```

クラスタを作成して開始します。

次のテンプレートに従って構成ファイルを編集し、 topo.yamlという名前を付けます。

# # Global variables are applied to all deployments and used as the default value of
# # the deployments if a specific deployment value is missing.
global:
 user: "tidb"
 ssh_port: 22
 deploy_dir: "/tidb-deploy"
 data_dir: "/tidb-data"

# # Monitored variables are applied to all the machines.
monitored:
 node_exporter_port: 9100
 blackbox_exporter_port: 9115

server_configs:
 tidb:
   log.slow-threshold: 300
 tikv:
   readpool.storage.use-unified-pool: false
   readpool.coprocessor.use-unified-pool: true
 pd:
   replication.enable-placement-rules: true
   replication.location-labels: ["host"]
 tiflash:
   logger.level: "info"

pd_servers:
 - host: 10.0.1.1

tidb_servers:
 - host: 10.0.1.1

tikv_servers:
 - host: 10.0.1.1
   port: 20160
   status_port: 20180
   config:
     server.labels: { host: "logic-host-1" }

 - host: 10.0.1.1
   port: 20161
   status_port: 20181
   config:
     server.labels: { host: "logic-host-2" }

 - host: 10.0.1.1
   port: 20162
   status_port: 20182
   config:
     server.labels: { host: "logic-host-3" }

tiflash_servers:
 - host: 10.0.1.1

monitoring_servers:
 - host: 10.0.1.1

grafana_servers:
 - host: 10.0.1.1

user: "tidb" ： tidbシステムユーザー（展開時に自動的に作成されます）を使用して、クラスタの内部管理を実行します。デフォルトでは、ポート22を使用してSSH経由でターゲットマシンにログインします。
replication.enable-placement-rules ：このPDパラメータは、TiFlashが正常に動作することを保証するために設定されます。
host ：ターゲットマシンのIP。

clusterdeploymentコマンドを実行しクラスタ。
```
tiup cluster deploy <cluster-name> <tidb-version> ./topo.yaml --user root -p
```
- <cluster-name> ：クラスタ名を設定します
- <tidb-version> ：TiDBクラスタのバージョンを設定します。 tiup list tidbコマンドを実行すると、サポートされているすべてのTiDBバージョンを確認できます。
- -p ：ターゲットマシンへの接続に使用するパスワードを指定します。
  ノート：
  秘密鍵を使用する場合は、 -iを介して鍵のパスを指定できます。 -iと-pを同時に使用しないでください。
「y」とroot人のユーザーのパスワードを入力して、展開を完了します。
```
Do you want to continue? [y/N]:  y
Input SSH password:
```
クラスタを開始します：
```
tiup cluster start <cluster-name>
```
クラスタにアクセスします。
- MySQLクライアントをインストールします。すでにインストールされている場合は、この手順をスキップしてください。
```
yum -y install mysql
```
- TiDBにアクセスします。パスワードは空です：
```
mysql -h 10.0.1.1 -P 4000 -u root
```
- http：// {grafana-ip}：3000でGrafanaモニタリングダッシュボードにアクセスします。デフォルトのユーザー名とパスワードはどちらもadminです。
- http：// {pd-ip}：2379 / dashboardにアクセスしTiDBダッシュボード。デフォルトのユーザー名はrootで、パスワードは空です。
- 現在デプロイされているクラスタリストを表示するには：
```
tiup cluster list
```
- クラスタのトポロジとステータスを表示するには：
```
tiup cluster display <cluster-name>
```

次は何ですか

ローカルテスト環境にTiDBクラスタをデプロイしたばかりの場合：
- 学ぶTiDBでの基本的なSQL操作
- データをTiDBに移行する
実稼働環境にTiDBクラスタをデプロイする準備ができている場合：
- TiUPを使用してTiDBをデプロイ
- TiDB Operatorを使用してクラウドにTiDBをデプロイ
TiFlashを使用した分析ソリューションをお探しの場合：
- TiFlashを使用する
- TiFlashの概要