10.4.1.1 SQL表関数のパラメータ

SQL表関数の中には、共通のパラメータを持つものもあれば、その関数に固有のパラメータを持つものもあります。

SQL表関数のパラメータは次のとおりです。

表10-12 SQL表関数のパラメータ

パラメータ 説明

INP_NAM

SCR_NAMEパラメータで指定されたR関数に渡すデータを指定する表またはビューの名前。別のユーザーが所有するテーブルまたはビューを使用する場合は、<owner name>.<table/view name>という形式を使用します。指定された表またはビューに対する読取りアクセス権が必要です。

ノート:

この引数は、rqEval2を除くすべてのSQL表関数用です。

PAR_LST

SCR_NAMEパラメータで指定されたユーザー定義R関数に渡す追加パラメータが含まれるJSON文字列。oreで始まる特殊な制御引数は、SCR_NAMEで指定された関数に渡されず、関数の呼出し前後の動作を制御します。たとえば、欠損値が含まれる行を入力表から省略するには、{"ore.na.omit":true}を使用します。

関連項目: 特殊な制御引数

OUT_FMT

出力表の定義。この引数の値は、NULLか、SCR_NAMEで指定されたR関数により返されたR data.frameの構造を定義する文字列にすることができます。文字列は、SELECT文、'XML'または'PNG'にできます。

ファンクションによって返される出力の形式。

次のいずれかになります。
  • プロトタイプとして使用する表またはビューの名前。別のユーザーが所有するテーブルまたはビューを使用する場合は、<owner name>.<table/view name>という形式を使用します。指定された表またはビューに対する読取りアクセス権が必要です。
  • ファンクションによって返された表の列名およびデータ型を指定するJSON文字列。イメージ・データは破棄されます。
  • 文字列'XML'。返される表にXML文字列であるCLOBが含まれることを指定します。XMLには構造化データとイメージの両方が含まれる可能性があり、最初に構造化Rオブジェクトまたは半構造化Rオブジェクトが返され、次にR関数により生成されたイメージが続きます。
  • 文字列'PNG'。返される表に、R関数によって生成されたイメージを格納するBLOBが含まれることを指定します。イメージはPNGバイトとして返されます。

関連項目: 出力形式

GRP_COL

rqGroupEval2関数の場合、グループ化列の名前。

ROW_NUM

rqRowEval2関数の場合、R関数の各呼出しに渡す行数。

SCR_NAME

OML4Rスクリプト・リポジトリ内のスクリプトの名前。

SCR_OWNER

OML4Rスクリプト・リポジトリ内のスクリプトの所有者。デフォルト値は「NULL」です。値がNULLの場合、ユーザーのスクリプト・リポジトリでRスクリプトを検索します。