文字列関数

Cloudflare Pipelines のスカラー関数実装は Apache DataFusion ↗（Arroyo ↗ 経由）を基にしており、このドキュメントは DataFusion の関数リファレンスから派生しています。

`ascii`

文字列の先頭文字の ASCII 値を返します。

ascii(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

関連関数: chr

`bit_length`

文字列のビット長を返します。

bit_length(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

関連関数: length, octet_length

`btrim`

指定したトリム文字列を、文字列の先頭と末尾から取り除きます。トリム文字列を指定しない場合は、入力文字列の先頭と末尾から空白をすべて取り除きます。

btrim(str[, trim_str])

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
trim_str: 入力文字列の先頭と末尾から取り除く文字列式。定数、列、関数、および算術演算子の任意の組み合わせを使えます。 デフォルトは空白文字です。

関連関数: ltrim, rtrim

エイリアス

trim

`char_length`

length のエイリアスです。

`character_length`

length のエイリアスです。

`concat`

複数の文字列を連結します。

concat(str[, ..., str_n])

引数

str: 連結する文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
str_n: 続けて連結する文字列列、またはリテラル文字列。

関連関数: concat_ws

`concat_ws`

指定した区切り文字で、複数の文字列を連結します。

concat(separator, str[, ..., str_n])

引数

separator: 連結する文字列の間に入れる区切り文字。
str: 連結する文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
str_n: 続けて連結する文字列列、またはリテラル文字列。

関連関数: concat

`chr`

指定した ASCII または Unicode のコード値に対応する文字を返します。

chr(expression)

引数

expression: 操作対象の ASCII または Unicode のコード値を含む式。定数、列、関数、および算術演算子や文字列演算子の任意の組み合わせを使えます。

関連関数: ascii

`ends_with`

文字列が指定した部分文字列で終わるかどうかを調べます。

ends_with(str, substr)

引数

str: 調べる文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
substr: 検索する部分文字列。

`initcap`

入力文字列の各単語の先頭文字を大文字にします。単語の区切りは英数字以外の文字です。

initcap(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

関連関数: lower, upper

`instr`

strpos のエイリアスです。

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
substr: 検索する部分文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

`left`

文字列の左端から、指定した文字数を返します。

left(str, n)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
n: 返す文字数。

関連関数: right

`length`

文字列の文字数を返します。

length(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

エイリアス

char_length
character_length

関連関数: bit_length, octet_length

`lower`

文字列を小文字に変換します。

lower(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

関連関数: initcap, upper

`lpad`

指定した文字列長になるまで、文字列の左側を別の文字列で埋めます。

lpad(str, n[, padding_str])

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
n: 埋めたあとの文字列長。
padding_str: 埋めに使う文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。 デフォルトはスペースです。

関連関数: rpad

`ltrim`

指定したトリム文字列を、文字列の先頭から取り除きます。トリム文字列を指定しない場合は、入力文字列の先頭から空白をすべて取り除きます。

ltrim(str[, trim_str])

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
trim_str: 入力文字列の先頭から取り除く文字列式。定数、列、関数、および算術演算子の任意の組み合わせを使えます。 デフォルトは空白文字です。

関連関数: btrim, rtrim

`octet_length`

文字列のバイト長を返します。

octet_length(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

関連関数: bit_length, length

`repeat`

入力文字列を指定回数繰り返した文字列を返します。

repeat(str, n)

引数

str: 繰り返す文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
n: 入力文字列を繰り返す回数。

`replace`

文字列内の指定した部分文字列を、すべて新しい部分文字列に置き換えます。

replace(str, substr, replacement)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
substr: 入力文字列内で置き換える部分文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
replacement: 置き換え先の部分文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

`reverse`

文字列の文字順を逆にします。

reverse(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

`right`

文字列の右端から、指定した文字数を返します。

right(str, n)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
n: 返す文字数。

関連関数: left

`rpad`

指定した文字列長になるまで、文字列の右側を別の文字列で埋めます。

rpad(str, n[, padding_str])

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
n: 埋めたあとの文字列長。
padding_str: 埋めに使う文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。 デフォルトはスペースです。

関連関数: lpad

`rtrim`

指定したトリム文字列を、文字列の末尾から取り除きます。トリム文字列を指定しない場合は、入力文字列の末尾から空白をすべて取り除きます。

rtrim(str[, trim_str])

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
trim_str: 入力文字列の末尾から取り除く文字列式。定数、列、関数、および算術演算子の任意の組み合わせを使えます。 デフォルトは空白文字です。

関連関数: btrim, ltrim

`split_part`

指定した区切り文字で文字列を分割し、指定位置の部分文字列を返します。

split_part(str, delimiter, pos)

引数

str: 分割する文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
delimiter: 分割に使う文字列または文字。
pos: 返す部分の位置。

`starts_with`

文字列が指定した部分文字列で始まるかどうかを調べます。

starts_with(str, substr)

引数

str: 調べる文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
substr: 検索する部分文字列。

`strpos`

文字列内で指定した部分文字列が始まる位置を返します。位置は 1 から始まります。部分文字列が存在しない場合は 0 を返します。

strpos(str, substr)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
substr: 検索する部分文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

エイリアス

instr

`substr`

文字列の指定した開始位置から、指定した文字数の部分文字列を取り出します。

substr(str, start_pos[, length])

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
start_pos: 部分文字列を開始する文字位置。文字列の先頭文字の位置は 1 です。
length: 取り出す文字数。指定しない場合は、開始位置以降の残りの文字列を返します。

`translate`

文字列内の文字を、指定した変換文字へ置き換えます。

translate(str, chars, translation)

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。
chars: 変換する文字。
translation: 変換先の文字。変換先の文字は、chars 文字列の同じ位置にある文字だけを置き換えます。

`to_hex`

整数を 16 進文字列に変換します。

to_hex(int)

引数

int: 変換する整数式。定数、列、関数、および算術演算子の任意の組み合わせを使えます。

`trim`

btrim のエイリアスです。

`upper`

文字列を大文字に変換します。

upper(str)

引数

str: 操作対象の文字列式。定数、列、関数、および文字列演算子の任意の組み合わせを使えます。

関連関数: initcap, lower

`uuid`

行ごとに一意な UUID v4 の文字列値を返します。

uuid()

`overlay`

指定した位置から指定した文字数を、別の文字列で置き換えた文字列を返します。例: overlay('Txxxxas' placing 'hom' from 2 for 4) → Thomas

overlay(str PLACING substr FROM pos [FOR count])

引数

str: 操作対象の文字列式。
substr: str の一部を置き換える文字列。
pos: str の置き換え開始位置。
count: str の開始位置から置き換える文字数。指定しない場合は、substr の長さを使います。

`levenshtein`

2 つの文字列間のレーベンシュタイン距離を返します。例: levenshtein('kitten', 'sitting') = 3

levenshtein(str1, str2)

引数

str1: str2 とのレーベンシュタイン距離を計算する文字列式。
str2: str1 とのレーベンシュタイン距離を計算する文字列式。

`substr_index`

区切り文字 delim が count 回現れる位置より前の、str の部分文字列を返します。 count が正の場合は、左から数えて最後の区切り文字より左側を返します。 count が負の場合は、右から数えて最後の区切り文字より右側を返します。例: substr_index('www.apache.org', '.', 1) = www、substr_index('www.apache.org', '.', -1) = org

substr_index(str, delim, count)

引数

str: 操作対象の文字列式。
delim: str を分割するために str 内で探す文字列。
count: 区切り文字を探す回数。正負どちらも使えます。

`find_in_set`

N 個の部分文字列からなる文字列リスト strlist に、文字列 str が含まれる場合、1 から N の範囲の値を返します。例: find_in_set('b', 'a,b,c,d') = 2

find_in_set(str, strlist)

引数

str: strlist 内で探す文字列式。
strlist: , で区切った部分文字列からなる文字列リストです。