BNF

此參數值的 BNF (Backus Naur Form) 表示如下所示：

<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 和預存程序/函數：

假設存在名為 usr 的表格和名為 view_usr 的檢視窗，其中 Identity Vault 是主索引鍵值的授權來源，此參數的值會如下所示：

usr(none); view_usr(none)

使用此方法時，建議您將 GUID 而不是公用名稱 (Common Name，CN) 映射至父表格或檢視窗的主索引鍵欄。

在建立原型時或在部署的啟始階段，經常需要在寫入預存程序或函數之前，讓「訂閱者」通道產生主索引鍵值。 您還可以針對不支援預存程序或函數的資料庫使用此方法。 然而，當您在生產環境中使用此方法時，<add> 事件產生的所有 SQL 陳述式都應該包含在可序列化的異動中。 如需其他資訊，請參閱異動隔離層級。

若不讓所有異動都成為可序列化，您還可以使用內嵌式 SQL 屬性設定個別的異動隔離層級。 如需其他資訊，請參閱異動隔離層級。

針對所有數值欄類型，「訂閱者」通道會使用下列方法產生主索引鍵值：

若為字串欄類型，「訂閱者」通道會使用 System.CurrentTimeMillis() 的傳回值來產生值。 不支援其他資料類型。

假設存在名為 usr 的表格和名為 view_usr 的檢視窗，其中資料庫是主索引鍵值的授權來源，此參數的值會如下所示：

usr(driver); view_usr(driver)

使用此方法時，建議您省略「綱要映射」規則和通道過濾器的主索引鍵欄。

部份資料庫支援會針對已插入列自動產生主索引鍵值的身份欄。 此方法會透過 JDBC 3 介面方法 java.sql.Statement.getGeneratedKeys():java.sql.ResultSet 取回自動產生的主索引鍵值。MySQL Connector/J JDBC 驅動程式是目前實作此方法唯一受支援的協力廠商 JDBC 驅動程式。 請參閱MySQL Connector/J JDBC 驅動程式。

假設存在名為 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> 事件會一直針對父表格或檢視窗產生至少一個 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)

下表列出此參數的內容：