概要
このセクションで説明する関数は、最大限のパフォーマンスが得られるよう最適化されており、ほとんどの場合 RFC-3986 標準には準拠していません。
RFC-3986 を実装する関数には、関数名の末尾に
RFC が付き、一般に低速です。@ 記号を含まない公開登録済みドメインを扱う場合は、RFC なしの関数バリアントを使用できます。
以下の表は、URL 内のどの記号を各 RFC および非 RFC バリアントで parse できるか (✔) またはできないか (✗) を示しています。
* が付いた記号は、RFC 3986 ではサブ区切り文字であり、@ 記号に続くユーザー情報で使用できます。
URL 関数には 2 種類あります。
- URL の一部を抽出する関数。該当する部分が URL に存在しない場合は、空文字列が返されます。
- URL の一部を削除する関数。URL に該当する部分がない場合、URL は変更されません。
以下の関数は、
system.functions システムテーブルから生成されています。URLHierarchy
/、?、# を区切りとして末尾側から切り詰められます。連続する区切り文字は 1 つとして扱われます。結果の最初の要素にはプロトコルとホストが含まれ、以降はより長いパスが階層的に並びます。
構文
url— 処理対象の URL。String
Array(String)
例
基本的な使い方
Query
Response
URLPathHierarchy
/、?、# の各記号で区切った形に切り詰められます。URLHierarchy とは異なり、結果にはプロトコルとホストは含まれず、パスから始まります。連続する区切り文字は 1 文字として扱われます。
構文
url— 処理対象の URL。String
Array(String)
例
基本的な使い方
Query
Response
cutFragment
url— URL。String
String
例
使用例
Query
Response
cutQueryString
url— URL。String
String
例
使用例
Query
Response
cutQueryStringAndFragment
url— URL。String
String
例
使用例
Query
Response
cutToFirstSignificantSubdomain
url— 処理対象の URL またはドメイン文字列。String
String
例
使用例
Query
Response
cutToFirstSignificantSubdomainCustom
url— 処理する URL またはドメイン文字列。Stringtld_list_name— ClickHouse で設定したカスタム TLD リストの名前。const String
String
例
非標準ドメインでカスタム TLD リストを使用する
Query
Response
cutToFirstSignificantSubdomainCustomRFC
url— RFC 3986 に従って処理される URL またはドメイン文字列。 -tld_list_name— ClickHouse で設定したカスタム TLD リストの名前。
String
例
使用例
Query
Response
cutToFirstSignificantSubdomainCustomWithWWW
www を削除せず、最初の有意なサブドメインまでのトップレベルサブドメインを含むドメイン部分を返します。カスタム TLD リスト名を受け取ります。最新の TLD リストが必要な場合や、カスタム リストを使用している場合に便利です。
設定例
url— 処理対象の URL またはドメイン文字列。 -tld_list_name— ClickHouse で設定したカスタム TLD リストの名前。
www を削除せず、最初の意味のあるサブドメインまでのトップレベルサブドメインを含むドメインの一部。String
例
使用例
Query
Response
cutToFirstSignificantSubdomainCustomWithWWWRFC
www を削除せずに、最初の有意なサブドメインまでのトップレベルサブドメインを含むドメイン部分を返します。
カスタム TLD リスト名を受け取ります。
新しい TLD リストが必要な場合や、カスタム リストがある場合に役立ちます。
cutToFirstSignificantSubdomainCustomWithWWW と似ていますが、RFC 3986 に準拠しています。
設定例
url— RFC 3986 に従って処理する URL またはドメイン文字列。 -tld_list_name— ClickHouse で設定したカスタム TLD リストの名前。
www を削除せず、上位のサブドメインから最初の有意なサブドメインまでを含むドメイン部分を返します。String
例
カスタム TLD リストを使用して www を保持した RFC 3986 パース
Query
Response
cutToFirstSignificantSubdomainRFC
cutToFirstSignificantSubdomain と似ていますが、RFC 3986 に準拠しています。
構文
url— RFC 3986 に従って処理する URL またはドメイン文字列。String
String
例
使用例
Query
Response
cutToFirstSignificantSubdomainWithWWW
cutToFirstSignificantSubdomain と似ていますが、存在する場合は ‘www.’ プレフィックスを保持します。
構文
url— 処理対象の URL またはドメイン文字列。String
String
例
使用例
Query
Response
cutToFirstSignificantSubdomainWithWWWRFC
www を削除せず、トップレベルサブドメインから「最初の有意なサブドメイン」までを含むドメイン部分を返します。cutToFirstSignificantSubdomainWithWWW に似ていますが、RFC 3986 に準拠しています。
構文
url— RFC 3986 に従って処理する URL またはドメイン文字列。
www を含むトップレベルサブドメインを含む) を返します。該当しない場合は、空文字列 String を返します。
例
使用例
Query
Response
cutURLParameter
name パラメータが含まれている場合は、それを削除します。
この関数は、パラメータ名の文字をエンコードまたはデコードしません。たとえば、Client ID と Client%20ID は別のパラメータ名として扱われます。
構文
url— URL。Stringname— URL パラメータ名。StringまたはArray(String)
name で指定した URL パラメータを削除した URL。 String
例
使用例
Query
Response
cutWWW
www. がある場合は、それを削除します。
構文
url— URL。String
www. を除去した URL を返します。 String
例
使用例
Query
Response
decodeURLComponent
url— URL。String
String
例
使用例
Query
Response
decodeURLFormComponent
+ 記号は空白に変換され、パーセントエンコードされた文字はデコードされます。
構文
url— URL。String
String
例
使用例
Query
Response
domain
url— URL。String
String
例
使用例
Query
Response
domainRFC
domain に似ていますが、RFC 3986 に準拠しています。
構文
url— URL。String
String
例
使用例
Query
Response
domainWithoutWWW
www. がある場合、それを除いたドメインを返します。
構文
url— URL。String
www. を除く) を返し、そうでない場合は空文字列を返します。String
例
使用例
Query
Response
domainWithoutWWWRFC
www. が付いている場合は、それを除いたドメインを返します。domainWithoutWWW と似ていますが、RFC 3986 に準拠しています。
構文
url— URL。String
www. を除く) を返し、そうでない場合は空文字列を返します。String
例
使用例
Query
Response
encodeURLComponent
url— URL。String
String
例
使用例
Query
Response
encodeURLFormComponent
+ 記号に変換され、特殊文字はパーセントエンコードされます。
構文
url— URL。String
String
例
使用例
Query
Response
extractURLParameter
name パラメータが存在する場合はその値を返し、存在しない場合は空文字列を返します。
この名前のパラメータが複数ある場合は、最初に出現したものが返されます。
この関数は、url 引数内のパラメータが name 引数と同じ方法でエンコードされていることを前提としています。
構文
String
例
使用例
Query
Response
extractURLParameterNames
url— URL。String
Array(String)
例
使用例
Query
Response
extractURLParameters
name=value 形式の文字列の配列を返します。
値はデコードされません。
Syntax
url— URL。String
name=value 形式の文字列の配列を返します。 Array(String)
例
使用例
Query
Response
firstSignificantSubdomain
- なし。
Query
Response
firstSignificantSubdomainCustom
String
例
基本的な使い方
Query
Response
firstSignificantSubdomainCustomRFC
firstSignificantSubdomainCustom と似ていますが、簡略化されたアルゴリズムではなく、RFC 3986 に準拠した URL パースを使用します。
構文
String
例
基本的な使い方
Query
Response
firstSignificantSubdomainRFC
- なし。
fragment
url— URL。String
String
例
使用例
Query
Response
netloc
username:password@host:port) を抽出します。
構文
url— URL。String
username:password@host:port を返します。 String
例
使用例
Query
Response
path
url— URL。String
String
例
使用例
Query
Response
pathFull
path と同様ですが、URL のクエリ文字列とフラグメントも含みます。
構文
url— URL。String
String
例
使用例
Query
Response
port
default_port を返します。
構文
UInt16
例
使用例
Query
Response
portRFC
default_port を返します。
port と似ていますが、RFC 3986 に準拠しています。
構文
UInt16
例
使用例
Query
Response
protocol
url— URL。String
String
例
使用例
Query
Response
queryString
#、および # 以降のすべてを除いた文字列を返します。
構文
url— URL。String
String
例
使用例
Query
Response
queryStringAndFragment
url— URL。String
String
例
使用例
Query
Response
topLevelDomain
URL はプロトコルの有無にかかわらず指定できます。
例:
url— URL。String
String
例
使用例
Query
Response
topLevelDomainRFC
導入バージョン: v22.10.0 URL からトップレベルドメインを抽出します。topLevelDomain と似ていますが、RFC 3986 に準拠しています。
構文
url— URL。String
String
例
使用例
Query
Response