Driverまたは ORM を選択
ノート:
TiDB は、ドライバーと ORM に対して次の 2 つのサポート レベルを提供します。
- Full : TiDB がツールのほとんどの機能と互換性があり、新しいバージョンとの互換性を維持していることを示します。 PingCAP は、最新バージョンのTiDB がサポートするサードパーティ ツールとの互換性テストを定期的に実施します。
- 互換性: 対応するサードパーティ製ツールが MySQL に適合しており、TiDB は MySQL プロトコルとの互換性が高いため、TiDB はツールのほとんどの機能を使用できることを示します。ただし、PingCAP はツールのすべての機能について完全なテストを完了していないため、予期しない動作が発生する可能性があります。
詳細については、 TiDB がサポートするサードパーティ ツールを参照してください。
TiDB は MySQL プロトコルと高い互換性がありますが、一部の機能は MySQL と互換性がありません。互換性の相違点の完全なリストについては、 MySQL の互換性を参照してください。
Java
このセクションでは、 Javaでドライバーと ORM フレームワークを使用する方法について説明します。
Javaドライバー
- MySQL-JDBC
- TiDB-JDBC
サポートレベル:フル
MySQL ドキュメントに従って、 Java JDBC ドライバーをダウンロードして構成できます。 TiDB v6.3.0 以降では、MySQL Connector/J 8.0.29 以降を使用することをお勧めします。
ヒント:
8.0.32 より前の Connector/J 8.0 バージョンにはバグあり、v6.3.0 より前の TiDB バージョンを使用するとスレッドがハングする可能性があります。この問題を回避するには、MySQL Connector/J 8.0.32 以降のバージョン、または TiDB JDBC を使用することをお勧めします ( 「TiDB-JDBC」タブを参照)。
完全なアプリケーションを構築する方法の例については、 TiDB と JDBC を使用して単純な CRUD アプリを構築するを参照してください。
サポートレベル:フル
TiDB-JDBCは、MySQL 8.0.29 に基づくカスタマイズされたJavaドライバーです。 MySQL 公式バージョン 8.0.29 に基づいてコンパイルされた TiDB-JDBC は、元の JDBC の準備モードでのマルチパラメータおよびマルチフィールド EOF のバグを修正し、自動 TiCDC スナップショット メンテナンスおよび SM3 認証プラグインなどの機能を追加します。
SM3 ベースの認証の使用は、MySQL Connector/J の TiDB バージョンでのみサポートされています。
Maven を使用する場合は、次の内容をpom.xml
ファイルの<dependencies></dependencies>
セクションに追加します。
<dependency>
<groupId>io.github.lastincisor</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.29-tidb-1.0.0</version>
</dependency>
SM3 認証を有効にする必要がある場合は、次の内容をpom.xml
ファイルの<dependencies></dependencies>
セクションに追加します。
<dependency>
<groupId>io.github.lastincisor</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.29-tidb-1.0.0</version>
</dependency>
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcprov-jdk15on</artifactId>
<version>1.67</version>
</dependency>
<dependency>
<groupId>org.bouncycastle</groupId>
<artifactId>bcpkix-jdk15on</artifactId>
<version>1.67</version>
</dependency>
Gradle を使用する場合は、次の内容をdependencies
に追加します。
implementation group: 'io.github.lastincisor', name: 'mysql-connector-java', version: '8.0.29-tidb-1.0.0'
implementation group: 'org.bouncycastle', name: 'bcprov-jdk15on', version: '1.67'
implementation group: 'org.bouncycastle', name: 'bcpkix-jdk15on', version: '1.67'
Java ORM フレームワーク
ノート:
現在、Hibernate はネストされたトランザクションをサポートしないを実行します。
v6.2.0 以降、TiDB はセーブポイントをサポートしています。
@Transactional
でPropagation.NESTED
トランザクション伝播オプションを使用する、つまり@Transactional(propagation = Propagation.NESTED)
を設定するには、TiDB が v6.2.0 以降であることを確認してください。
- Hibernate
- MyBatis
サポートレベル:フル
アプリケーションの異なる依存関係間の複雑な関係を手動で管理することを避けるために、 グラドルまたはメイヴンを使用して、間接的なものを含むアプリケーションのすべての依存関係を取得できます。 Hibernate 6.0.0.Beta2
以降のみが TiDB ダイアレクトをサポートすることに注意してください。
Maven を使用している場合は、次を<dependencies></dependencies>
に追加します。
<dependency>
<groupId>org.hibernate.orm</groupId>
<artifactId>hibernate-core</artifactId>
<version>6.0.0.CR2</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.49</version>
</dependency>
Gradle を使用している場合は、以下をdependencies
に追加します。
implementation 'org.hibernate:hibernate-core:6.0.0.CR2'
implementation 'mysql:mysql-connector-java:5.1.49'
- Hibernate を使用してネイティブJavaで TiDB アプリケーションを構築する例については、 TiDB とJavaを使用して単純な CRUD アプリを構築するを参照してください。
- Spring Data JPA または Hibernate を使用して Spring で TiDB アプリケーションを構築する例については、 Spring Boot を使用して TiDB アプリケーションを構築するを参照してください。
さらに、 ハイバネート構成ファイル : org.hibernate.dialect.TiDBDialect
で TiDB ダイアレクトを指定する必要があります。これは、Hibernate 6.0.0.Beta2
以降でのみサポートされています。 Hibernate
バージョンが6.0.0.Beta2
より前の場合は、最初にアップグレードしてください。
ノート:
バージョン
Hibernate
をアップグレードできない場合は、代わりにMySQL 5.7ダイアレクトorg.hibernate.dialect.MySQL57Dialect
を使用してください。ただし、この設定により、予測できない結果が生じたり、 シーケンスなどの TiDB 固有の機能が一部失われたりする可能性があります。
サポートレベル:フル
アプリケーションの異なる依存関係間の複雑な関係を手動で管理することを避けるために、 グラドルまたはメイヴンを使用して、間接的な依存関係を含むアプリケーションのすべての依存関係を取得できます。
Maven を使用している場合は、以下を<dependencies></dependencies>
に追加します。
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.5.9</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.49</version>
</dependency>
Gradle を使用している場合は、以下をdependencies
に追加します。
implementation 'org.mybatis:mybatis:3.5.9'
implementation 'mysql:mysql-connector-java:5.1.49'
MyBatis を使用して TiDB アプリケーションを構築する例については、 TiDB とJavaを使用して単純な CRUD アプリを構築するを参照してください。
Javaクライアントの負荷分散
tidb-loadbalance
サポートレベル:フル
tidb-loadbalanceは、アプリケーション側の負荷分散コンポーネントです。 tidb-loadbalance を使用すると、TiDBサーバーのノード情報を自動的に維持し、tidb-loadbalance ポリシーを使用してクライアントに JDBC 接続を分散できます。クライアント アプリケーションと TiDBサーバー間で直接 JDBC 接続を使用すると、負荷分散コンポーネントを使用するよりも高いパフォーマンスが得られます。
現在、tidb-loadbalance は次のポリシーをサポートしています: roundrobin、random、および weight。
ノート:
tidb-loadbalance はmysql-コネクタ-jと共に使用する必要があります。
Maven を使用する場合は、 pom.xml
ファイルの<dependencies></dependencies>
の要素本体に次の内容を追加します。
<dependency>
<groupId>io.github.lastincisor</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.29-tidb-1.0.0</version>
</dependency>
<dependency>
<groupId>io.github.lastincisor</groupId>
<artifactId>tidb-loadbalance</artifactId>
<version>0.0.5</version>
</dependency>
Gradle を使用する場合は、次の内容をdependencies
に追加します。
implementation group: 'io.github.lastincisor', name: 'mysql-connector-java', version: '8.0.29-tidb-1.0.0'
implementation group: 'io.github.lastincisor', name: 'tidb-loadbalance', version: '0.0.5'
Golang
このセクションでは、 Golangでドライバーと ORM フレームワークを使用する方法について説明します。
Golangドライバー
go-sql-driver/mysql
サポートレベル:フル
Golangドライバーをダウンロードして構成するには、 go-sql-driver/mysql ドキュメントを参照してください。
完全なアプリケーションを構築する方法の例については、 TiDB とGolangを使用して単純な CRUD アプリを構築するを参照してください。
Golang ORM フレームワーク
ゴーム
サポートレベル:フル
GORM はGolangの一般的な ORM フレームワークです。アプリケーションのすべての依存関係を取得するには、 go get
コマンドを使用できます。
go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql
GORM を使用して TiDB アプリケーションを構築する例については、 TiDB とGolangを使用して単純な CRUD アプリを構築するを参照してください。
パイソン
このセクションでは、Python でドライバーと ORM フレームワークを使用する方法について説明します。
Python ドライバー
- PyMySQL
- mysqlclient
- mysql-connector-python
サポートレベル:対応
PyMySQL ドキュメントに従って、ドライバーをダウンロードして構成できます。 PyMySQL 1.0.2 以降のバージョンを使用することをお勧めします。
PyMySQL を使用して TiDB アプリケーションを構築する例については、 TiDB と Python を使用して単純な CRUD アプリを構築するを参照してください。
サポートレベル:対応
mysqlclient ドキュメントに従って、ドライバーをダウンロードして構成できます。 mysqlclient 2.1.1 以降のバージョンを使用することをお勧めします。
mysqlclient を使用して TiDB アプリケーションを構築する例については、 TiDB と Python を使用して単純な CRUD アプリを構築するを参照してください。
サポートレベル:対応
mysql-connector-python ドキュメントに従って、ドライバーをダウンロードして構成できます。 Connector/Python 8.0.31 以降のバージョンを使用することをお勧めします。
mysql-connector-python を使用して TiDB アプリケーションを構築する例については、 TiDB と Python を使用して単純な CRUD アプリを構築するを参照してください。
Python ORM フレームワーク
- SQLAlchemy
- peewee
サポートレベル:対応
SQL錬金術は、Python の一般的な ORM フレームワークです。アプリケーションのすべての依存関係を取得するには、 pip install SQLAlchemy==1.4.44
コマンドを使用できます。 SQLAlchemy 1.4.44 以降のバージョンを使用することをお勧めします。
SQLAlchemy を使用して TiDB アプリケーションを構築する例については、 TiDB と Python を使用して単純な CRUD アプリを構築するを参照してください。
サポートレベル:対応
ピーウィーは、Python の一般的な ORM フレームワークです。アプリケーションのすべての依存関係を取得するには、 pip install peewee==3.15.4
コマンドを使用できます。 peewee 3.15.4 以降のバージョンを使用することをお勧めします。
peewee を使用して TiDB アプリケーションを構築する例については、 TiDB と Python を使用して単純な CRUD アプリを構築するを参照してください。