STREAM LOAD

Description

StarRocks は、HTTP ベースの Stream Load というロード方法を提供しており、ローカルファイルシステムやストリーミングデータソースからデータをロードするのに役立ちます。ロードジョブを送信すると、StarRocks はジョブを同期的に実行し、ジョブが終了した後にその結果を返します。ジョブ結果に基づいて、ジョブが成功したかどうかを判断できます。Stream Load の適用シナリオ、制限、原則、サポートされるデータファイル形式については、 Loading from a local file system via Stream Load を参照してください。

Stream Load 操作は、StarRocks テーブルにデータをロードするだけでなく、テーブル上に作成されたマテリアライズドビューのデータも更新することに注意してください。

Syntax

curl --location-trusted -u <username>:<password> -XPUT <url>
(
    data_desc
)
[opt_properties]        

このトピックでは、curl を例として使用して、Stream Load を使用してデータをロードする方法を説明します。curl に加えて、他の HTTP 互換ツールや言語を使用して Stream Load を実行することもできます。ロード関連のパラメータは HTTP リクエストヘッダーフィールドに含まれています。これらのパラメータを入力する際には、次の点に注意してください。

• このトピックで示されているように、チャンク転送エンコーディングを使用できます。チャンク転送エンコーディングを選択しない場合は、Content-Length ヘッダーフィールドを入力して転送するコンテンツの長さを示し、データの整合性を確保する必要があります。

  NOTE

  curl を使用して Stream Load を実行する場合、StarRocks は自動的に Content-Length ヘッダーフィールドを追加するため、手動で入力する必要はありません。

• Expect ヘッダーフィールドを追加し、その値を 100-continue として指定する必要があります。これは、ジョブリクエストが拒否された場合に不要なデータ転送を防ぎ、リソースのオーバーヘッドを削減するのに役立ちます。

