バージョン: 4.x

LOCAL

デスクリプション

Local table-valued-function（tvf）は、ユーザーがbeノード上のローカルファイル内容を、リレーショナルTableにアクセスするのと同様に読み取りおよびアクセスできるようにします。現在、csv/csv_with_names/csv_with_names_and_types/json/parquet/orcファイル形式をサポートしています。

syntax

LOCAL(
  "file_path" = "<file_path>", 
  "backend_id" = "<backend_id>",
  "format" = "<format>"
  [, "<optional_property_key>" = "<optional_property_value>" [, ...] ]
  );

Required パラメータ

Parameter	デスクリプション	Remarks
`file_path`	読み取り対象のファイルパス。`user_files_secure_path`ディレクトリに対する相対パスです。`user_files_secure_path`パラメータはBE設定項目です。パスに`..`を含むことはできません。`logs/*.log`のように、パターンマッチングにglobシンタックスを使用できます。
`backend_id`	ファイルが配置されているBEノードのIDです。`show backends`コマンドで取得できます。	バージョン2.1.1より前では、DorisはBEノードを指定してそのノード上のローカルデータファイルを読み取ることのみをサポートしています。
`format`	ファイル形式、必須です。サポートされている形式は`csv/csv_with_names/csv_with_names_and_types/json/parquet/orc`です。

Optional パラメータ

Parameter	デスクリプション	Remarks
`shared_storage`	デフォルトはfalseです。trueの場合、指定されたファイルは共有ストレージ（例：NAS）に配置されています。共有ストレージはPOSIXファイルインターフェースをサポートし、すべてのBEノードにマウントされている必要があります。 `shared_storage`がtrueの場合、`backend_id`は省略可能です。DorisはすべてのBEノードを利用してデータにアクセスする場合があります。`backend_id`が設定されている場合、指定されたBEノードでのみデータにアクセスします。	バージョン2.1.2以降でサポート
`column_separator`	列区切り文字、オプション、デフォルトは`\t`です。
`line_delimiter`	行区切り文字、オプション、デフォルトは`\n`です。
`compress_type`	圧縮タイプ、オプションです。サポートされているタイプは`UNKNOWN/PLAIN/GZ/LZO/BZ2/LZ4FRAME/DEFLATE/SNAPPYBLOCK`です。デフォルトは`UNKNOWN`で、`uri`サフィックスから自動的に推定されます。
`read_json_by_line`	JSON形式インポート用、オプション、デフォルトは`true`です。	参照：Json Load
`strip_outer_array`	JSON形式インポート用、オプション、デフォルトは`false`です。	参照：Json Load
`json_root`	JSON形式インポート用、オプション、デフォルトは空です。	参照：Json Load
`json_paths`	JSON形式インポート用、オプション、デフォルトは空です。	参照：Json Load
`num_as_string`	JSON形式インポート用、オプション、デフォルトは`false`です。	参照：Json Load
`fuzzy_parse`	JSON形式インポート用、オプション、デフォルトは`false`です。	参照：Json Load
`trim_double_quotes`	CSV形式インポート用、オプション、デフォルトは`false`です。trueの場合、CSVファイルの各フィールドの最外側の二重引用符を削除します。	CSV形式用
`skip_lines`	CSV形式インポート用、オプション、デフォルトは`0`です。CSVファイルの最初の数行をスキップすることを意味します。形式が`csv_with_names`または`csv_with_names_and_types`の場合、このパラメータは無視されます。	CSV形式用
`path_partition_keys`	オプション、ファイルパスに含まれるパーティション列名を指定します。例：`/path/to/city=beijing/date="2023-07-09"`の場合、`path_partition_keys="city,date"`と入力します。パスから対応する列名と値を自動的に読み取ってインポートします。
`enable_mapping_varbinary`	デフォルトはfalseです。PARQUET/ORC読み取り時、BYTE_ARRAYタイプをSTRINGにマップします。有効にすると、VARBINARYタイプにマップします。	4.0.3以降でサポート

Access Control Requirements

Privilege	Object	注釈
ADMIN_PRIV	global

Usage 注釈

local tvfのより詳細な使用方法については、S3 tvfを参照してください。両者の違いはストレージシステムへのアクセス方法のみです。
local tvfを通じてNAS上のデータにアクセス

NAS共有ストレージは複数のノードに同時にマウントできます。各ノードは共有ストレージ内のファイルにローカルファイルと同様にアクセスできます。そのため、NASはローカルファイルシステムとして考えることができ、local tvfを通じてアクセスします。

"shared_storage" = "true"を設定すると、Dorisは指定されたファイルが任意のBEノードからアクセス可能であると判断します。ワイルドカードを使用してファイルセットが指定されている場合、Dorisはファイルアクセス要求を複数のBEノードに分散し、複数のノードを使用して分散ファイルスキャンを実行し、クエリパフォーマンスを向上させます。

Examples

指定されたBE上のログファイルを解析：

select * from local(
        "file_path" = "log/be.out",
        "backend_id" = "10006",
        "format" = "csv")
       where c1 like "%start_time%" limit 10;

+--------------------------------------------------------+
| c1                                                     |
+--------------------------------------------------------+
| start time: 2023 年 08 月 07 日 星期一 23:20:32 CST       |
| start time: 2023 年 08 月 07 日 星期一 23:32:10 CST       |
| start time: 2023 年 08 月 08 日 星期二 00:20:50 CST       |
| start time: 2023 年 08 月 08 日 星期二 00:29:15 CST       |
+--------------------------------------------------------+

パス ${DORIS_HOME}/student.csv にあるcsv形式ファイルを読み取り、アクセスします：

select * from local(
      "file_path" = "student.csv", 
      "backend_id" = "10003", 
      "format" = "csv");

+------+---------+--------+
| c1   | c2      | c3     |
+------+---------+--------+
| 1    | alice   | 18     |
| 2    | bob     | 20     |
| 3    | jack    | 24     |
| 4    | jackson | 19     |
| 5    | liming  | d18    |
+------+---------+--------+
```--+---------+--------+

Query files on NAS:

select * from local(
        "file_path" = "/mnt/doris/prefix_*.txt",
        "format" = "csv",
        "column_separator" =",",
        "shared_storage" = "true");

+------+------+------+
| c1   | c2   | c3   |
+------+------+------+
| 1    | 2    | 3    |
| 1    | 2    | 3    |
| 1    | 2    | 3    |
| 1    | 2    | 3    |
| 1    | 2    | 3    |
+------+------+------+

Can be used with desc function :

desc function local(
      "file_path" = "student.csv", 
      "backend_id" = "10003", 
      "format" = "csv");

+-------+------+------+-------+---------+-------+
| Field | タイプ | Null | Key   | Default | Extra |
+-------+------+------+-------+---------+-------+
| c1    | TEXT | Yes  | false | NULL    | NONE  |
| c2    | TEXT | Yes  | false | NULL    | NONE  |
| c3    | TEXT | Yes  | false | NULL    | NONE  |
+-------+------+------+-------+---------+-------+

デスクリプション​

syntax​

Required パラメータ​

Optional パラメータ​

Access Control Requirements​

Usage 注釈​

Examples​