url 関数は、指定された フォーマット と 構造 を使用して URL からテーブルを作成します。
url 関数は、URL テーブル内のデータに対する SELECT および INSERT クエリで使用できます。
構文
パラメーター
| Parameter | Description |
|---|---|
URL | 単一引用符で囲んだ HTTP または HTTPS のサーバーアドレスです。GET または POST リクエストを受け付けます (それぞれ SELECT クエリ、INSERT クエリに対応) 。型: String。 |
format | データのフォーマットです。型: String。 |
structure | 'UserID UInt64, Name String' フォーマットで指定するテーブル構造です。カラム名と型を決定します。型: String。 |
headers | 'headers('key1'='value1', 'key2'='value2')' フォーマットのヘッダーです。HTTP 呼び出し用のヘッダーを設定できます。 |
戻り値
URLのデータを含むテーブル。
例
String 型と UInt32 型のカラムを含むテーブルの先頭 3 行を取得します。
URL からテーブルへデータを挿入するには:
URL 内の globs
{ } 内のパターンは、分片のセットを生成したり、フェイルオーバー先のアドレスを指定したりするために使用されます。サポートされているパターンの種類と例については、remote 関数の説明を参照してください。
パターン内の文字 | は、フェイルオーバー先のアドレスを指定するために使用されます。これらは、パターンに記載された順序どおりに順番に試行されます。生成されるアドレス数は、glob_expansion_max_elements 設定によって制限されます。
仮想カラム
_path—URLのパス。型:LowCardinality(String)。_file—URLのリソース名。型:LowCardinality(String)。_size— リソースのサイズ (バイト単位) 。型:Nullable(UInt64)。サイズが不明な場合、値はNULLです。_time— ファイルの最終更新時刻。型:Nullable(DateTime)。時刻が不明な場合、値はNULLです。_headers- HTTP レスポンスヘッダー。型:Map(LowCardinality(String), LowCardinality(String))。
use_hive_partitioning 設定
use_hive_partitioning 設定を 1 にすると、ClickHouse はパス (/name=value/) 内の Hive スタイルのパーティション化を検出し、クエリ内でパーティションカラムを仮想カラムとして使用できるようになります。これらの仮想カラムには、パーティション化されたパス内と同じ名前が付きます。
例
Hive スタイルのパーティション化で作成された仮想カラムを使用する
相対 URL の解決
url 関数に相対 URL を渡せます。url_base が設定されていて、関数の引数が相対参照である場合、その参照は RFC 3986 に従ってベース URL を基準に解決されます。
解決規則は次のとおりです。
- パス相対 (例:
data.csv) : ベース URL のパスにマージされ、ベースパスの最後の/以降はすべて置き換えられます。末尾のスラッシュの有無は重要です。https://example.com/dir/+data.csvはhttps://example.com/dir/data.csvになりますが、https://example.com/dir+data.csvはhttps://example.com/data.csvになります。ドットセグメント (./と../) は正規化されます。 - ホスト相対 (例:
/test/data.csv) : ベース URL のスキームとホストを使用して解決されます。 - スキーム相対 (例:
//other.com/test/data.csv) : ベース URL のスキームを使用して解決されます。 - クエリのみ (例:
?x=1) : 完全なベースパスに付加され、既存のクエリやフラグメントは置き換えられます。 - フラグメントのみ (例:
#frag) : ベース URL に付加され、クエリは保持されたまま、既存のフラグメントは置き換えられます。 - 空: フラグメントを除いたベース URL を返します。
- 絶対 URL: 変更せずそのまま渡されます。
url_baseは無視されます。
ストレージ設定
- engine_url_skip_empty_files - 読み取り時に空のファイルをスキップできます。デフォルトでは無効です。
- enable_url_encoding - URI 内のパスのデコード/エンコードを有効または無効にできます。デフォルトでは有効です。
- url_base -
url関数に渡された相対 URL を解決するためのベース URL です。
権限
url 関数を使用するには、CREATE TEMPORARY TABLE 権限が必要です。そのため、readonly = 1 に設定されているユーザーは利用できません。少なくとも readonly = 2 が必要です。