メインコンテンツまでスキップ
メインコンテンツまでスキップ

URLを操作する関数

注記

このセクションで説明する関数は最大限のパフォーマンスのために最適化されており、ほとんどはRFC-3986標準に従っていません。RFC-3986を実装する関数には、関数名の末尾にRFCが付けられており、一般的に遅くなります。

一般的に、ユーザー文字列や@シンボルを含まない公に登録されたドメインを扱う場合は、非RFC関数バリアントを使用できます。下の表は、URL内のどのシンボルがそれぞれのRFCおよび非RFCバリアントによって解析可能()または不可能()であるかを示しています:

シンボルRFCRFC
' '
\t
<
>
%✔*
{
}
|
\\
^
~✔*
[
]
;✔*
=✔*
&✔*

*でマークされたシンボルはRFC 3986のサブデリミターであり、@シンボルに続くユーザー情報に対して許可されています。

URLのパーツを抽出する関数

関連する部分がURLに存在しない場合は、空の文字列が返されます。

protocol

URLからプロトコルを抽出します。

典型的に返される値の例:http, https, ftp, mailto, tel, magnet。

domain

URLからホスト名を抽出します。

構文

引数

URLはプロトコルありまたはなしで指定できます。例:

これらの例に対して、domain関数は次の結果を返します:

返される値

  • 入力文字列がURLとして解析可能であればホスト名、それ以外の場合は空の文字列。 String

domainRFC

URLからホスト名を抽出します。domainに似ていますが、RFC 3986に準拠しています。

構文

引数

返される値

  • 入力文字列がURLとして解析可能であればホスト名、それ以外の場合は空の文字列。 String

domainWithoutWWW

先頭のwww.が存在する場合、それを取り除いたドメインを返します。

構文

引数

返される値

  • 入力文字列がURLとして解析可能であれば(先頭のwww.なしの)ドメイン名、それ以外の場合は空の文字列。 String

domainWithoutWWWRFC

先頭のwww.が存在する場合、それを取り除いたドメインを返します。domainWithoutWWWに似ていますが、RFC 3986に準拠しています。

構文

引数

返される値

  • 入力文字列がURLとして解析可能であれば(先頭のwww.なしの)ドメイン名、それ以外の場合は空の文字列。 String

クエリ:

結果:

topLevelDomain

URLからトップレベルドメインを抽出します。

引数

注記

URLはプロトコルありまたはなしで指定できます。例:

返される値

  • 入力文字列がURLとして解析可能であればドメイン名。それ以外の場合は空の文字列。 String

クエリ:

結果:

topLevelDomainRFC

URLからトップレベルドメインを抽出します。 topLevelDomainに似ていますが、RFC 3986に準拠しています。

引数

注記

URLはプロトコルありまたはなしで指定できます。例:

返される値

  • 入力文字列がURLとして解析可能であればドメイン名。それ以外の場合は空の文字列。 String

クエリ:

結果:

firstSignificantSubdomain

「最初の重要なサブドメイン」を返します。 最初の重要なサブドメインは、comnetorg、またはcoのときはセカンドレベルドメインであり、それ以外の場合はサードレベルドメインです。 例えば、firstSignificantSubdomain ('https://news.clickhouse.com/') = 'clickhouse'firstSignificantSubdomain ('https://news.clickhouse.com.tr/') = 'clickhouse'。 「重要でない」セカンドレベルドメインのリストやその他の実装の詳細は将来的に変更される可能性があります。

構文

引数

返される値

  • 最初の重要なサブドメイン。 String

クエリ:

結果:

firstSignificantSubdomainRFC

「最初の重要なサブドメイン」を返します。 最初の重要なサブドメインは、comnetorg、またはcoのときはセカンドレベルドメインであり、それ以外の場合はサードレベルドメインです。 例えば、firstSignificantSubdomain ('https://news.clickhouse.com/') = 'clickhouse'firstSignificantSubdomain ('https://news.clickhouse.com.tr/') = 'clickhouse'。 「重要でない」セカンドレベルドメインのリストやその他の実装の詳細は将来的に変更される可能性があります。 firstSignificantsubdomainに似ていますが、RFC 1034に準拠しています。

