バージョン: 2.1

MySQL JDBC カタログ

Doris JDBC Catalogは標準のJDBCインターフェースを介してMySQLデータベースへの接続をサポートします。この文書では、MySQLデータベース接続の設定方法について説明します。

JDBC Catalogの概要については、次を参照してください：JDBC カタログ概要

使用上の注意事項

MySQLデータベースに接続するには、以下が必要です：

MySQL 5.7、8.0、またはそれ以降のバージョン。
MySQLのJDBCドライバー。Maven Repositoryからダウンロードできます。MySQL Connector/Jバージョン8.0.31以上の使用を推奨します。
各Doris FEおよびBEノードとMySQLサーバー間のネットワーク接続。デフォルトポートは3306です。

MySQLへの接続

CREATE CATALOG mysql_catalog PROPERTIES (
    'type' = 'jdbc',
    'user' = 'username',
    'password' = 'pwd',
    'jdbc_url' = 'jdbc:mysql://host:3306',
    'driver_url' = 'mysql-connector-j-8.3.0.jar',
    'driver_class' = 'com.mysql.cj.jdbc.Driver'
);

jdbc_urlはMySQLのJDBCドライバーに渡される接続情報とパラメータを定義します。サポートされているURLパラメータはMySQL Developer Guideで確認できます。

Connection Security

ユーザーがデータソースにグローバルに信頼された証明書がインストールされたTLSを設定している場合、jdbc_urlプロパティに設定されたJDBC接続文字列にパラメータを追加することで、クラスターとデータソース間でTLSを有効化できます。

例えば、MySQL Connector/J 8.0では、TLS経由で接続を保護するためにsslModeパラメータを使用します。デフォルトでは、このパラメータはPREFERREDに設定されており、サーバーが有効になっている場合に接続を保護できます。このパラメータはREQUIREDに設定することもでき、その場合TLSが確立されなければ接続は失敗します。

jdbc_urlにsslModeパラメータを追加することで設定できます：

'jdbc_url' = 'jdbc:mysql://host:3306/?sslMode=REQUIRED'

TLS設定オプションの詳細については、MySQL JDBC Security Documentationを参照してください。

階層マッピング

MySQLをマッピングする際、DorisのDatabaseはMySQLのDatabaseに対応します。DorisのDatabase下のTableは、MySQLのそのDatabase下のTablesに対応します。マッピング関係は以下の通りです：

Doris	MySQL
カタログ	MySQL サーバー
Database	Database
Table	Table

カラム型マッピング

MySQL タイプ	Doris タイプ	Comment
boolean	tinyint
tinyint	tinyint
smallint	smallint
mediumint	int
int	int
bigint	bigint
unsigned tinyint	smallint	Dorisはunsigned型をサポートしていないため、unsigned型はDorisの対応するより大きなデータ型にマッピングされます。
unsigned mediumint	int	上記と同様。
unsigned int	bigint	上記と同様。
unsigned bigint	largeint	上記と同様。
float	float
double	double
decimal(P, S)	decimal(P, S)
unsigned decimal(P, S)	decimal(P + 1, S) / string	Dorisでサポートされる最大精度を超える場合、Stringで処理されます。この型がStringにマッピングされる場合、クエリのみサポートされ、MySQLへの書き込みはできないことに注意してください。
date	date
timestamp(S)	datetime(S)
datetime(S)	datetime(S)
year	smallint	Dorisはyear型をサポートしていないため、year型はsmallintにマッピングされます。
time	string	Dorisはtime型をサポートしていないため、time型はstringにマッピングされます。
char	char
varchar	varchar
json	string	読み込みと計算パフォーマンスのバランスを改善するため、Dorisはjson型をstring型にマッピングします。
set	string
enum	string
bit	boolean / string	Dorisはbit型をサポートしていないため、bit(1)の場合はbooleanに、その他の場合はstringにマッピングされます。
tinytext, text, mediumtext, longtext	string
blob, mediumblob, longblob, tinyblob, binary, varbinary	string/varbinary	Catalogの`enable.mapping.varbinary`プロパティによって制御されます（4.0.2以降でサポート）。デフォルトは`false`で`string`にマッピングされ、`true`の場合は`varbinary`型にマッピングされます。
other	UNSUPPORTED

