BNF

このパラメータの値をBNF (バッカス記法)で表記すると、次のようになります。

<key-gen> ::=<table-or-view-name> "(" <generation-retrieval-method>, <retrieval-timing> ")" {[<delimiter>] <key-gen>}

<generation-retrieval-method> ::=none | driver | auto | """ <procedure-signature> """ | """ <function-signature>  """

<table-or-view-name> ::=<legal-undelimited-database-table-or-view- identifier>

<delimiter> ::=";" | "," | <white-space>

<procedure-signature> ::=<schema-qualifier> "." <stored-routine- name>"("<argument-list>")"

<function-signature> ::="?=" <procedure-signature>

<schema-qualifier> ::=<legal-undelimited-database-username-identifier>

<stored-routine-name> ::=<legal-undelimited-database-stored-routine -identifier>

<argument-list> ::=<column-name>{"," <column-name>}

<column-name> ::=<column-from-table-or-view-name-previously-specified>

生成または取得方法

生成または取得方法では、プライマリキー値の生成および取得(必要な場合)方法を指定します。可能な方法は、None、Driver、Auto、およびStored Procedure/Functionです。

usrというテーブルとview_usrというビューがあり、アイデンティティボールトがプライマリキー値の信頼されたソースである場合は、このパラメータの値は次のようになります。

usr(none); view_usr(none)

この方法を使用する場合は、CNではなくGUIDを親テーブルまたはビューのプライマリキー列にマップすることをお勧めします。

プロトタイピングの場合、または展開の初期段階では、ストアドプロシージャまたは関数が記述される前に購読者チャネルでプライマリキー値を生成することが望ましいことがよくあります。また、ストアドプロシージャまたは関数をサポートしないデータベースでこの方法を使用することもできます。ただし、運用環境でこの方法を使用する場合は、<add>イベントによって生成されるすべてのSQLステートメントを、シリアル化可能なトランザクションに含める必要があります。詳細については、トランザクション分離レベルを参照してください。

すべてのトランザクションをシリアル化可能にする代わりに、埋め込みのSQL属性を使用して個別のトランザクション分離レベルを設定することもできます。詳細については、トランザクション分離レベルを参照してください。

任意の数値列タイプの場合、購読者チャネルは、以下を使用してプライマリキー値を生成します。

列タイプが文字列の場合、購読者チャネルは、System.CurrentTimeMillis()の返り値を使用して値を生成します。他のデータタイプはサポートされていません。

usrというテーブルとview_usrというビューがあり、データベースがプライマリキー値の信頼されたソースである場合は、このパラメータの値は次のようになります。

usr(driver); view_usr(driver)

この方法を使用する場合は、スキーママッピングポリシーおよびチャネルフィルタでプライマリキー列を省略することをお勧めします。

一部のデータベースは、挿入される行のプライマリキー値を自動的に生成する識別列をサポートしています。この方法は、自動生成されるプライマリキー値を、JDBC 3インタフェースメソッドjava.sql.Statement.getGeneratedKeys():java.sql.ResultSetを使用して取得します。サポートされているサードパーティ製のJDBCドライバのうち、現在このメソッドをサポートしているのは、MySQL Connector/J JDBCドライバだけです。MySQL Connector/J JDBC Driverを参照してください。

usrというテーブルとview_usrというビューがあり、データベースがプライマリキー値の信頼されたソースである場合は、このパラメータの値は次のようになります。

usr(auto); view_usr(auto)

この方法を使用する場合は、スキーママッピングポリシーおよびチャネルフィルタでプライマリキー列を省略することをお勧めします。

以下を前提とした例を考えます。

この場合、パラメータの値は、次のようになります。

usr("?=func_last_usr_idu()"); view_usr("sp_last_view_usr_pk_idu(pk_idu)")

前の例では、パラメータはストアドプロシージャに渡されます。パラメータは、関数にも渡すことができますが、これは通常必要ありません。関数とは異なり、ストアドプロシージャは、通常、パラメータを通じて値を返します。ストアドプロシージャの場合、プライマリキー列は、IN OUTパラメータとして渡す必要があります。キーではにの列は、INパラメータとして渡す必要があります。

ストアドプロシージャと関数のどちらの場合も、パラメータの順序、数、およびデータタイプは、プロシージャまたは関数で想定されているパラメータの順序、数、データタイプに対応する必要があります。

この方法を使用する場合は、スキーママッピングポリシーおよびチャネルフィルタでプライマリキー列を省略することをお勧めします。

取得タイミング

「取得タイミング」パラメータは、プライマリキー値がいつ取得されるかを指定します。

<add>イベントでは、親テーブルまたはビューに対して、少なくとも1つのINSERTステートメントが常に生成されます。このパラメータのこの部分では、プライマリキー値を取得するタイミングを、最初のINSERTステートメントを基準として指定します。

次の例は、前の例に取得タイミング情報を追加したものです。

usr(none, before); view_usr(none, before)

usr(driver, before); view_usr(driver, after)

usr(auto, after); view_usr(auto, after)

usr("?=func_last_usr_idu()", before); view_usr("sp_last_view_usr_pk_idu(pk_idu)", after)

次の表は、このパラメータのプロパティのリストです。