構文

引数

返される値

  • 最初の重要なサブドメイン。 String

クエリ:

結果:

cutToFirstSignificantSubdomain

「最初の重要なサブドメイン」までのトップレベルサブドメインを含むドメインの部分を返します。

構文

引数

返される値

  • 可能であれば、最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分。それ以外の場合は空の文字列。 String

クエリ:

結果:

cutToFirstSignificantSubdomainRFC

「最初の重要なサブドメイン」までのトップレベルサブドメインを含むドメインの部分を返します。 cutToFirstSignificantSubdomainに似ていますが、RFC 3986に準拠しています。

構文

引数

返される値

  • 可能であれば、最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分。それ以外の場合は空の文字列。 String

クエリ:

結果:

cutToFirstSignificantSubdomainWithWWW

「最初の重要なサブドメイン」までのトップレベルサブドメインを含むドメインの部分を返しますが、wwwは削除しません。

構文

引数

返される値

  • 可能であれば、最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分(wwwあり)。それ以外の場合は空の文字列。 String

クエリ:

結果:

cutToFirstSignificantSubdomainWithWWWRFC

「最初の重要なサブドメイン」までのトップレベルサブドメインを含むドメインの部分を返しますが、wwwは削除しません。 cutToFirstSignificantSubdomainWithWWWに似ていますが、RFC 3986に準拠しています。

構文

引数

返される値

  • 可能であれば、最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分(wwwあり)。それ以外の場合は空の文字列。 String

クエリ:

結果:

cutToFirstSignificantSubdomainCustom

最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分を返します。 カスタムTLDリスト名を受け付けます。 この関数は新しいTLDリストが必要な場合やカスタムリストを持っている場合に便利です。

構成例

構文

引数

  • url — URL。 String
  • tld — カスタムTLDリスト名。 String

返される値

  • 最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分。 String

クエリ:

結果:

参照

cutToFirstSignificantSubdomainCustomRFC

最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分を返します。 カスタムTLDリスト名を受け付けます。 この関数は新しいTLDリストが必要な場合やカスタムリストを持っている場合に便利です。 cutToFirstSignificantSubdomainCustomに似ていますが、RFC 3986に準拠しています。

構文

引数

  • url — URL。 String
  • tld — カスタムTLDリスト名。 String

返される値

  • 最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分。 String

参照

cutToFirstSignificantSubdomainCustomWithWWW

最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分を返しますが、wwwは削除しません。 カスタムTLDリスト名を受け付けます。 これは新しいTLDリストが必要な場合やカスタムリストを持っている場合に便利です。

構成例

構文

引数

  • url — URL。 String
  • tld — カスタムTLDリスト名。 String

返される値

  • 最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分(wwwあり)。それ以外の場合は空の文字列。 String

クエリ:

結果:

参照

cutToFirstSignificantSubdomainCustomWithWWWRFC

最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分を返しますが、wwwは削除しません。 カスタムTLDリスト名を受け付けます。 新しいTLDリストが必要な場合やカスタムリストを持っている場合に便利です。 cutToFirstSignificantSubdomainCustomWithWWWに似ていますが、RFC 3986に準拠しています。

構文

引数

  • url — URL。 String
  • tld — カスタムTLDリスト名。 String

返される値

  • 最初の重要なサブドメインまでのトップレベルサブドメインを含むドメインの部分(wwwあり)。それ以外の場合は空の文字列。 String

参照

firstSignificantSubdomainCustom

最初の重要なサブドメインを返します。 カスタムTLDリスト名を受け付けます。 新しいTLDリストが必要な場合やカスタムリストを持っている場合に便利です。

構成例:

構文

引数

  • url — URL。 String
  • tld — カスタムTLDリスト名。 String

返される値

  • 最初の重要なサブドメイン。 String

クエリ:

結果:

参照

firstSignificantSubdomainCustomRFC

最初の重要なサブドメインを返します。 カスタムTLDリスト名を受け付けます。 新しいTLDリストが必要な場合やカスタムリストを持っている場合に便利です。 firstSignificantSubdomainCustomに似ていますが、RFC 3986に準拠しています。

