ワークフロー関数リファレンス
以下は、Live Queryでデータの変換に使用できる関数です。データ型によって、使用できる関数が決まります。
詳細については、サポートされているデータ型を参照してください。
このガイドでは、Live Queryの式エディターで使用できる関数をすばやく参照できます。詳細および例については、各セクションにリンクされているカテゴリ別のページを参照してください。
条件式
条件付き関数を使用すると、IF 文を使用してアクションまたは計算を実行できます。パラメーターと例については、ワークフロー条件付き関数を参照してください。
IF condition THEN t ELSE f ENDIF
IF c THEN t ELSE f ENDIF: 条件cがtrueの場合はtを返し、それ以外の場合はfを返します。
IF c THEN t1 ELSEIF c2 THEN t2 ELSE f ENDIF
IF c THEN t1 ELSEIF c2 THEN t2 ELSE f ENDIFIF c THEN t ELSE f ENDIF: cがtrueの場合はt1、また条件c2がtrueの場合はt2、それ以外はfを返します。
IIF
IIF(bool, x, y): ブールがtrueの場合はx、それ以外はyを返します。
Switch
Switch(Value,Default,Case1,Result1,...,CaseN,ResultN): ケースのリストと値を比較し、対応する結果を返します。
変換
変換関数は、数値を文字列に、あるいは文字列を数値に変換します。パラメーターと例については、ワークフロー変換関数を参照してください。
CharFromInt
CharFromInt(x): 入力した数値xと一致するUnicode®文字を返します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
ToDegrees
ToDegrees(x): ラジアンの数値(x)を角度値に(x)rad × 180/πの計算で変換します。xは数値である必要があり、ラジアン記号(rad)を含めることはできません。
ToNumber
ToNumber(x, [bIgnoreErrors], [keepNulls], [decimalSeparator]): 文字列xを数値に変換します。
ToRadians
ToRadians(x): 角度の数値(x)をラジアンの値に(x)° × π/180の計算で変換します。なお、xは数値である必要があり、度数記号(°)を含むことはできません。
ToString
ToString(x, numDec, [addThousandsSeparator], [decimalSeparator]): numDecの小数位を使用して、数値パラメーター(x)を文字列に変換します。既定では、ピリオドが小数点記号として使用されます。
日付/時刻
日付/時刻関数を使用すると、日付と時刻の値に基づいてアクションまたは計算を実行できます。パラメーターと例については、ワークフロー日付/時刻関数を参照してください。
DateTimeAdd
DateTimeAdd(dt,i,u): 日付/時刻の値に特定の間隔を追加します。
DateTimeDay
DateTimeDay(dt): 日付/時刻値の日の数値を返します。
DateTimeDiff
DateTimeDiff(dt1,dt2,u): 最初の引数から2番目の引数を減算し、整数の差として返します。期間は、文字列ではなく指定された時間単位数の数値として返されます。
DateTimeFirstOfMonth
DateTimeFirstOfMonth(): 月の初日の午前 0 時を返します。
DateTimeFormat
DateTimeFormat(dt, f): 日付/時刻データdfを指定された別の書式fに変換します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
DateTimeHour
DateTimeHour(dt): 時刻の時間(h)部分を日付時刻値で返します。
DateTimeLastOfMonth
DateTimeLastOfMonth(): 現在の月の最後の日を返します。時計はその日の終わりの1秒前(23:59:59)に設定されます。
DateTimeMinutes
DateTimeMinutes(dt): 時刻の「分」の部分を日付時刻値で返します。
DateTimeMonth
DateTimeMonth(dt): 日付/時刻値の月の数値を返します。
現在日時
DateTimeNow(): 現在のシステムの日付と時刻を返します。
DateTimeParse
DateTimeParse(dt, f): 特定の形式と言語の日付文字列をISO標準形式(yyyy-mm-dd HH:MM:SS)に変換します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
DateTimeQuarter
DateTimeQuarter(dt,[Q1Start]): 日付/時刻(YYYY-MM-DD)値の該当する四半期の数値を返します。オプションの数値パラメーターを使用して、第一四半期(Q1)の開始月を示します。
DateTimeSeconds
DateTimeSeconds(dt): 時刻の「秒」の部分を日付/時刻値で返します。
DateTimeToday
DateTimeToday(): 今日の日付を返します。
DateTimeTrim
DateTimeTrim(dt, f): 日付/時刻値の不要な部分を削除し、修正した日付/時刻値を返します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
DateTimeYear
DateTimeYear(dt): 日付/時刻値の年の数値を返します。
ToDate
ToDate(x): 文字列、数値、または日付/時刻値を日付に変換します。
ToDateTime
DateTimeTrim(ToDateTime(x), t): 文字列、数字、または日付値を日付/時刻に変換します。
ファイナンス
ファイナンス関数は、金融アルゴリズムまたは数学的計算を適用します。詳細については、ワークフローファイナンス関数を参照してください。
FinanceCAGR
FinanceCAGR(BeginningValue, EndingValue, NumYears): 年平均成長率(年換算ベースの幾何平均成長率)を計算します。
FinanceEffectiveRate
FinanceEffectiveRate(NominalRate, PaymentsPerYear): 実効年利率(名目金利から修正された、延滞金の年間複利を含む金利としての貸出金または金融商品の利率)を計算します。
FinanceFV
FinanceFV(Rate, NumPayments, PaymentAmount, PresentValue, PayAtPeriodBegin): 投資の将来価値(一定の金利または収益率を前提とした将来の特定の時点における資産の価値)を計算します。
FinanceIRR
FinanceIRR(Value1, Value2): 内部収益率(投資コストが投資の利益につながる金利)を計算します。これは、投資から得られるすべての利益は金銭の時間価値に固有であり、投資にはこの金利でゼロの正味現在価値があることを意味します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
FinanceNominalRate
FinanceNominalRate(EffectiveRate, PaymentsPerYear): 名目年金利を計算します。複利の頻度が毎月など、基本時間単位(通常は年)と同じでない場合、金利は名目金利と呼ばれます。
FinanceNPER
FinanceNPER(Rate, PaymentAmount, PresentValue, FutureValue, PayAtPeriodBegin): 投資またはローンの期間数を計算します。
FinancePMT
FinancePMT(Rate, NumPayments, PresentValue, FutureValue, PayAtPeriodBegin): ローンの支払額を計算します。
FinancePV
FinancePV(Rate, NumPayments, PaymentAmount, FutureValue, PayAtPeriodBegin): 投資の現在価値(金銭の時間価値および投資リスクなどのその他の要因を反映するために割り引かれる、所定の日付での将来の支払いまたは一連の将来の支払いの金額)を計算します。
FinanceXIRR
FinanceXIRR(Value1, Date1, Value2, Date2): 日付付き投資の内部収益率を計算します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
FinanceXNPV
FinanceXNPV(Rate, Value1, Date1, Value2, Date2): 日付付き投資の正味現在価値を計算します。
数学
数学関数は数学的計算を実行します。パラメーターおよび例については、ワークフロー数学関数を参照してください。
ABS
ABS(x): xの絶対値を返します。0から数値までの距離です。値は常に正です。
ACOS
ACOS(x): 数値(x)のアークコサインまたは逆コサインを返します。アークコサインは、コサインが(x)である角度です。
ASIN
ASIN(x): 数値(x)のアークサインまたは逆サインを返します。アークサインは、サインが(x)である角度です。
ATAN
ATAN(x): 数値(x)のアークタンジェントまたは逆タンジェントを返します。アークタンジェントは、タンジェントが(x)である角度です。返される角度は、-π/2からπ/2の範囲のラジアンで与えられます。
ATAN2
ATAN2(y, x): yとxのアークタンジェント(逆タンジェント)、((y/x)のアークタンジェント)を返します。
平均
Average(n1, ...): 数値のリストの平均を返します。NULL 値は0として扱われ、平均値の計算に算入されます。
AverageNonNull
AverageNonNull(n1, ...): 数字の一覧の平均を返します。Null値は計算から除外されます。この計算は数値データ型でのみ機能します。
CEIL
.CEIL(x, [mult]): (x)を、それ以上の(mult)の最小倍数に切り上げた数値を返します。(mult)パラメーターは0よりも大きい値でなければなりません。(mult)が指定されていない場合、(x)以上の最小の整数を返します。
COS
COS(x): 指定した角度(x)のコサインを返します。xはラジアンである必要があります。
EXP
EXP(x): eのx乗を返します。
FLOOR
FLOOR(x, [mult]): (x)を、それ以下の(mult)の最大倍数に切り捨てた数値を返します。(mult)パラメーターは0よりも大きい値でなければなりません。(mult)が指定されていない場合、次の最初の例に示されているように、この関数は(x)以下の最大の整数を返します。
LOG
LOG(x): 数値(x)の自然対数を返します。xは正の数である必要があります。
LOG10
LOG10(x): 10を底とする数値(x)の対数を返します。xは正の数である必要があります。
Median
Median(...): 1つ以上の(ソートされていない可能性がある)値の中央値を計算します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
Mod
Mod(n,d): 数値(n)を数値(d)で除算した後の剰余を返します(整数演算)。
PI
PI(): 円周率πの値を15桁の精度で返します。
POW
POW(x, e): (x)の(e)乗を返します。
RAND
RAND(): 0と1の間の乱数を返します。
RandInt
RandInt(n): 0以上指定された任意のパラメーターn未満の乱数(整数)を返します。
Round
Round(x, mult): multで指定した、最も近い倍数に丸められたxを返します。
SIN
SIN(x): 指定された角度(x)のサインを返します。xはラジアンである必要があります。
SmartRound
SmartRound(x): (x)の大きさに基づいて動的に決定された値の最も近い倍数に四捨五入した数値(x)を返します。
SQRT
SQRT(x): 数値(x)の平方根を返します。
TAN
TAN(x): 指定された角度(x)のタンジェントを返します。xはラジアンである必要があります。
TANH
TANH(x): 数値(x)の双曲線タンジェントを返します。
Min/Max
最小/最大関数は、一連の値の最小値と最大値を取得します。詳細については、ワークフロー最小/最大関数を参照してください。
Between
BETWEEN(x, min, max): 値(x)が他の2つの値(minとmax)の両端を含む間にあるかどうかをテストします。xがminとmaxの間にある場合、TRUEを返します。xがminとmaxの間にない場合、FALSEを返します。
Bound
Bound(x, min, max): (x < min) の場合は最小値を返し、そうではなく (x > max) の場合は最大値を返し、それ以外の場合は (x) を返します。
Max
Max(v0, v1,..., vn): リストから最大値を返します。
Min
Min(v0, v1,..., vn): リスト中の最小値を返します。
演算子
演算子は、アクションを表す文字です。算術演算子を使用して数学的計算を実行したり、ブール演算子を使用してtrue/false値を出力したりします。詳細については、ワークフロー演算子を参照してください。
加算
+: 加算。
論理AND - キーワード
AND: 2つのブール値を結合します。結果は、結合する値の両方がTrueの場合はTrueに、どちらかがFalseで、かつNULLではない場合はFalseに、どちらかがNULLの場合はNULLになります。
ブールAND
&&: 2つのブール値を結合します。結果は、結合する値の両方がTrueの場合はTrueに、どちらかがFalseで、かつNULLではない場合はFalseに、どちらかがNULLの場合はNULLになります。
論理NOT - キーワード
NOT: 1 入力を受けつけます。その入力値がTrueの場合は、Falseを返します。その入力値がFalseの場合は、Trueを返します。その入力値がNULLの場合は、NULLを返します。
ブールNOT
!: 1 入力を受けつけます。その入力値がTrueの場合は、Falseを返します。その入力値がFalseの場合は、Trueを返します。その入力値がNULLの場合は、NULLを返します。
論理OR - キーワード
OR: 2つのブール値を結合します。2つの値のいずれか(または両方)がTrueの場合、結果はTrueになります。いずれかの値がNULLの場合は、NULLを返します。
ブールOR
||: 2つのブール値を結合します。2つの値のいずれか(または両方)がTrueの場合、結果はTrueになります。いずれかの値がNULLの場合は、NULLを返します。
除算
/: 除算。
等号
=: 等しい。
より大きい
>: より大きい。
以上
>=: 以上。
より小さい
<: より小さい。
以下
<=: 以下。
乗算
*: 乗算。
不等号
!=: 等しくない
減算
-: 減算。
(...)内の値である
IN: 値がリストにあることをテストします。
(...)内の値ではない
NOT IN: 値がリストにないことをテストします。
特殊
これらの関数は、さまざまな特殊なアクションを実行し、すべてのデータ型で使用できます。パラメーターと例については、ワークフロー特殊関数を参照してください。
NULL
NULL(): Null値を返します。
String
文字列関数は、テキストデータに対して操作を実行します。文字列関数を使用して、データのクレンジング、データを別の形式や大文字小文字への変換、またはデータに関するメトリックを計算したり、他の操作を実行したりできます。パラメーターと例については、ワークフロー文字列関数を参照してください。
Contains
Contains(String, Target, CaseInsensitive=1): 文字列内の特定の文字列を検索します。文字列 (String) にターゲット (Target) が含まれている場合は True、それ以外は False を返します。
CountWords
CountWords(string): 指定した文字列内の単語数を返します。単語はスペースで区切られた文字で定義されます。
注記
この関数は、DatabricksのLive Queryでは使用できません。
EndsWith
EndsWith(String, Target, CaseInsensitive=1): 文字列が特定の文字列で終わるかどうかをチェックします。文字列 (String) がターゲット (Target) で終わる場合は True、それ以外は False を返します。既定では大文字と小文字は区別されません。
FindNth
FindNth(Initial String, Target, Instance): 初期文字列内のターゲット文字列のインスタンス(n回目の出現)を検索し、インスタンスの0インデックスの位置を返します。この関数では大文字と小文字が区別され、負のパラメーターは受け入れられません。
FindString
FindString(String,Target): 別の文字列(String)内の特定の文字列(Target)の出現を検索し、その出現の数値位置を文字列に返します。文字列のターゲットの最初の出現の0ベースのインデックスを返します。出現がない場合は-1を返します。
GetLeft
GetLeft(String, Delimiter)指定した1つ以上の区切り記号の最初のインスタンスまで、指定した文字列の左側の部分を返します。
GetPart
GetPart(String, Delimiter, Index)指定した1つ以上の区切り記号を使用して文字列を部分文字列に分割し、インデックスで指定した位置に部分文字列を返します。
GetRight
GetRight(String, Delimiter)指定した1つ以上の区切り記号の最初のインスタンスより後の指定した文字列の右側の部分を返します。
GetWord
GetWord(string, n): 文字列のN番目の(0ベースの)単語を返します。単語はスペースで区切られた文字の集合として定義されます。0ベースインデックスとは、最初の単語が0の位置(0から始まる)にあるという意味です。
Left
Left(String, len): 文字列 (String) の最初の [len] 文字を返します。lenが0より小さいか文字列の長さより大きい場合、指定した文字列は変更されずにそのまま返されます。
Length
Length(String): 文字列 (String) の長さを返します。
LowerCase
LowerCase(String): 文字列を小文字に変換します。
PadLeft
PadLeft (String, len, char): 文字列を指定した文字で、指定した長さまで左に埋め込みます。パディング文字(char)の長さが2文字以上の場合、最初の文字のみが使用されます。
PadRight
PadRight (String, len, char): 文字列を指定した文字で、指定した長さまで右に埋め込みます。パディング文字(char)の長さが2文字以上の場合、最初の文字のみが使用されます。
REGEX_CountMatches
REGEX_CountMatches(String,pattern,icase): 文字列内でパターンに一致した回数を返します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
REGEX_Match
REGEX_Match(String,pattern,icase): 正規表現の出現について文字列を検索します。文字列が最初の文字から最後までのパターンと一致するかどうかを示します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
REGEX_Replace
REGEX_Replace(String, pattern, replace, icase): 正規表現検索パターンから得られた文字列を返し、文字列を置き換えます。
注記
この関数は、DatabricksのLive Queryでは使用できません。
Replace
Replace(String, Target, Replacement): 文字列 (Target) の各出現箇所を文字列 (Replacement) で置き換えた後の文字列 (String) を返します。
ReplaceChar
ReplaceChar(String, y, z): 文字(y)を見つけるたびに文字(z)で置き換えた後の文字列(String)を返します。置換文字(z)が複数の文字を含む文字列である場合、最初の文字のみが使用されます。文字 (z) が空の場合、文字 (y) の任意の文字に一致する各文字 (String) は、削除されます。
ReplaceFirst
ReplaceFirst(String, Target, Replacement): 最初に出現した文字列(Target)を文字列(Replacement)で置き換えた後の文字列(String)を返します。
ReverseString
ReverseString(String): 文字列のすべての文字の順番を反転します。
注記
この関数は、DatabricksのLive Queryでは使用できません。
Right
Right(String, len): 文字列の最後の (len) 文字を返します。lenが0より小さいか文字列の長さより大きい場合、指定した文字列は変更されずにそのまま返されます。
StartsWith
StartsWith(String, Target, CaseInsensitive=1): 文字列が特定の文字列で始まるかどうかをチェックします。文字列(String)が特定の文字列(Target)ではじまる場合はTrue、それ以外はFalseを返します。
STRCSPN
STRCSPN(String, y): 文字列(String)内で、文字列(y)に含まれる文字以外の文字で構成される最初のセグメントの長さを返します。
StripQuotes
StripQuotes(String): 文字列の末尾から見つかった一連の引用符またはアポストロフィを削除します。
STRSPN
STRSPN(String, y): 文字列(y)内に含まれる文字で構成される文字列(String)の最初のセグメントの長さを返します。
Substring
Substring(String, start, length): (Start) で始まり、(length) で終了する部分文字列を返します (指定されている場合)。
TitleCase
TitleCase(String): 文字列をタイトルケースに変換します。
Trim
Trim(String, y): 文字列 (y) 内の文字を文字列 (String) の終わりから削除します。Yはオプションで、既定では空白をトリミングします。TRIM関数の例では、指定された文字がトリミングされることに注意してください。文字の順序は関係ありません。
TrimLeft
TrimLeft(String, y): 文字列(y)の文字を文字列(String)の先頭から削除します。Yはオプションで、既定では空白をトリミングします。
TrimRight
TrimRight(String, y): 文字列(y)の文字を文字列(String)の末尾から削除します。Yはオプションで、既定では空白をトリミングします。
Uppercase
Uppercase(String): 文字列を大文字に変換します。
テスト
テスト関数はデータ比較を実行します。テスト関数を使用して、値のデータ型を識別したり、値が存在するかどうかを判断したりします。パラメーターと例については、ワークフローテスト機能を参照してください。
CompareDigits
CompareDigits(a, b, nNumDigits): 2つの数値を比較し、指定した桁数(nNumDigits)と同じかどうかを判断します。
CompareEpsilon
CompareEpsilon(a, b, epsilon): 2つの浮動小数点数を比較し、その差がイプシロン以内の場合はTrueを返します。
EqualStrings
EqualStrings(a,b): 文字列同士を比較して、完全に一致するかどうかを判断します。aおよびbの両方のすべての文字が同一の場合はTrueを返し、1つ以上の文字が同一でない場合はFalseを返します。
IsEmpty
IsEmpty(v): v が NULL か "" に等しいかどうかをテストします。
IsInteger
IsInteger(v): (v)に整数に変換できる値が含まれているかどうかをテストします。含まれている場合は、True を返します。
IsLowerCase
IsLowerCase(String): 文字列内のすべての(1つ以上の)アルファベット文字が小文字の場合はTrueを返し、1つ以上のアルファベット文字が大文字の場合はFalseを返します。この関数は、アルファベット以外の文字を無視します。この関数は大文字と小文字が区別された文字にのみ適用され、またすべての言語の文字に適用されるわけではないことにご注意ください。
IsNull
IsNull(v): (v)がNULLかどうかをテストします。v が NULL の場合は True を返し、それ以外の場合は False を返します。
IsNumber
IsNumber(v): vのフィールドタイプが数値かどうかをテストします。
IsString
IsString(v): vのフィールドタイプが文字列かどうかをテストします。
IsUpperCase
IsUpperCase(String): 文字列内のすべての(1つ以上の)アルファベット文字が大文字の場合はTrueを返し、1つ以上のアルファベット文字が小文字の場合はFalseを返します。この関数は、アルファベット以外の文字を無視します。この関数は大文字と小文字が区別された文字にのみ適用され、またすべての言語の文字に適用されるわけではないことにご注意ください。