関数の概要

OceanBaseデータベースに組み込まれている関数は、SQLステートメント内で直接使用できます。各関数の引数に渡される値には期待されるデータ型があります。渡されたデータ型が期待されるものではない場合、OceanBaseデータベースはSQL関数を実際に実行する前に、引数として渡された値を期待されるデータ型に変換しようと試みます。

関数は演算子に似ており、いくつかのデータ要素を引数として入力し、結果を返します。しかし、関数は引数の形式において演算子とは大きく異なります。関数は含めることができる引数の数が不特定であり、1つから2つ、あるいはそれ以上の引数を持つことができます。

関数名(引数, 引数, ...)

関数は引数を全く持たない場合もあり、これは擬似列に似ています。ただし、擬似列は通常、結果セットの各行に対して異なる値を返しますが、変数を持たない関数は通常、各行に対して同じ値を返します。

本章では、関数を2つの大きなカテゴリに分類します。各カテゴリの関数の引数と最終的な戻り値には、それぞれ特定のデータ型があります：

• 単一行関数：数値関数、文字列を返す文字列関数、数値を返す文字列関数、日付時刻関数、汎用的な比較関数、変換関数、エンコード・デコード関数、NULL値関連関数、環境・識別関数、階層関数などが含まれます。

• 集計関数：集約関数と分析関数が含まれます。

単一行関数は、クエリ対象のテーブルまたはビューの各行に対して結果値を返します。これらの関数は、SQLステートメントの SELECT、WHERE、START WITH、CONNECT BY、HAVING 句などで使用できます。

分析関数と集約関数はどちらも、行セットグループ（行の集合）に対して集計計算を行います。違いは、集約関数は各グループごとに1つの値（1行）しか返せないのに対し、分析関数は各グループごとに複数の値（複数行）を返せる点です。行セットグループはウィンドウ（Window）とも呼ばれます。集約関数は通常、SELECT ステートメントの GROUP BY 句と共に使用されます。使用時、データベースはクエリ対象のテーブルまたはビューの行をいくつかのグループに分け、集約関数を各グループの行に適用し、各グループごとに1つの結果行を返します。

分析関数を使用する際は、特殊なキーワード OVER を使用してウィンドウを指定する必要があります。ウィンドウ関数の詳細については、分析関数の説明を参照してください。

算術演算関数

算術演算関数の引数と戻り値はいずれも数値型です。ほとんどの関数の戻り値のデータ型は NUMBER で、小数点以下38桁まで表現できます。一部の高等代数関連関数 COS()、COSH()、EXP()、LN()、LOG()、SIN()、SINH()、SQRT()、TAN()、TANH() の結果は小数点以下36桁まで、その他の代数関連関数 ACOS()、ASIN()、ATAN()、ATAN2() の結果は小数点以下30桁まで正確です。

文字列を返す文字列関数

関数の戻り値の最大長はデータ型の影響を受けます。例えば、関数の戻り値のデータ型が VARCHAR2 であるにもかかわらず、実際のサイズが VARCHAR2 データ型の上限を超えた場合、OceanBaseデータベースは結果を切り捨てて返しますが、クライアント側では警告は表示されません。

数字を返す文字列関数

数字を返す文字列関数は、指定された条件に基づいて数字を返します。例えば、ASCIIコード値や文字（文字列）の位置などです。

日付時刻関数

日付時刻関数でサポートされている入力パラメータのデータ型は、日付時刻（DATE）、タイムスタンプ（TIMESTAMP、TIMESTAMP WITH TIME ZONE、TIMESTAMP WITH LOCAL TIME ZONE）、および間隔（INTERVAL DAY TO SECOND、INTERVAL YEAR TO MONTH）の3種類です。

DATE データ型のみを入力パラメータとしてサポートする関数には、ADD_MONTHS、CURRENT_DATE, LAST_DAY、NEXT_DAY が含まれます。

上記の関数に TIMESTAMP 型のデータを渡そうとした場合、OceanBaseデータベースは内部で暗黙的なデータ型変換を行った後、関数に渡して演算を実行し、DATE 型の戻り値を返します。

日付時刻関数を使用する前に、SELECT * FROM NLS_DATABASE_PARAMETERS を実行して現在のNLSフォーマットを確認することをお勧めします。例は以下のとおりです：

obclient> SELECT * FROM NLS_DATABASE_PARAMETERS;
+-------------------------+------------------------------+
| PARAMETER               | VALUE                        |
+-------------------------+------------------------------+
| NLS_DATE_FORMAT         | DD-MON-RR                    |
| NLS_TIMESTAMP_FORMAT    | YYYY-MM-DD HH24:MI:SS        |
| NLS_TIMESTAMP_TZ_FORMAT | DD-MON-RR HH.MI.SSXFF AM TZR |
| NLS_TERRITORY           | AMERICA                      |
| NLS_SORT                | BINARY                       |
| NLS_COMP                | BINARY                       |
| NLS_CHARACTERSET        | AL32UTF8                     |
| NLS_NCHAR_CHARACTERSET  | AL16UTF16                    |
| NLS_DATE_LANGUAGE       | AMERICAN                     |
| NLS_LENGTH_SEMANTICS    | BYTE                         |
| NLS_NCHAR_CONV_EXCP     | FALSE                        |
| NLS_CALENDAR            | GREGORIAN                    |
| NLS_NUMERIC_CHARACTERS  | .,                           |
+-------------------------+------------------------------+
13 rows in set

本文中の例と表示形式が一致しない場合は、以下のコマンドを実行してフォーマットを変更できます：

obclient>ALTER SESSION SET NLS_DATE_FORMAT = 'YYYY-MM-DD HH24:MI:SS';
Query OK, 0 rows affected

obclient>ALTER SESSION SET NLS_TIMESTAMP_FORMAT = 'YYYY-MM-DD HH24:MI:SS.FF';
Query OK, 0 rows affected
/*戻り値の秒の小数部を9桁に設定する*/

obclient> ALTER SESSION SET NLS_TIMESTAMP_TZ_FORMAT = 'YYYY-MM-DD HH24:MI:SS.FF TZR TZD';
Query OK, 0 rows affected

残りの関数は、3種類のパラメータデータ型をサポートしており、戻り値と入力パラメータは同じデータ型です。

比較関数

このカテゴリの関数を使用すると、集合内の最大値と最小値を迅速に見つけることができます。

変換関数

このタイプの関数を使用して、元のデータ型を別のデータ型に変換できます。

エンコード/デコード関数

このタイプの関数を使用して、OceanBaseデータベースでデータのエンコードとデコードを実現できます。

NULL値関連関数

NULL値関連関数は、パラメータ内のNULL値を処理するために使用されます。ほとんどの関数では、入力パラメータがNULL値の場合、戻り値もNULL値になります。このような場合、NVL 関数を使用して、NULL以外の値を返すことができます。例えば、手数料を記録するテーブルの手数料列 commission_pct がNULL値の場合、式 NVL(commission_pct, 0) は0を返します。commission_pct の値がNULLではない場合、実際の手数料値を返します。

環境関連関数

環境関連関数は、主にセッションまたはテナントインスタンスに関連する環境情報を提供します。

階層関数

JSON関数

JSON関数は、JSON値の作成、操作、検索などを行います。

XML関数

XML関数は、XMLドキュメントの効率的なクエリ、更新、検索を実行できます。

TABLE FUNCTION

TABLE FUNCTION（テーブル関数）は、FROM 句で参照できる行セットの結果を返すために使用されます。

詳細については、TABLE FUNCTIONの概要を参照してください。

集計関数

集計関数は、一連の値に対して計算を実行し、単一の値を返します。集計関数はNULL値を無視します。集計関数は、SELECT ステートメントの GROUP BY 句と併用されることがよくあります。

分析関数

分析関数（一部のデータベースではウィンドウ関数とも呼ばれる）は、集約関数に似ており、常に一連の行の集合に基づいて計算を行います。違いは、集約関数が1つのグループから1行しか返せないのに対し、分析関数は各グループから複数行を返すことができ、グループ内の各行はウィンドウの論理計算の結果です。分析関数は、Self-Joinを必要とするクエリを大幅に最適化できます。

情報関数

空間関数

監査関数