構文

引数

  • url — URL。 String
  • tld — カスタムTLDリスト名。 String

返される値

  • 最初の重要なサブドメイン。 String

参照

port

ポートを返すか、URLにポートが含まれていない場合や解析できない場合はdefault_portを返します。

構文

引数

  • url — URL。 String
  • default_port — 返されるデフォルトポート番号。 UInt16

返される値

  • ポートまたは、URLにポートがない場合、または検証エラーの場合はデフォルトポート。 UInt16

クエリ:

結果:

portRFC

ポートを返すか、URLにポートが含まれていない場合や解析できない場合はdefault_portを返します。 portに似ていますが、RFC 3986に準拠しています。

構文

引数

  • url — URL。 String
  • default_port — 返されるデフォルトポート番号。 UInt16

返される値

  • ポートまたは、URLにポートがない場合、または検証エラーの場合はデフォルトポート。 UInt16

クエリ:

結果:

path

クエリ文字列なしでパスを返します。

例:/top/news.html

pathFull

上記と同じですが、クエリ文字列とフラグメントを含みます。

例:/top/news.html?page=2#comments

protocol

URLからプロトコルを抽出します。

構文

引数

  • url — プロトコルを抽出するURL。 String

返される値

  • プロトコル、または決定できない場合は空の文字列。 String

クエリ:

結果:

queryString

初期の疑問符、#、および#以降のすべてを除いたクエリ文字列を返します。

例:page=1&lr=213

fragment

初期のハッシュシンボルを除いたフラグメント識別子を返します。

queryStringAndFragment

クエリ文字列とフラグメント識別子を返します。

例:page=1#29390

extractURLParameter(url, name)

URLにnameパラメータが存在する場合、その値を返し、存在しない場合は空の文字列を返します。 同じ名前のパラメータが複数ある場合、最初の出現が返されます。 関数は、urlパラメータ内のパラメータがname引数と同じ方法でエンコードされていると仮定します。

extractURLParameters(url)

URLパラメータに対応するname=value文字列の配列を返します。 値はデコードされません。

extractURLParameterNames(url)

URLパラメータの名前に対応する名前文字列の配列を返します。 値はデコードされません。

URLHierarchy(url)

URLを含む配列を返しますが、パスとクエリ文字列によって/?の記号で切り詰められます。 連続するセパレーターは一つとしてカウントされます。 切り詰めは、すべての連続するセパレーターの後の位置で行われます。

URLPathHierarchy(url)

上記と同じですが、結果にプロトコルとホストを含みません。 /要素(ルート)は含まれません。

encodeURLComponent(url)

エンコードされたURLを返します。

例:

decodeURLComponent(url)

デコードされたURLを返します。

例:

encodeURLFormComponent(url)

エンコードされたURLを返します。RFC-1866に従い、スペース( )はプラス(+)としてエンコードされます。

例:

decodeURLFormComponent(url)

デコードされたURLを返します。RFC-1866に従い、通常のプラス(+)はスペース( )としてデコードされます。

例:

netloc

URLからネットワークローカリティ(username:password@host:port)を抽出します。

構文

引数

返される値

  • username:password@host:portString

クエリ:

結果:

URLの部分を削除する関数

URLに似たものが存在しない場合、URLは変更されません。

cutWWW

URLのドメインから先頭のwww.を削除します(存在する場合)。

cutQueryString

疑問符を含むクエリ文字列を削除します。

cutFragment

フラグメント識別子を削除します。

cutQueryStringAndFragment

クエリ文字列とフラグメント識別子を、クエスチョンマークや番号記号を含めて削除します。

cutURLParameter(url, name)

URLからnameパラメータを削除します(存在する場合)。 この関数は、パラメータ名の文字をエンコードまたはデコードしません。たとえば、Client IDClient%20IDは異なるパラメータ名として扱われます。

構文

引数

  • url — URL。 String.
  • name — URLパラメータの名前。 String または Array の Strings。

戻り値

  • name URLパラメータが削除されたURL。 String

クエリ:

結果: