LOCAL

説明

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

構文

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

必須パラメータ

パラメータ	説明	備考
`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`です。

オプションパラメータ

パラメータ	説明	備考
`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以降でサポート
`enable_mapping_timestamp_tz`	デフォルトは`false`です。PARQUET（`isAdjustedToUTC`を持つ`TIMESTAMP`）またはORC（`TIMESTAMP_INSTANT`）を読み取る際、型は`DATETIME`にマップされます。有効にすると、`TIMESTAMPTZ`型にマップされます。	バージョン4.0.3以降でサポート

アクセス制御要件

権限	オブジェクト	備考
ADMIN_PRIV	global

使用上の注意

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

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

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

例

指定された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 | Type | Null | Key   | Default | Extra |
+-------+------+------+-------+---------+-------+
| c1    | TEXT | Yes  | false | NULL    | NONE  |
| c2    | TEXT | Yes  | false | NULL    | NONE  |
| c3    | TEXT | Yes  | false | NULL    | NONE  |
+-------+------+------+-------+---------+-------+

説明​

構文​

必須パラメータ​

オプションパラメータ​

アクセス制御要件​

使用上の注意​

例​

説明

構文

必須パラメータ

オプションパラメータ

アクセス制御要件

使用上の注意

例