MySQL JDBC カタログ

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

JDBC カタログの概要については、以下を参照してください：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の場合、sslModeパラメータを使用してTLS経由で接続を保護します。デフォルトでは、このパラメータは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
Catalog	MySQL Server
Database	Database
Table	Table

カラム型マッピング

MySQL Type	Doris Type	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型は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をクラッシュさせたかを確認してください

その他の問題

1. MySQL絵文字の読み書き時の文字化け

   DorisがMySQLにクエリを実行する際、MySQLのデフォルトutf8エンコーディングはutf8mb3で、4バイトエンコーディングが必要な絵文字を表現できません。ここでは、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

2. 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型として処理するため、正常に読み取ることができます。

3. 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'として入力すべきです。

4. 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でテーブル作成時に指定する：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 メモリや Thread 数が継続的に増加し、減少しない場合、同時に 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 のバージョンが 2.0.13 以上、または 2.1.5 以上の場合、このパラメータを追加する必要はありません。Doris はデフォルトで MySQL JDBC ドライバの接続クリーンアップ機能を無効にしているためです。MySQL JDBC ドライバのバージョンを置き換えるだけで十分です。ただし、以前にリークしたスレッドをクリーンアップするには、Doris クラスタの再起動が必要です。