CUSTOM ラッパー

カスタムラッパーは、特定の実装を通じてソースへのアクセスを提供します。CUSTOM ラッパーは CUSTOM データソースに関連付けられます。このタイプのデータソースの作成プロセス (「 カスタムデータソース 」を参照) では、このタイプのラッパーを実装するクラスを指定する必要があります。

カスタムラッパーの開発方法については、開発者ガイドの「 カスタムラッパーの開発 」を参照してください。

CREATE WRAPPER CUSTOM ステートメントの構文 」では、CUSTOM タイプのラッパーを作成するための構文を示しています。作成時には、必須のパラメータと、ラッパーを特定するための作成元のデータソースの名前のみが受け入れられます (「 カスタムデータソース 」を参照)。

データソースラッパーが構成パラメータを受け入れる場合は、 PARAMETERS 句で指定できます。

URIPARAM 句は常に EXTERN 句と一緒に使用され、このフィールドが補間変数の値を表すことを示します。 URIPARAM を追加することで、フィールドの値は URL のクエリパラメータとしてエンコードされます。 URIPARAM は、ラッパーが HTTP パスを使用し、変数が URL のクエリパラメータの値である場合にのみ、追加する必要があります。詳細については、管理ガイドの「 HTTP パス 」(「 Virtual DataPort でのパスの種類 」のサブセクション) を参照してください。

最後に、特定のラッパープロパティを指定できます (SOURCECONFIGURATION)。これらは、ラッパーで実行できる操作を判別するために使用されます。適用可能なプロパティは該当するステートメント宣言に示されています (「 Syntax of the CREATE WRAPPER CUSTOM statement 」)。詳細については、「 ラッパー構成プロパティ 」を参照してください。

CREATE WRAPPER CUSTOM ステートメントの構文
CREATE [ OR REPLACE ] WRAPPER CUSTOM <name:identifier>
    [ FOLDER = <literal> ]
    DATASOURCENAME = <name:identifier>
    [ PARAMETERS ( <param name:identifier> = <param value>
              [, <param name:identifier> = <param value> ]* ) ]
    [ OUTPUTSCHEMA ( <field> [, <field> ]* ) ]

<param value> ::=
      <text:literal> [ ENCRYPTED ]
    | <boolean value:boolean>
    | <number value:number>
    | ROUTE <route> [ <route_filters> ]

<field> ::=
      <name:identifier> [ = <mapping:literal> ] : <type:literal>
        [ ( { OBL | OPT } ) ]
        [ DEFAULTVALUE <literal> ]
        [ EXTERN ]
        [ <inline constraints> ]*
    | <name:identifier> [ = <mapping:literal> ] : ARRAY OF ( <register field> )
        [ DEFAULTVALUE <literal> ]
        [ <inline constraints> ]*
    | <name:register field>

<register field> ::=
    <name:identifier> [ = <mapping:literal> ] :
      REGISTER OF ( <field> [, <field> ]* )
        [ DEFAULTVALUE <literal> ]
        [ <inline constraints> ]*
<inline constraint> ::=
      [ NOT ] NULL
    | [ NOT ] UPDATEABLE
    | { SORTABLE [ ASC | DESC ] | NOT SORTABLE }
    | URIPARAM

以下 は、CUSTOM ラッパーの作成方法の例を示しています。ラッパーには testcustom という名前が付けられ、 testcustomds という CUSTOM データソースが関連付けられています。 testcustomds データソースラッパーは ENTERPRISE および YEAR の 2 つの構成パラメータを受け取ります。新しいラッパーは、それぞれ、値 'enterprise1''2006' を使用して構成されます。

カスタムラッパーの作成例
CREATE WRAPPER CUSTOM testcustom
    FOLDER '/wrappers/custom'
    DATASOURCENAME = testcustomds
    PARAMETERS (
    ENTERPRISE = 'enterprise1', YEAR = '2006'
) ;

カスタムラッパーを変更するための構文については、 以下 を参照してください。使用可能なオプションは、ラッパーを作成する場合と同じです。

ALTER WRAPPER CUSTOM ステートメントの構文
ALTER WRAPPER CUSTOM <name:identifier>
    [ DATASOURCENAME = <name:identifier> ]
    [ PARAMETERS ( <param name:identifier> = <param value>
    [, <param name:identifier> = <param value> ]* ) ]
    [ OUTPUTSCHEMA ( <field> [, <field> ]* ) ]

<param value> ::= (「 カスタムラッパーの作成例 」を参照)

<field> ::= (「 カスタムラッパーの作成例 」を参照)