CREATE ROUTINE LOAD
この クイックスタート で Routine Load を試してみてください。
Routine Load は Apache Kafka® からメッセージを継続的に消費し、StarRocks にデータをロードできます。Routine Load は Kafka クラスターから CSV、JSON、Avro(v3.0.1 以降でサポート)データを消費し、plaintext、ssl、sasl_plaintext、sasl_ssl などの複数のセキュリティプロトコルを介して Kafka にアクセスできます。
このトピックでは、CREATE ROUTINE LOAD ステートメントの構文、パラメーター、および例について説明します。
- Routine Load の適用シナリオ、原則、および基本操作については、 Load data using Routine Load を参照してください。
- StarRocks テーブルにデータをロードす るには、その StarRocks テーブルに対して INSERT 権限を持つユーザーとしてのみ可能です。INSERT 権限を持っていない場合は、 GRANT の指示に従って、StarRocks クラスターに接続するために使用するユーザーに INSERT 権限を付与してください。
構文
CREATE ROUTINE LOAD <database_name>.<job_name> ON <table_name>
[load_properties]
[job_properties]
FROM data_source
[data_source_properties]
パラメーター
database_name, job_name, table_name
database_name
任意。StarRocks データベースの名前。
job_name
必須。Routine Load ジョブの名前。1 つのテーブルは複数の Routine Load ジョブからデータを受け取ることができます。識別可能な情報( 例: Kafka トピック名やジョブ作成時刻)を使用して、意味のある Routine Load ジョブ名を設定することをお勧めします。Routine Load ジョブの名前は同じデータベース内で一意である必要があります。
table_name
必須。データがロードされる StarRocks テーブルの名前。
load_properties
任意。データのプロパティ。構文:
[COLUMNS TERMINATED BY '<column_separator>'],
[ROWS TERMINATED BY '<row_separator>'],
[COLUMNS (<column1_name>[, <column2_name>, <column_assignment>, ... ])],
[WHERE <expr>],
[PARTITION (<partition1_name>[, <partition2_name>, ...])]
[TEMPORARY PARTITION (<temporary_partition1_name>[, <temporary_partition2_name>, ...])]
COLUMNS TERMINATED BY
CSV 形式データのカラム区切り文字。デフォルトのカラム区切り文字は \t(タブ)です。例えば、カラム区切り文字をカンマに指定するには COLUMNS TERMINATED BY "," を使用します。
- ここで指定したカラム区切り文字が、取り込むデータのカラム区切り文字と同じであることを確認してください。
- UTF-8 文字列(カンマ(,)、タブ、パイプ(|)など)をテキストデリミタとして使用できますが、長さは 50 バイトを超えないようにしてください。
- Null 値は
\Nを使用して示されます。例えば、データレコードが 3 つのカラムで構成されており、データレコードが最初と 3 番目のカラムにデータを保持しているが、2 番目のカラムにはデータを保持していない場合、この状況では 2 番目のカラムに\Nを使用して Null 値を示す必要があります。つまり、レコードはa,\N,bとしてコンパイルされる必要があり、a,,bではありません。a,,bはレコードの 2 番目のカラムが空の文字列を保持していることを示します。
ROWS TERMINATED BY
CSV 形式データの行区切り文字。デフォルトの行区切り文字は \n です。
COLUMNS
ソースデータのカラムと StarRocks テーブルのカラム間のマッピング。詳細については、このトピックの Column mapping を参照してください。
column_name: ソースデータのカラムが計算なしで StarRocks テーブルのカラムにマッピングできる場合、カラム名を指定するだけで済みます。これらのカラムはマップされたカラムと呼ばれます。column_assignment: ソースデータのカラムが直接 StarRocks テーブルのカラムにマッピングできない場合、データロード前に関数を使用してカラムの値を計算する必要があります。この場合、exprに計算関数を指定する必要があります。これらのカラムは派生カラムと呼ばれます。StarRocks は最初にマップされたカラムを解析するため、派生カラムはマップされたカラムの後に配置することをお勧めします。
WHERE
フィルター条件。フィルター条件を満たすデータのみが StarRocks にロードされます。例えば、col1 の値が 100 より大きく、col2 の値が 1000 と等しい行のみを取り込みたい場合、WHERE col1 > 100 and col2 = 1000 を使用できます。
フィルター条件で指定されたカラムは、ソースカラムまたは派生カラムであることができます。
PARTITION
StarRocks テーブルがパーティション p0、p1、p2、p3 に分散 されており、StarRocks にデータをロードする際に p1、p2、p3 のみにデータをロードし、p0 に保存されるデータをフィルタリングしたい場合、フィルター条件として PARTITION(p1, p2, p3) を指定できます。デフォルトでは、このパラメーターを指定しない場合、データはすべてのパーティションにロードされます。例:
PARTITION (p1, p2, p3)
TEMPORARY PARTITION
データをロードしたい temporary partition の名前。複数の一時パーティションを指定することができ、カンマ(,)で区切る必要があります。
job_properties
必須。ロードジョブのプロパティ。構文:
PROPERTIES ("<key1>" = "<value1>"[, "<key2>" = "<value2>" ...])
desired_concurrent_number
必須: いいえ
説明: 単一の Routine Load ジョブの期待されるタスク並行性。デフォルト値: 3。実際のタスク並行 性は、複数のパラメーターの最小値によって決定されます: min(alive_be_number, partition_number, desired_concurrent_number, max_routine_load_task_concurrent_num)。
alive_be_number: 生存している BE ノードの数。partition_number: 消費されるパーティションの数。desired_concurrent_number: 単一の Routine Load ジョブの期待されるタスク並行性。デフォルト値:3。max_routine_load_task_concurrent_num: Routine Load ジョブのデフォルトの最大タスク並行性で、5です。 FE dynamic parameter を参照してください。
max_batch_interval
必須: いいえ
説明: タスクのスケジューリング間隔、つまりタスクが実行される頻度。単位: 秒。値の範囲: 5 ~ 60。デフォルト値: 10。10 秒以上の値を設定することをお勧めします。スケジューリングが 10 秒未満の場合、ロード頻度が高すぎるために多くのタブレットバージョンが生成されます。
max_batch_rows
必須: いいえ
説明: このプロパティは、エラーデータ検出ウィンドウを定義するためにのみ使用されます。ウィンドウは、単一の Routine Load タスクによって消費されるデータ行数です。値は 10 * max_batch_rows です。デフォルト値は 10 * 200000 = 2000000 です。Routine Load タスクは、エラーデータ検出ウィンドウ内でエラーデータを検出します。エラーデータとは、StarRocks が解析できないデータを指します。たとえば、無効な JSON 形式のデータなどです。
max_error_number
必須: いいえ
説明: エラーデータ検出ウィンドウ内で許可されるエラーデータ行の最大数。この値を超えると、ロードジョブは一時停止します。 SHOW ROUTINE LOAD を実行し、ErrorLogUrls を使用してエラーログを表示できます。その後、エラーログに従って Kafka のエラーを修正できます。デフォルト値は 0 で、エラーデータ行は許可されません。
注意
- エラーデータ行が多すぎる場合、ロードジョブが一時停止する前に最後のバッチタスクは 成功 します。つまり、適格なデータはロードされ、不適格なデータはフィルタリングされます。あまりにも多くの不適格なデータ行をフィルタリングしたくない場合は、パラメーター
max_filter_ratioを 設定してください。 - エラーデータ行には、WHERE 句によってフィルタリングされたデータ行は含まれません。
- このパラメーターは、次のパラメーター
max_filter_ratioと共に、エラーデータレコードの最大数を制御します。max_filter_ratioが設定されていない場合、このパラメーターの値が有効になります。max_filter_ratioが設定されている場合、エラーデータレコードの数がこのパラメーターまたはmax_filter_ratioパラメーターで設定されたしきい値に達すると、ロードジョブは一時停止します。
max_filter_ratio
必須: いいえ
説明: ロードジョブの最大エラー許容度。エラー許容度は、ロードジョブによって要求されたすべてのデータレコードの中で、不適格なデータ品質のためにフィルタリングされる可能性のあるデータレコードの最大割合です。有効な値: 0 から 1。デフォルト値: 1(実際には効果を発揮しません)。0 に設定することをお勧めします。これにより、不適格なデータレコードが検出された場合、ロードジョブが一時停止し、データの正確性が確保されます。
不適格なデータレコードを無視したい場合は、このパラメーターを 0 より大きい値に設定できます。このようにすると、データファイルに不適格なデータレコードが含まれていても、ロードジョブは成功します。
注意
- エラーデータ行が
max_filter_ratioを超える場合、最後のバッチタスクは 失敗 します。これはmax_error_numberの効果とは 異なります。 - 不適格なデータレコードには、WHERE 句によってフィルタリングされたデータレコードは含まれません。
- このパラメーターは、前のパラメーター
max_error_numberと共に、エラーデータレコードの最大数を制御します。このパラメーターが設定されていない場合(max_filter_ratio = 1と同じように動作します)、max_error_numberパラメーターの値が有効になります。このパラメーターが設定されている場合、エラーデータレコードの数がこのパラメーターまたはmax_error_numberパラメーターで設定されたしきい値に達すると、ロードジョブは一時停止します。
strict_mode
必須: いいえ
説明: strict mode を有効にするかどうかを指定します。有効な値: true と false。デフォルト値: false。strict mode が有効な場合、ロードされたデータのカラムの値が NULL であり、ターゲットテーブルがこのカラムに NULL 値を許可しない場合、データ行はフィルタリングされます。
log_rejected_record_num
必須: いいえ
説明: ログに記録できる不適格なデータ行の最大数を指定します。このパラメーターは v3.1 以降でサポートされています。有効な値: 0、-1、および任意の非ゼロの正の整数。デフォルト値: 0。
- 値
0は、フィルタリングされたデータ行がログに記録されないことを指定します。 - 値
-1は、フィルタリングされたすべてのデータ行がログに記録されることを指定します。 - 非ゼロの正の整数
nは、各 BE でフィルタリングされた最大n行のデータ行がログに記録されることを指定します。
information_schema.loads ビューに対するクエリから返された REJECTED_RECORD_PATH フィールドのパスに移動します。
timezone
必須: いいえ
説明: ロードジョブで使用されるタイムゾーン。デフォルト値: Asia/Shanghai。このパラメーターの値は、strftime()、alignment_timestamp()、from_unixtime() などの関数によって返される結果に影響を与えます。このパラメーターで指定されたタイムゾーンは、セッションレベルのタイムゾーンです。詳細については、 Configure a time zone を参照してください。
partial_update
必須: いいえ
説明: 部分更新を使用するかどうか。 有効な値: TRUE と FALSE。デフォルト値: FALSE、この機能を無効にすることを示します。
merge_condition
必須: いいえ
説明: データを更新するかどうかを判断する条件として使用するカラムの名前を指定します。このカラムにロードされるデータの値がこのカラムの現在の値以上の場合にのみデータが更新されます。 注意
条件付き更新をサポートするのは主キーテーブルのみです。指定するカラムは主キーのカラムであってはなりません。
format
必須: いいえ
説明: ロードするデータの形式。 有効な値: CSV、JSON、および Avro(v3.0.1 以降でサポート)。デフォルト値: CSV。
trim_space
必須: いいえ
説明: データファイルが CSV 形式の場合、カラムセパレーターの前後のスペースを削除するかどうかを指定します。タイプ: BOOLEAN。デフォルト値: false。
一部のデータベースでは、データを CSV 形式のデータファイルとしてエクスポートする際に、カラムセパレーターにスペースが追加されます。これらのスペースは、その位置に応じて先行スペースまたは後続スペースと呼ばれます。trim_space パラメーターを設定することで、StarRocks がデータロード中にこれらの不要なスペースを削除するようにできます。
StarRocks は、enclose で指定された文字で囲まれたフィールド内のスペース(先行スペースおよび後続スペースを含む)を削除しないことに注意してください。たとえば、次のフィールド値は、カラムセパレーターとしてパイプ (|) を使用し、enclose で指定された文字として二重引用符 (") を使用しています: | "Love StarRocks" |。trim_space を true に設定すると、StarRocks は前述のフィールド値を |"Love StarRocks"| として処理します。
enclose
必須: いいえ
説明: データファイルが CSV 形式の場合、 RFC4180 に従ってフィールド値を囲むために使用される文字を指定します。タイプ: 単一バイト文字。デフォルト値: NONE。最も一般的な文字は単一引用符 (') と二重引用符 (") です。enclose で指定された文字で囲まれたすべての特殊文字(行セパレーターやカラムセパレーターを含む)は通常の記号と見なされます。StarRocks は、enclose で指定された文字として任意の単一バイト文字を指定できるため、RFC4180 よりも多くのことができます。
フィールド値に enclose で指定された文字が含まれている場合、同じ文字を使用してその enclose で指定された文字をエスケープできます。たとえば、enclose を " に設定し、フィールド値が a "quoted" c である場合、データファイルにフィールド値を "a ""quoted"" c" として入力できます。
escape
必須: いいえ
説明: 行セパレーター、カラムセパレーター、エスケープ文字、enclose で指定された文字などのさまざまな特殊文字をエスケープするために使用される文字を指定します。これらは StarRocks によって通常の文字と見なされ、それらが存在するフィールド値の一部として解析されます。タイプ: 単一バイト文字。デフォルト値: NONE。最も一般的な文字はスラッシュ (\) で、SQL ステートメントではダブルスラッシュ (\\) として書く必要があります。
注意escape で指定された文字は、各ペアの enclose で指定された文字の内側と外側の両方に適用されます。
次の 2 つの例を示します:
encloseを"に設定し、escapeを\に設定すると、StarRocks は"say \"Hello world\""をsay "Hello world"に解析します。- カラムセパレーターがカンマ(
,)であると仮定します。escapeを\に設定すると、StarRocks はa, b\, cを 2 つの別々のフィールド値に解析します:aとb, c。
strip_outer_array
必須: いいえ
説明: JSON 形式のデータの最外部の配列構造を削除するかどうかを指定します。有効な値: true と false。デフォルト値: false。実際のビジネスシナリオでは、JSON 形式のデータには [] で示される最外部の配列構造がある場合があります。この状況では、このパラメーターを true に設定することをお勧めします。これにより、StarRocks は最外部の角括弧 [] を削除し、各内部配列を個別のデータレコードとしてロードします。このパラメーターを false に設定すると、StarRocks は JSON 形式のデータ全体を 1 つの配列として解析し、その配列を単一のデータレコードとしてロー ドします。JSON 形式のデータ [{"category" : 1, "author" : 2}, {"category" : 3, "author" : 4} ] を例として使用します。このパラメーターを true に設定すると、{"category" : 1, "author" : 2} と {"category" : 3, "author" : 4} は 2 つの別々のデータレコードとして解析され、2 つの StarRocks データ行にロードされます。
jsonpaths
必須: いいえ
説明: JSON 形式のデータからロードしたいフィールドの名前。このパラメーターの値は有効な JsonPath 式です。詳細については、 StarRocks table contains derived columns whose values are generated by using expressions を参照してください。
json_root
必須: いいえ
説明: ロードする JSON 形式のデータのルート要素。StarRocks は json_root を通じてルートノードの要素を抽出して解析します。デフォルトでは、このパラメーターの値は空であり、すべての JSON 形式のデータがロードされることを示します。詳細については、 Specify the root element of the JSON-formatted data to be loaded を参照して ください。
task_consume_second
必須: いいえ
説明: 指定された Routine Load ジョブ内の各 Routine Load タスクがデータを消費する最大時間。単位: 秒。 FE dynamic parameters routine_load_task_consume_second(クラスター内のすべての Routine Load ジョブに適用される)とは異なり、このパラメーターは個々の Routine Load ジョブに特有であり、より柔軟です。このパラメーターは v3.1.0 以降でサポートされています。
task_consume_secondとtask_timeout_secondが設定されていない場合、StarRocks は FE 動的パラメーターroutine_load_task_consume_secondとroutine_load_task_timeout_secondを使用してロード動作を制御します。task_consume_secondのみが設定されている場合、task_timeout_secondのデフォルト値はtask_consume_second* 4 として計算されます。task_timeout_secondのみが設定されている場合、task_consume_secondのデフォルト値はtask_timeout_second/4 として計算されます。
task_timeout_second
必須: いいえ
説明: 指定された Routine Load ジ ョブ内の各 Routine Load タスクのタイムアウト期間。単位: 秒。 FE dynamic parameter routine_load_task_timeout_second(クラスター内のすべての Routine Load ジョブに適用される)とは異なり、このパラメーターは個々の Routine Load ジョブに特有であり、より柔軟です。このパラメーターは v3.1.0 以降でサポートされています。
task_consume_secondとtask_timeout_secondが設定されていない場合、StarRocks は FE 動的パラメーターroutine_load_task_consume_secondとroutine_load_task_timeout_secondを使用してロード動作を制御します。task_timeout_secondのみが設定されている場合、task_consume_secondのデフォルト値はtask_timeout_second/4 として計算されます。task_consume_secondのみが設定されている場合、task_timeout_secondのデフォルト値はtask_consume_second* 4 として計算されます。
pause_on_fatal_parse_error
必須: いいえ
説明: 回復不能なデータ解析エラーに遭遇した際にジョブを自動的に一時停止するかどうかを指定します。有効な値: true と false。デフォルト値: false。このパラメーターは v3.3.12/v3.4.2 以降でサポートされています。
このような解析エラーは通常、不正なデータ形式によって引き起こさ れます。例:
strip_outer_arrayを設定せずに JSON 配列をインポートする。- JSON データをインポートするが、Kafka メッセージに不正な JSON が含まれている(例:
abcd)。
data_source, data_source_properties
必須。データソースと関連するプロパティ。
FROM <data_source>
("<key1>" = "<value1>"[, "<key2>" = "<value2>" ...])
data_source
必須。ロードしたいデータのソース。有効な値: KAFKA。
data_source_properties
データソースのプロパティ。
kafka_broker_list
必須: はい
説明: Kafka のブローカー接続情報。形式は <kafka_broker_ip>:<broker_port> です。複数のブローカーはカンマ(,)で区切られます。Kafka ブローカーが使用するデフォルトのポートは 9092 です。例: "kafka_broker_list" = ""xxx.xx.xxx.xx:9092,xxx.xx.xxx.xx:9092"。
kafka_topic
必須: はい
説明: 消費する Kafka トピック。Routine Load ジョブは 1 つのトピックからのみメッセージを消費できます。
kafka_partitions
必須: いいえ
説明: 消費する Kafka パーティション。例: "kafka_partitions" = "0, 1, 2, 3"。このプロパティが指定されていない場合、デフォルトですべてのパーティションが消費されます。
kafka_offsets
必須: いいえ
説明: kafka_partitions で指定された Kafka パーティションでデータを消費し始めるオフセット。指定されていない場合、Routine Load ジョブは kafka_partitions の最新のオフセットからデータを消費します。有効な値:
- 特定のオフセット: 特定のオフセットからデータを消費します。
OFFSET_BEGINNING: 最も早いオフセットからデータを消費します。OFFSET_END: 最新のオフセットからデータを消費します。
"kafka_offsets" = "1000, OFFSET_BEGINNING, OFFSET_END, 2000"。
property.kafka_default_offsets
必須: いいえ
説明: すべての消費者パーティションのデフォルトの開始オフセット。このプロパティのサポートされる値は kafka_offsets プロパティと同じです。
confluent.schema.registry.url
必須: いいえ
説明: Avro スキーマが登録されている Schema Registry の URL。StarRocks はこの URL を使用して Avro スキーマを取得します。形式は次のとおりです:confluent.schema.registry.url = http[s]://[<schema-registry-api-key>:<schema-registry-api-secret>@]<hostname or ip address>[:<port>]
データソース関連のプロパティの詳細
Kafka に関連する追加のデータソースプロパティを指定できます。これらは Kafka コマンドラインの --property を使用するのと同等です。サポートされているプロパティの詳細については、 librdkafka configuration properties の Kafka コンシューマークライアントのプロパティを参照してください。
プロパティの値がファイル名である場合、ファイル名の前にキーワード FILE: を追加してください。ファイルの作成方法については、 CREATE FILE を参照してください。
- 消費するすべてのパーティションのデフォルトの初期オフセットを指定する
"property.kafka_default_offsets" = "OFFSET_BEGINNING"
- Routine Load ジョブで使用されるコンシューマーグループの ID を指定する
"property.group.id" = "group_id_0"
property.group.id が指定されていない場合、StarRocks は Routine Load ジョブの名前に基づいてランダムな値を生成します。形式は {job_name}_{random uuid} です。例: simple_job_0a64fe25-3983-44b2-a4d8-f52d3af4c3e8。
-
BE が Kafka にアクセスするために使用するセキュリティプロトコルと関連するパラメーターを指定する
セキュリティプロトコルは
plaintext(デフォルト)、ssl、sasl_plaintext、またはsasl_sslとして指定できます。指定されたセキュリティプロトコルに応じて関連するパラメーターを設定する必要があります。セキュリティプロトコルが
sasl_plaintextまたはsasl_sslに設定されている場合、次の SASL 認証メカニズムがサポートされます:- PLAIN
- SCRAM-SHA-256 および SCRAM-SHA-512
- OAUTHBEARER
- GSSAPI (Kerberos)
例:
-
SSL セキュリティプロトコルを使用して Kafka にアクセスする:
"property.security.protocol" = "ssl", -- セキュリティプロトコルを SSL として指定します。
"property.ssl.ca.location" = "FILE:ca-cert", -- Kafka ブローカーのキーを検証するための CA 証明書のファイルまたはディレクトリパス。
-- Kafka サーバーがクライアント認証を有効にしている場合、次の 3 つのパラメーターも必要です:
"property.ssl.certificate.location" = "FILE:client.pem", -- 認証に使用されるクライアントの公開鍵のパス。
"property.ssl.key.location" = "FILE:client.key", -- 認証に使用されるクライアントの秘密鍵のパス。
"property.ssl.key.password" = "xxxxxx" -- クライアントの秘密鍵のパスワード。 -
SASL_PLAINTEXT セキュリティプロトコルと SASL/PLAIN 認証メカニズムを使用して Kafka にアクセスする:
"property.security.protocol" = "SASL_PLAINTEXT", -- セキュリティプロトコルを SASL_PLAINTEXT として指定します。
"property.sasl.mechanism" = "PLAIN", -- SASL メカニズムを PLAIN として指定します。これは単純なユーザー名/パスワード認証メカニズムです。
"property.sasl.username" = "admin", -- SASL ユーザー名。
"property.sasl.password" = "xxxxxx" -- SASL パスワード。 -
SASL_PLAINTEXT セキュリティプロトコルと SASL/GSSAPI (Kerberos) 認証メカニズムを使用して Kafka にアクセスする:
"property.security.protocol" = "SASL_PLAINTEXT", -- セキュリティプロトコルを SASL_PLAINTEXT として指定します。
"property.sasl.mechanism" = "GSSAPI", -- SASL 認証メカニズムを GSSAPI として指定します。デフォルト値は GSSAPI です。
"property.sasl.kerberos.service.name" = "kafka", -- ブローカーサービス名。デフォルト値は kafka です。
"property.sasl.kerberos.keytab" = "/home/starrocks/starrocks.keytab", -- クライアントキータブの場所。
"property.sasl.kerberos.principal" = "starrocks@YOUR.COM" -- Kerberos プリンシパル。注記-
StarRocks v3.1.4 以降、SASL/GSSAPI (Kerberos) 認証がサポートされています。
-
SASL 関連のモジュールは BE マシンにインストールする必要があります。
# Debian/Ubuntu:
sudo apt-get install libsasl2-modules-gssapi-mit libsasl2-dev
# CentOS/Redhat:
sudo yum install cyrus-sasl-gssapi cyrus-sasl-devel
-
FE と BE の設定項目
Routine Load に関連する FE と BE の設定項目については、 configuration items を参照してください。