付録

タイムゾーンの問題

JDBC Catalogを通じてデータにアクセスする際、BEのJNI部分はJVMタイムゾーンを使用します。JVMタイムゾーンはデフォルトでBEデプロイマシンのタイムゾーンになり、JDBCがデータを読み取る際のタイムゾーン変換に影響します。タイムゾーンの一貫性を確保するため、be.confのJAVA_OPTSでJVMタイムゾーンをDorisセッション変数time_zoneと一致するよう設定することを推奨します。

MySQLのtimestamp型を読み取る際は、JDBC URLにconnectionTimeZone=LOCALとforceConnectionTimeZoneToSession=trueパラメータを追加してください。これらのパラメータはMySQL Connector/Jバージョン8以降で適用でき、読み取られる時間がMySQLサーバーのタイムゾーンではなく、Doris BE JVMタイムゾーンになることを保証します。

よくある問題

接続例外のトラブルシューティング

Communications link failure The last packet successfully received from the server was 7 milliseconds ago.
- 原因：
  - ネットワーク問題：
    - ネットワークの不安定さまたは接続の中断。
    - クライアントとサーバー間の高いネットワーク遅延。
  - MySQLサーバー設定
    - MySQLサーバーがwait_timeoutやinteractive_timeoutなどの接続タイムアウトパラメータを設定している可能性があり、タイムアウトにより接続が閉じられる原因となります。
  - ファイアウォール設定
    - ファイアウォールルールがクライアントとサーバー間の通信をブロックしている可能性があります。
  - コネクションプール設定
    - コネクションプールの設定connection_pool_max_life_timeにより接続が閉じられるまたはリサイクルされる、または適時にキープアライブされない可能性があります。
  - サーバーリソース問題
    - MySQLサーバーに新しい接続リクエストを処理するリソースが不足している可能性があります。
  - クライアント設定
    - JDBCドライバーの設定が不正、例えばautoReconnectパラメータが設定されていないまたは不適切に設定されている。
- 解決策
  - ネットワーク接続の確認：
    - クライアントとサーバー間の安定したネットワーク接続を確保し、高いネットワーク遅延を避けます。
  - MySQLサーバー設定の確認：
    - MySQLサーバーのwait_timeoutとinteractive_timeoutパラメータを確認・調整し、適切に設定されていることを確認します。
  - ファイアウォール設定の確認：
    - ファイアウォールルールがクライアントとサーバー間の通信を許可していることを確認します。
  - コネクションプール設定の調整：
    - コネクションプールの設定パラメータconnection_pool_max_life_timeを確認・調整し、MySQLのwait_timeoutとinteractive_timeoutパラメータより小さく、SQLの最長実行時間より大きく設定されていることを確認します。
  - サーバーリソースの監視：
    - MySQLサーバーのリソース使用状況を監視し、接続リクエストを処理するのに十分なリソースがあることを確認します。
  - クライアント設定の最適化：
    - JDBCドライバーの設定パラメータが正しいことを確認し、例えばautoReconnect=trueのように、接続が中断後に自動的に再接続できることを確認します。
java.io.EOFException MESSAGE: Can not read response from server. Expected to read 819 bytes, read 686 bytes before connection was unexpectedly lost.
- 原因：MySQLによって接続がキルされた、またはMySQLがクラッシュした
- 解決策：MySQLに接続を能動的にキルするメカニズムがあるか、または大きなクエリがMySQLをクラッシュさせたかを確認する

その他の問題

MySQL emojiの読み書き時の文字化け