StarRocks では、いくつかのリテラルが SQL 言語によって予約キーワードとして使用されていることに注意してください。これらのキーワードを SQL ステートメントで直接使用しないでください。SQL ステートメントでそのようなキーワードを使用したい場合は、バッククォート (`) で囲んでください。 Keywords を参照してください。

Parameters

username and password

StarRocks クラスターに接続するために使用するアカウントのユーザー名とパスワードを指定します。これは必須のパラメータです。パスワードが設定されていないアカウントを使用する場合は、<username>: のみを入力する必要があります。

XPUT

HTTP リクエストメソッドを指定します。これは必須のパラメータです。Stream Load は PUT メソッドのみをサポートします。

url

StarRocks テーブルの URL を指定します。構文:

http://<fe_host>:<fe_http_port>/api/<database_name>/<table_name>/_stream_load

次の表は、URL 内のパラメータを説明しています。

Parameter	Required	Description
fe_host	Yes	StarRocks クラスター内の FE ノードの IP アドレス。 NOTE 特定の BE ノードにロードジョブを送信する場合は、BE ノードの IP アドレスを入力する必要があります。
fe_http_port	Yes	StarRocks クラスター内の FE ノードの HTTP ポート番号。デフォルトのポート番号は 8030 です。 NOTE 特定の BE ノードにロードジョブを送信する場合は、BE ノードの HTTP ポート番号を入力する必要があります。デフォルトのポート番号は 8030 です。
database_name	Yes	StarRocks テーブルが属するデータベースの名前。
table_name	Yes	StarRocks テーブルの名前。

data_desc

ロードしたいデータファイルを説明します。data_desc ディスクリプタには、データファイルの名前、形式、カラムセパレータ、行セパレータ、宛先パーティション、および StarRocks テーブルに対するカラムマッピングを含めることができます。構文:

-T <file_path>
-H "format: CSV | JSON"
-H "column_separator: <column_separator>"
-H "row_delimiter: <row_delimiter>"
-H "columns: <column1_name>[, <column2_name>, ... ]"
-H "partitions: <partition1_name>[, <partition2_name>, ...]"
-H "temporary_partitions: <temporary_partition1_name>[, <temporary_partition2_name>, ...]"
-H "jsonpaths: [ \"<json_path1>\"[, \"<json_path2>\", ...] ]"
-H "strip_outer_array:  true | false"
-H "json_root: <json_path>"

data_desc ディスクリプタのパラメータは、共通パラメータ、CSV パラメータ、および JSON パラメータの 3 種類に分けられます。

Common parameters

Parameter	Required	Description
file_path	Yes	データファイルの保存パス。ファイル名の拡張子を含めることができます。
format	No	データファイルの形式。有効な値: CSV および JSON。デフォルト値: CSV。
partitions	No	データファイルをロードしたいパーティション。デフォルトでは、このパラメータを指定しない場合、StarRocks はデータファイルを StarRocks テーブルのすべてのパーティションにロードします。
temporary_partitions	No	データファイルをロードしたい temporary partition の名前。複数の一時パーティションを指定する場合は、カンマ (,) で区切る必要があります。
columns	No	データファイルと StarRocks テーブル間のカラムマッピング。 データファイル内のフィールドが StarRocks テーブル内のカラムに順番にマッピングできる場合、このパラメータを指定する必要はありません。代わりに、このパラメータを使用してデータ変換を実装できます。たとえば、CSV データファイルをロードし、ファイルが id および city の 2 つのカラムに順番にマッピングできる 2 つのカラムで構成されている場合、"columns: city,tmp_id, id = tmp_id * 100" と指定できます。詳細については、このトピックの「Column mapping」セクションを参照してください。

CSV parameters

Parameter	Required	Description
column_separator	No	データファイル内でフィールドを区切るために使用される文字。指定しない場合、このパラメータはデフォルトで \t（タブ）になります。 このパラメータを使用して指定したカラムセパレータがデータファイルで使用されているカラムセパレータと同じであることを確認してください。 NOTE CSV データの場合、カンマ（,）、タブ、またはパイプ（|）などの UTF-8 文字列をテキストデリミタとして使用できますが、その長さは 50 バイトを超えてはなりません。
row_delimiter	No	データファイル内で行を区切るために使用される文字。指定しない場合、このパラメータはデフォルトで \n になります。

NOTE

• CSV データの場合、カンマ（,）、タブ、またはパイプ（|）などの UTF-8 文字列をテキストデリミタとして使用できますが、その長さは 50 バイトを超えてはなりません。
• Null 値は \N を使用して示されます。たとえば、データファイルが 3 つのカラムで構成され、そのデータファイルのレコードが最初と 3 番目のカラムにデータを保持し、2 番目のカラムにデータがない場合、この状況では 2 番目のカラムに \N を使用して null 値を示す必要があります。つまり、レコードは a,\N,b としてコンパイルされる必要があり、a,,b ではありません。a,,b は、レコードの 2 番目のカラムが空の文字列を保持していることを示します。

JSON parameters

Parameter	Required	Description
jsonpaths	No	JSON データファイルからロードしたいキーの名前。マッチモードを使用して JSON データをロードする場合にのみ、このパラメータを指定する必要があります。このパラメータの値は JSON 形式です。 Configure column mapping for JSON data loading を参照してください。
strip_outer_array	No	最外部の配列構造を削除するかどうかを指定します。有効な値: true および false。デフォルト値: false。 実際のビジネスシナリオでは、JSON データは [] で示される最外部の配列構造を持つ場合があります。この状況では、このパラメータを true に設定することをお勧めします。これにより、StarRocks は最外部の [] を削除し、各内部配列を個別のデータレコードとしてロードします。このパラメータを false に設定すると、StarRocks は JSON データファイル全体を 1 つの配列として解析し、その配列を 1 つのデータレコードとしてロードします。 たとえば、JSON データが [ {"category" : 1, "author" : 2}, {"category" : 3, "author" : 4} ] の場合、このパラメータを true に設定すると、{"category" : 1, "author" : 2} と {"category" : 3, "author" : 4} が個別のデータレコードに解析され、個別の StarRocks テーブル行にロードされます。
json_root	No	JSON データファイルからロードしたい JSON データのルート要素。マッチモードを使用して JSON データをロードする場合にのみ、このパラメータを指定する必要があります。このパラメータの値は有効な JsonPath 文字列です。デフォルトでは、このパラメータの値は空であり、JSON データファイルのすべてのデータがロードされることを示します。詳細については、このトピックの「Load JSON data using matched mode with root element specified」セクションを参照してください。
ignore_json_size	No	HTTP リクエスト内の JSON 本体のサイズをチェックするかどうかを指定します。 NOTE デフォルトでは、HTTP リクエスト内の JSON 本体のサイズは 100 MB を超えることはできません。JSON 本体が 100 MB を超える場合、エラー "The size of this batch exceed the max size [104857600] of json type data data [8617627793]. Set ignore_json_size to skip check, although it may lead huge memory consuming." が報告されます。このエラーを防ぐために、HTTP リクエストヘッダーに "ignore_json_size:true" を追加して、StarRocks に JSON 本体のサイズをチェックしないように指示できます。

JSON データをロードする場合、各 JSON オブジェクトのサイズが 4 GB を超えることはできないことにも注意してください。JSON データファイル内の個々の JSON オブジェクトが 4 GB を超える場合、エラー "This parser can't support a document that big." が報告されます。

opt_properties

ロードジョブ全体に適用されるいくつかのオプションパラメータを指定します。構文:

-H "label: <label_name>"
-H "where: <condition1>[, <condition2>, ...]"
-H "max_filter_ratio: <num>"
-H "timeout: <num>"
-H "strict_mode: true | false"
-H "timezone: <string>"
-H "load_mem_limit: <num>"
-H "merge_condition: <column_name>"

次の表は、オプションパラメータを説明しています。

Parameter	Required	Description
label	No	ロードジョブのラベル。このパラメータを指定しない場合、StarRocks はロードジョブに対して自動的にラベルを生成します。 StarRocks は、1 つのラベルを使用してデータバッチを複数回ロードすることを許可しません。そのため、StarRocks は同じデータが繰り返しロードされるのを防ぎます。ラベルの命名規則については、 System limits を参照してください。 デフォルトでは、StarRocks は、直近 3 日間に正常に完了したロードジョブのラベルを保持します。 FE parameter label_keep_max_second を使用して、ラベルの保持期間を変更できます。
where	No	StarRocks が事前処理されたデータをフィルタリングする条件。StarRocks は、WHERE 句で指定されたフィルタ条件を満たす事前処理されたデータのみをロードします。
max_filter_ratio	No	ロードジョブの最大エラー許容度。エラー許容度は、ロードジョブによって要求されたすべてのデータレコードの中で、不十分なデータ品質のためにフィルタリングされるデータレコードの最大割合です。有効な値: 0 から 1。デフォルト値: 0。 デフォルト値 0 を保持することをお勧めします。これにより、不適格なデータレコードが検出された場合、ロードジョブが失敗し、データの正確性が確保されます。 不適格なデータレコードを無視したい場合は、このパラメータを 0 より大きい値に設定できます。これにより、データファイルに不適格なデータレコードが含まれていても、ロードジョブが成功することができます。 NOTE 不適格なデータレコードには、WHERE 句によってフィルタリングされたデータレコードは含まれません。
timeout	No	ロードジョブのタイムアウト期間。有効な値: 1 から 259200。単位: 秒。デフォルト値: 600。 NOTE ロードジョブのタイムアウト期間を集中管理するために、 FE parameter stream_load_default_timeout_second を使用することもできます。timeout パラメータを指定した場合、timeout パラメータで指定されたタイムアウト期間が優先されます。timeout パラメータを指定しない場合、stream_load_default_timeout_second パラメータで指定されたタイムアウト期間が優先されます。
strict_mode	No	strict mode を有効にするかどうかを指定します。有効な値: true および false。デフォルト値: false。値 true はストリクトモードを有効にし、値 false はストリクトモードを無効にします。
timezone	No	ロードジョブで使用されるタイムゾーン。デフォルト値: Asia/Shanghai。このパラメータの値は、strftime、alignment_timestamp、from_unixtime などの関数によって返される結果に影響を与えます。このパラメータで指定されたタイムゾーンは、セッションレベルのタイムゾーンです。詳細については、 Configure a time zone を参照してください。
load_mem_limit	No	ロードジョブにプロビジョニングできる最大メモリ量。単位: バイト。デフォルトでは、ロードジョブの最大メモリサイズは 2 GB です。このパラメータの値は、各 BE にプロビジョニングできる最大メモリ量を超えることはできません。
merge_condition	No	更新が有効になるかどうかを判断するために使用したいカラムの名前を指定します。ソースレコードからデスティネーションレコードへの更新は、指定されたカラムでソースデータレコードがデスティネーションデータレコードよりも大きいか等しい値を持つ場合にのみ有効になります。StarRocks は v2.5 以降で条件付き更新をサポートしています。詳細については、 Change data through loading を参照してください。 NOTE 指定するカラムは主キーのカラムであってはなりません。また、条件付き更新をサポートするのは、主キーテーブルを使用するテーブルのみです。

Column mapping

Configure column mapping for CSV data loading

データファイルのカラムが StarRocks テーブルのカラムに順番に 1 対 1 でマッピングできる場合、データファイルと StarRocks テーブル間のカラムマッピングを構成する必要はありません。

データファイルのカラムが StarRocks テーブルのカラムに順番に 1 対 1 でマッピングできない場合、columns パラメータを使用してデータファイルと StarRocks テーブル間のカラムマッピングを構成する必要があります。これには次の 2 つのユースケースが含まれます。

• 同じ数のカラムだが異なるカラムの順序。 また、データファイルからのデータは、対応する StarRocks テーブルのカラムにロードされる前に関数によって計算される必要はありません。

  columns パラメータでは、データファイルのカラムが配置されている順序と同じ順序で StarRocks テーブルのカラム名を指定する必要があります。

  たとえば、StarRocks テーブルは col1、col2、col3 の順に 3 つのカラムで構成され、データファイルも 3 つのカラムで構成され、StarRocks テーブルのカラム col3、col2、col1 に順番にマッピングできます。この場合、"columns: col3, col2, col1" と指定する必要があります。

• 異なる数のカラムと異なるカラムの順序。また、データファイルからのデータは、対応する StarRocks テーブルのカラムにロードされる前に関数によって計算される必要があります。

  columns パラメータでは、データファイルのカラムが配置されている順序と同じ順序で StarRocks テーブルのカラム名を指定し、データを計算するために使用したい関数を指定する必要があります。次の 2 つの例があります。

  • StarRocks テーブルは col1、col2、col3 の順に 3 つのカラムで構成されています。データファイルは 4 つのカラムで構成されており、そのうち最初の 3 つのカラムは StarRocks テーブルのカラム col1、col2、col3 に順番にマッピングでき、4 番目のカラムは StarRocks テーブルのカラムにマッピングできません。この場合、データファイルの 4 番目のカラムに一時的な名前を指定する必要があり、その一時的な名前は StarRocks テーブルのカラム名とは異なる必要があります。たとえば、"columns: col1, col2, col3, temp" と指定できます。この場合、データファイルの 4 番目のカラムは一時的に temp と名付けられます。
  • StarRocks テーブルは year、month、day の順に 3 つのカラムで構成されています。データファイルは yyyy-mm-dd hh:mm:ss 形式の日付と時刻の値を含む 1 つのカラムのみで構成されています。この場合、"columns: col, year = year(col), month=month(col), day=day(col)" と指定できます。この場合、col はデータファイルのカラムの一時的な名前であり、関数 year = year(col)、month=month(col)、day=day(col) はデータファイルのカラム col からデータを抽出し、対応する StarRocks テーブルのカラムにデータをロードするために使用されます。たとえば、year = year(col) はデータファイルのカラム col から yyyy データを抽出し、StarRocks テーブルのカラム year にデータをロードするために使用されます。

詳細な例については、 Configure column mapping を参照してください。

Configure column mapping for JSON data loading

JSON ドキュメントのキーが StarRocks テーブルのカラムと同じ名前を持つ場合、シンプルモードを使用して JSON 形式のデータをロードできます。シンプルモードでは、jsonpaths パラメータを指定する必要はありません。このモードでは、JSON 形式のデータは {} で示されるオブジェクトである必要があります。たとえば、{"category": 1, "author": 2, "price": "3"} のように。この例では、category、author、price はキー名であり、これらのキーは名前によって StarRocks テーブルのカラム category、author、price に 1 対 1 でマッピングできます。

JSON ドキュメントのキーが StarRocks テーブルのカラムと異なる名前を持つ場合、マッチモードを使用して JSON 形式のデータをロードできます。マッチモードでは、jsonpaths および COLUMNS パラメータを使用して JSON ドキュメントと StarRocks テーブル間のカラムマッピングを指定する必要があります。

• jsonpaths パラメータでは、JSON ドキュメント内で配置されている順序で JSON キーを指定します。
• COLUMNS パラメータでは、JSON キーと StarRocks テーブルのカラム間のマッピングを指定します。
  • COLUMNS パラメータで指定されたカラム名は、JSON キーに順番に 1 対 1 でマッピングされます。
  • COLUMNS パラメータで指定されたカラム名は、名前によって StarRocks テーブルのカラムに 1 対 1 でマッピングされます。

マッチモードを使用して JSON 形式のデータをロードする例については、 Load JSON data using matched mode を参照してください。

Return value

ロードジョブが終了すると、StarRocks はジョブ結果を JSON 形式で返します。例:

{
    "TxnId": 1003,
    "Label": "label123",
    "Status": "Success",
    "Message": "OK",
    "NumberTotalRows": 1000000,
    "NumberLoadedRows": 999999,
    "NumberFilteredRows": 1,
    "NumberUnselectedRows": 0,
    "LoadBytes": 40888898,
    "LoadTimeMs": 2144,
    "BeginTxnTimeMs": 0,
    "StreamLoadPutTimeMS": 1,
    "ReadDataTimeMs": 0,
    "WriteDataTimeMs": 11,
    "CommitAndPublishTimeMs": 16,
}

次の表は、返されたジョブ結果のパラメータを説明しています。

Parameter	Description
TxnId	ロードジョブのトランザクション ID。
Label	ロードジョブのラベル。
Status	ロードされたデータの最終ステータス。 Success: データが正常にロードされ、クエリ可能です。 Publish Timeout: ロードジョブが正常に送信されましたが、データはまだクエリできません。データを再ロードする必要はありません。 Label Already Exists: ロードジョブのラベルが別のロードジョブに使用されています。データは正常にロードされたか、ロード中である可能性があります。 Fail: データのロードに失敗しました。ロードジョブを再試行できます。
Message	ロードジョブのステータス。ロードジョブが失敗した場合、詳細な失敗原因が返されます。
NumberTotalRows	読み取られたデータレコードの総数。
NumberLoadedRows	正常にロードされたデータレコードの総数。このパラメータは、Status の値が Success の場合にのみ有効です。
NumberFilteredRows	データ品質が不十分なためにフィルタリングされたデータレコードの数。
NumberUnselectedRows	WHERE 句によってフィルタリングされたデータレコードの数。
LoadBytes	ロードされたデータの量。単位: バイト。
LoadTimeMs	ロードジョブにかかる時間。単位: ミリ秒。
BeginTxnTimeMs	ロードジョブのトランザクションを実行するのにかかる時間。
StreamLoadPutTimeMS	ロードジョブの実行計画を生成するのにかかる時間。
ReadDataTimeMs	ロードジョブのデータを読み取るのにかかる時間。
WriteDataTimeMs	ロードジョブのデータを書き込むのにかかる時間。
CommitAndPublishTimeMs	ロードジョブのデータをコミットして公開するのにかかる時間。

ロードジョブが失敗した場合、StarRocks は ErrorURL も返します。例:

{"ErrorURL": "http://172.26.195.68:8045/api/_load_error_log?file=error_log_3a4eb8421f0878a6_9a54df29fd9206be"}

ErrorURL は、フィルタリングされた不適格なデータレコードの詳細を取得できる URL を提供します。StarRocks は 1,000 件の不適格なデータレコードを保持します。

curl "url" を実行して、フィルタリングされた不適格なデータレコードの詳細を直接表示できます。また、wget "url" を実行して、これらのデータレコードの詳細をエクスポートすることもできます。

wget http://172.26.195.68:8045/api/_load_error_log?file=error_log_3a4eb8421f0878a6_9a54df29fd9206be

エクスポートされたデータレコードの詳細は、_load_error_log?file=error_log_3a4eb8421f0878a6_9a54df29fd9206be のような名前のローカルファイルに保存されます。cat コマンドを使用してファイルを表示できます。

その後、ロードジョブの設定を調整し、ロードジョブを再送信できます。

Examples

Load CSV data

このセクションでは、CSV データを例として使用して、さまざまなロード要件を満たすためにさまざまなパラメータ設定と組み合わせをどのように活用できるかを説明します。

Set timeout period

StarRocks データベース test_db には、table1 という名前のテーブルがあります。このテーブルは、col1、col2、col3 の順に 3 つのカラムで構成されています。

データファイル example1.csv も 3 つのカラムで構成されており、table1 の col1、col2、col3 に順番にマッピングできます。

example1.csv のすべてのデータを 100 秒以内に table1 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> -H "label:label1" \
    -H "Expect:100-continue" \
    -H "timeout:100" \
    -H "max_filter_ratio:0.2" \
    -T example1.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table1/_stream_load

Set error tolerance

StarRocks データベース test_db には、table2 という名前のテーブルがあります。このテーブルは、col1、col2、col3 の順に 3 つのカラムで構成されています。

データファイル example2.csv も 3 つのカラムで構成されており、table2 の col1、col2、col3 に順番にマッピングできます。

example2.csv のすべてのデータを最大エラー許容度 0.2 で table2 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> -H "label:label2" \
    -H "Expect:100-continue" \
    -H "max_filter_ratio:0.2" \
    -T example2.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table2/_stream_load

Configure column mapping

StarRocks データベース test_db には、table3 という名前のテーブルがあります。このテーブルは、col1、col2、col3 の順に 3 つのカラムで構成されています。

データファイル example3.csv も 3 つのカラムで構成されており、table3 の col2、col1、col3 に順番にマッピングできます。

example3.csv のすべてのデータを table3 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password>  -H "label:label3" \
    -H "Expect:100-continue" \
    -H "columns: col2, col1, col3" \
    -T example3.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table3/_stream_load

NOTE

上記の例では、example3.csv のカラムは table3 のカラムと同じ順序でマッピングできません。そのため、columns パラメータを使用して example3.csv と table3 間のカラムマッピングを構成する必要があります。

Set filter conditions

StarRocks データベース test_db には、table4 という名前のテーブルがあります。このテーブルは、col1、col2、col3 の順に 3 つのカラムで構成されています。

データファイル example4.csv も 3 つのカラムで構成されており、table4 の col1、col2、col3 に順番にマッピングできます。

example4.csv の最初のカラムの値が 20180601 に等しいデータレコードのみを table4 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> -H "label:label4" \
    -H "Expect:100-continue" \
    -H "columns: col1, col2, col3]"\
    -H "where: col1 = 20180601" \
    -T example4.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table4/_stream_load

NOTE

上記の例では、example4.csv と table4 は同じ数のカラムを持ち、順番にマッピングできますが、WHERE 句を使用してカラムベースのフィルタ条件を指定する必要があります。そのため、columns パラメータを使用して example4.csv のカラムに一時的な名前を定義する必要があります。

Set destination partitions

StarRocks データベース test_db には、table5 という名前のテーブルがあります。このテーブルは、col1、col2、col3 の順に 3 つのカラムで構成されています。

データファイル example5.csv も 3 つのカラムで構成されており、table5 の col1、col2、col3 に順番にマッピングできます。

example5.csv のすべてのデータを table5 のパーティション p1 と p2 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password>  -H "label:label5" \
    -H "Expect:100-continue" \
    -H "partitions: p1, p2" \
    -T example5.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table5/_stream_load

Set strict mode and time zone

StarRocks データベース test_db には、table6 という名前のテーブルがあります。このテーブルは、col1、col2、col3 の順に 3 つのカラムで構成されています。

データファイル example6.csv も 3 つのカラムで構成されており、table6 の col1、col2、col3 に順番にマッピングできます。

example6.csv のすべてのデータをストリクトモードとタイムゾーン Africa/Abidjan を使用して table6 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> \
    -H "Expect:100-continue" \
    -H "strict_mode: true" \
    -H "timezone: Africa/Abidjan" \
    -T example6.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table6/_stream_load

Load data into tables containing HLL-type columns

StarRocks データベース test_db には、table7 という名前のテーブルがあります。このテーブルは、col1 と col2 の順に 2 つの HLL 型カラムで構成されています。

データファイル example7.csv も 2 つのカラムで構成されており、そのうちの最初のカラムは table7 の col1 にマッピングでき、2 番目のカラムは table7 のどのカラムにもマッピングできません。example7.csv の最初のカラムの値は、table7 の col1 にロードされる前に関数を使用して HLL 型データに変換できます。

example7.csv のデータを table7 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> \
    -H "Expect:100-continue" \
    -H "columns: temp1, temp2, col1=hll_hash(temp1), col2=hll_empty()" \
    -T example7.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table7/_stream_load

NOTE

上記の例では、example7.csv の 2 つのカラムは columns パラメータを使用して順番に temp1 と temp2 と名付けられます。その後、関数を使用してデータを変換します。

• hll_hash 関数は、example7.csv の temp1 の値を HLL 型データに変換し、example7.csv の temp1 を table7 の col1 にマッピングします。

• hll_empty 関数は、指定されたデフォルト値を table7 の col2 に埋め込むために使用されます。

関数 hll_hash および hll_empty の使用方法については、 hll_hash および hll_empty を参照してください。

Load data into tables containing BITMAP-type columns

StarRocks データベース test_db には、table8 という名前のテーブルがあります。このテーブルは、col1 と col2 の順に 2 つの BITMAP 型カラムで構成されています。

データファイル example8.csv も 2 つのカラムで構成されており、そのうちの最初のカラムは table8 の col1 にマッピングでき、2 番目のカラムは table8 のどのカラムにもマッピングできません。example8.csv の最初のカラムの値は、table8 の col1 にロードされる前に関数を使用して変換できます。

example8.csv のデータを table8 にロードしたい場合、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> \
    -H "Expect:100-continue" \
    -H "columns: temp1, temp2, col1=to_bitmap(temp1), col2=bitmap_empty()" \
    -T example8.csv -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/table8/_stream_load

NOTE

上記の例では、example8.csv の 2 つのカラムは columns パラメータを使用して順番に temp1 と temp2 と名付けられます。その後、関数を使用してデータを変換します。

• to_bitmap 関数は、example8.csv の temp1 の値を BITMAP 型データに変換し、example8.csv の temp1 を table8 の col1 にマッピングします。

• bitmap_empty 関数は、指定されたデフォルト値を table8 の col2 に埋め込むために使用されます。

関数 to_bitmap および bitmap_empty の使用方法については、 to_bitmap および bitmap_empty を参照してください。

Load JSON data

このセクションでは、JSON データをロードする際に注意すべきパラメータ設定について説明します。

StarRocks データベース test_db には、tbl1 という名前のテーブルがあり、そのスキーマは次のとおりです。

`category` varchar(512) NULL COMMENT "",`author` varchar(512) NULL COMMENT "",`title` varchar(512) NULL COMMENT "",`price` double NULL COMMENT ""

Load JSON data using simple mode

データファイル example1.json が次のデータで構成されているとします。

{"category":"C++","author":"avc","title":"C++ primer","price":895}

example1.json のすべてのデータを tbl1 にロードするには、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> -H "label:label6" \
    -H "Expect:100-continue" \
    -H "format: json" \
    -T example1.json -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/tbl1/_stream_load

NOTE

上記の例では、columns および jsonpaths パラメータは指定されていません。そのため、example1.json のキーは名前によって tbl1 のカラムにマッピングされます。

スループットを向上させるために、Stream Load は複数のデータレコードを一度にロードすることをサポートしています。例:

[{"category":"C++","author":"avc","title":"C++ primer","price":89.5},{"category":"Java","author":"avc","title":"Effective Java","price":95},{"category":"Linux","author":"avc","title":"Linux kernel","price":195}]

Load JSON data using matched mode

StarRocks は、JSON データをマッチングして処理するために次の手順を実行します。

1. (オプション) strip_outer_array パラメータ設定に従って最外部の配列構造を削除します。

   NOTE

   この手順は、JSON データの最外部レイヤーが [] で示される配列構造である場合にのみ実行されます。strip_outer_array を true に設定する必要があります。

2. (オプション) json_root パラメータ設定に従って JSON データのルート要素をマッチングします。

   NOTE

   この手順は、JSON データにルート要素がある場合にのみ実行されます。json_root パラメータを使用してルート要素を指定する必要があります。

3. jsonpaths パラメータ設定に従って指定された JSON データを抽出します。

Load JSON data using matched without root element specified

データファイル example2.json が次のデータで構成されているとします。

[{"category":"xuxb111","author":"1avc","title":"SayingsoftheCentury","price":895},{"category":"xuxb222","author":"2avc","title":"SayingsoftheCentury","price":895},{"category":"xuxb333","author":"3avc","title":"SayingsoftheCentury","price":895}]

example2.json から category、author、price のみをロードするには、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> -H "label:label7" \
    -H "Expect:100-continue" \
    -H "format: json" \
    -H "strip_outer_array: true" \
    -H "jsonpaths: [\"$.category\",\"$.price\",\"$.author\"]" \
    -H "columns: category, price, author" \
    -T example2.json -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/tbl1/_stream_load

NOTE

上記の例では、JSON データの最外部レイヤーが [] で示される配列構造です。配列構造は、各データレコードを表す複数の JSON オブジェクトで構成されています。そのため、最外部の配列構造を削除するために strip_outer_array を true に設定する必要があります。ロードしたくないキー title はロード中に無視されます。

Load JSON data using matched mode with root element specified

データファイル example3.json が次のデータで構成されているとします。

{"id": 10001,"RECORDS":[{"category":"11","title":"SayingsoftheCentury","price":895,"timestamp":1589191587},{"category":"22","author":"2avc","price":895,"timestamp":1589191487},{"category":"33","author":"3avc","title":"SayingsoftheCentury","timestamp":1589191387}],"comments": ["3 records", "there will be 3 rows"]}

example3.json から category、author、price のみをロードするには、次のコマンドを実行します。

curl --location-trusted -u <username>:<password> \
    -H "Expect:100-continue" \
    -H "format: json" \
    -H "json_root: $.RECORDS" \
    -H "strip_outer_array: true" \
    -H "jsonpaths: [\"$.category\",\"$.price\",\"$.author\"]" \
    -H "columns: category, price, author" -H "label:label8" \
    -T example3.json -XPUT \
    http://<fe_host>:<fe_http_port>/api/test_db/tbl1/_stream_load

NOTE

上記の例では、JSON データの最外部レイヤーが [] で示される配列構造です。配列構造は、各データレコードを表す複数の JSON オブジェクトで構成されています。そのため、最外部の配列構造を削除するために strip_outer_array を true に設定する必要があります。ロードしたくないキー title と timestamp はロード中に無視されます。さらに、json_root パラメータは、JSON データのルート要素である配列を指定するために使用されます。