DorisがMySQLをクエリする際、MySQLのデフォルトのutf8エンコーディングはutf8mb3で、4バイトエンコーディングが必要なemojiを表現できません。ここでは、MySQLのエンコーディングをutf8mb4に変更して4バイトエンコーディングをサポートする必要があります。

設定項目をグローバルに変更できます

Modify the my.ini file in the mysql directory (for Linux systems, it is the my.cnf file in the etc directory)
[client]
default-character-set=utf8mb4

[mysql]
Set mysql default character set
default-character-set=utf8mb4

[mysqld]
Set mysql character set server
character-set-server=utf8mb4
collation-server=utf8mb4_unicode_ci
init_connect='SET NAMES utf8mb4

Modify the type of the corresponding table and column
ALTER TABLE table_name MODIFY colum_name VARCHAR(100) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
ALTER TABLE table_name CHARSET=utf8mb4;
SET NAMES utf8mb4

MySQL DATE/DATETIME型の読み取り時の例外

ERROR 1105 (HY000): errCode = 2, detailMessage = (10.16.10.6)[INTERNAL_ERROR]UdfRuntimeException: get next block failed: 
CAUSED BY: SQLException: Zero date value prohibited
CAUSED BY: DataReadException: Zero date value prohibited

JDBCでは、不正なDATE/DATETIMEはデフォルトで例外をスローすることによって処理されます。この動作はURLパラメータzeroDateTimeBehaviorによって制御できます。オプションパラメータは：exception、convertToNull、roundで、それぞれ：例外エラー；NULL値に変換；"0001-01-01 00:00:00"に変換です。

Catalogを作成する際に、jdbc_urlの末尾にあるJDBC接続文字列にzeroDateTimeBehavior=convertToNullを追加する必要があります。例："jdbc_url" = "jdbc:mysql://127.0.0.1:3306/test?zeroDateTimeBehavior=convertToNull"。この場合、JDBCは0000-00-00または0000-00-00 00:00:00をnullに変換し、その後DorisはそのCatalogのすべてのDate/DateTime型カラムをnullable型として処理するため、正常に読み取ることができます。

MySQL Catalogまたはその他のJDBC Catalogを読み取る際に、failed to load driver class com.mysql.cj.jdbc.driver in either of hikariconfig class loaderなどのクラスローディングエラーが発生する場合

これはCatalog作成時に記入したdriver_classが正しくないためであり、正しく記入する必要があります。上記の例は大文字小文字の問題で、'driver_class' = 'com.mysql.cj.jdbc.Driver'と記入する必要があります。
MySQLを読み取る際のCommunication link exception

ERROR 1105 (HY000): errCode = 2, detailMessage = PoolInitializationException: Failed to initialize pool: Communications link failure

The last packet successfully received from the server was 7 milliseconds ago.  The last packet sent successfully to the server was 4 milliseconds ago.
CAUSED BY: CommunicationsException: Communications link failure
    
The last packet successfully received from the server was 7 milliseconds ago.  The last packet sent successfully to the server was 4 milliseconds ago.
CAUSED BY: SSLHandshakeException

beのbe.outログを確認して、以下の情報が含まれているかチェックできます：

WARN: Establishing SSL connection without server's identity verification is not recommended. 
According to MySQL 5.5.45+, 5.6.26+ and 5.7.6+ requirements SSL connection must be established by default if explicit option isn't set. 
For compliance with existing applications not using SSL the verifyServerCertificate property is set to 'false'. 
You need either to explicitly disable SSL by setting useSSL=false, or set useSSL=true and provide truststore for server certificate verification.

jdbc_urlにuseSSL=falseを追加できます。例：'jdbc_url' = 'jdbc:mysql://127.0.0.1:3306/test?useSSL=false'

MySQLから大量のデータをクエリする際、クエリが時々成功し、時々以下のエラーが報告され、このエラーが発生すると、MySQLへのすべての接続が切断されてMySQL Serverに接続できなくなりますが、しばらくすると、MySQLは正常に戻りますが、以前の接続は失われています：
```
ERROR 1105 (HY000): errCode = 2, detailMessage = [INTERNAL_ERROR]UdfRuntimeException: JDBC executor sql has error:
CAUSED BY: CommunicationsException: Communications link failure
The last packet successfully received from the server was 4,446 milliseconds ago. The last packet sent successfully to the server was 4,446 milliseconds ago.
```

上記の現象が発生する場合、MySQL ServerのメモリまたはCPUリソースが不足し、MySQLサービスが利用できない状態になっている可能性があります。MySQL ServerのメモリまたはCPU設定を増加させることを試してください。

MySQLのクエリプロセス中に、クエリ結果がMySQLデータベース内の結果と一致しないことがわかった場合

まず、クエリフィールドで大文字小文字を区別する状況があるかどうか確認してください。例えば、Tableのフィールドc_1に"aaa"と"AAA"の2つのデータがある場合、MySQLデータベースが初期化時に大文字小文字を区別するよう指定されていないと、MySQLはデフォルトで大文字小文字を区別しませんが、Dorisは厳密に大文字小文字を区別するため、以下の状況が発生します：
```
MySQL behavior:
select count(c_1) from table where c_1 = "aaa"; Does not distinguish case, so the result is: 2

Doris behavior:
select count(c_1) from table where c_1 = "aaa"; Strictly distinguishes case, so the result is: 1
```

上記の現象が発生した場合、要件に応じて以下のように調整する必要があります：

MySQLクエリに"BINARY"キーワードを追加して大文字小文字の区別を強制する：select count(c_1) from table where BINARY c_1 = "aaa";
またはMySQLでTable作成時に指定する：CREATE TABLE table (c_1 VARCHAR(255) CHARACTER SET binary);

またはMySQLデータベース初期化時に大文字小文字を区別する照合順序ルールを指定する：

```text
[mysqld]
character-set-server=utf8
collation-server=utf8_bin
[client]
default-character-set=utf8
[mysql]
default-character-set=utf8
```

MySQLをクエリする際に、結果を返さずに長時間スタックする場合、または長時間スタックしてfe.warn.logに大量の書き込みロックログが表示される場合。

URLにsocketTimeoutを追加してみてください。例：jdbc:mysql://host:port/database?socketTimeout=30000。これにより、MySQLによって閉じられた後にJDBCクライアントが無期限に待機することを防げます。
MySQL Catalogの使用中に、FEのJVMメモリまたはThreads数が減少せずに継続的に増加し、同時にForward to master connection timed outエラーが報告される場合があります

FEスレッドスタックjstack fe_pid > fe.jsを出力し、大量のmysql-cj-abandoned-connection-cleanupスレッドが現れた場合、MySQL JDBCドライバの問題を示しています。

以下のように対処してください：
- MySQL JDBCドライバをバージョン8.0.31以上にアップグレードする
- FEとBEのconfファイルのJAVA_OPTSにパラメータ-Dcom.mysql.cj.disableAbandonedConnectionCleanup=trueを追加して、MySQL JDBCドライバのコネクションクリーンアップ機能を無効にし、クラスタを再起動する
  
  注意：DorisのバージョンがDoris 2.0.13以上、または2.1.5以上の場合、このパラメータを追加する必要はありません。DorisはデフォルトでMySQL JDBCドライバのコネクションクリーンアップ機能を無効にしているためです。MySQL JDBCドライバのバージョンを置き換えるだけで済みます。ただし、以前にリークしたスレッドをクリーンアップするためにDorisクラスタの再起動が必要です。

使用上の注意事項​

MySQLへの接続​

Connection Security​

階層マッピング​

カラム型マッピング​

付録​

タイムゾーンの問題​

よくある問題​

接続例外のトラブルシューティング​

その他の問題​