無

NdbIndexOperation、NdbScanOperation

NdbOperation 表示「「通用」」資料操作。其子類別表示更特定類型的操作。如需操作類型及其對應的 NdbOperation 子類別清單，請參閱 NdbOperation::Type。

下表列出此類別的公用方法以及每個方法的用途或用法

此類別沒有公用建構函式。若要建立 NdbOperation 的執行個體，您必須使用 NdbTransaction::getNdbOperation()。

NdbOperation 類別定義了三個公用類型，如下表所示

此類型用於決定失敗的操作是否應強制中止交易。它用作 execute() 方法的引數—如需更多資訊，請參閱 NdbTransaction::execute()。

下表顯示了可能的值及其描述

將兩個暫存器的內容相加；將結果儲存在第三個暫存器中。

int add_reg
    (
      Uint32 RegSource1, 
      Uint32 RegSource2, 
      Uint32 RegDest
    )

成功則傳回 0，否則傳回 -1。

如果指定的欄位為 NULL，則分支至直譯程式中的標籤。

int branch_col_eq_null
    (
      Uint32 ColId, 
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果指定的欄位不為 NULL，則分支至直譯程式中的標籤。

int branch_col_ne_null
    (
      Uint32 ColId, 
      Uint32 Label
    )

無

如果給定的值等於指定欄位的值，則分支至直譯程式中的標籤。

int branch_col_eq
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果給定的值不等於指定欄位的值，則分支至直譯程式中的標籤。

int branch_col_ne
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果給定的值小於欄位值，則分支至直譯程式中的標籤。

int branch_col_lt
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果給定的值小於或等於欄位值，則分支至直譯程式中的標籤。

int branch_col_le
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0；否則傳回 -1。

如果給定的值大於欄位值，則分支至直譯程式中的標籤。

int branch_col_gt
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果給定的值大於或等於欄位值，則分支至直譯程式中的標籤。

int branch_col_ge
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功時為 0，否則為 -1。

如果欄位值符合萬用字元模式則跳轉。此方法和 branch_col_notlike() 方法都支援 MySQL LIKE 運算子使用的萬用字元：% 代表 0 個或多個字元的任何字串，而 _ 代表任何單一字元。

欄位的型別必須是 CHAR、VARCHAR、BINARY 或 VARBINARY 其中之一。

int branch_col_like
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果欄位值不符合給定的萬用字元模式則跳轉。此方法和 branch_col_like() 方法都支援與 MySQL LIKE 運算子相同的萬用字元 % (0 個或多個字元) 和 _ (任何一個字元)。

欄位的型別必須是 CHAR、VARCHAR、BINARY 或 VARBINARY 其中之一。

int branch_col_notlike
    (
      Uint32 ColId, 
      const void* val, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果欄位的值與位元遮罩進行邏輯位元 AND 運算後，等於該位元遮罩，則跳轉。

另請參閱 位元邏輯比較。

int branch_col_and_mask_eq_mask
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果欄位的值與位元遮罩進行邏輯位元 AND 運算後，不等於該位元遮罩，則跳轉。

另請參閱 位元邏輯比較。

int branch_col_and_mask_ne_mask
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功時為 0，否則為 -1。

如果欄位的值與位元遮罩進行邏輯位元 AND 運算後，等於 0，則跳轉。

另請參閱 位元邏輯比較。

int branch_col_and_mask_eq_zero
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果欄位的值與位元遮罩進行邏輯位元 AND 運算後，不等於 0，則跳轉。

另請參閱 位元邏輯比較。

int branch_col_and_mask_ne_zero
    (
      Uint32 ColId, 
      const void* mask, 
      Uint32 len,
      bool,
      Uint32 Label
    )

成功時返回 0，否則返回 -1。

在直譯程式中定義搜尋條件。將右側暫存器值與左側值比較；如果右側值大於或等於左側值，則跳轉到標籤。

int branch_ge
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

在直譯程式中定義搜尋條件。將右側暫存器值與左側值比較；如果右側值大於左側值，則跳轉到標籤。

int branch_gt
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

在直譯程式中定義搜尋條件。將右側暫存器值與左側值比較；如果右側值小於左側值，則跳轉到標籤。

int branch_le
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

在直譯程式中定義搜尋條件。將右側暫存器值與左側值比較；如果右側值小於或等於左側值，則跳轉到標籤。

int branch_lt
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

當兩個暫存器值相等時，跳轉到直譯程式中的標籤。

int branch_eq
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

當兩個暫存器值不相等時，跳轉到直譯程式中的標籤。

int branch_eq
    (
      Uint32 RegLvalue, 
      Uint32 RegRvalue, 
      Uint32 Label
    )

成功則傳回 0，否則傳回 -1。

如果暫存器值不是 NULL，則跳轉到直譯程式中的標籤。

int branch_ne_null
    (
      Uint32 RegLvalue, 
      Uint32 Label
    )

成功時返回 0；否則返回 -1。

如果暫存器值為 NULL，則跳轉到直譯程式中的標籤。

int branch_ne_null
    (
      Uint32 RegLvalue, 
      Uint32 Label
    )

成功則傳回 0；否則傳回 -1。

跳轉到直譯程式中的標籤。

int branch_label
    (
      Uint32 Label
    )

成功時為 0；否則為 -1。

呼叫直譯程式中的子常式。

int call_sub
    (
      Uint32 Subroutine
    )

如果成功，則返回 0；否則返回 -1。

在直譯運算中定義跳轉標籤。標籤會從 0 開始自動編號。

int def_label
    (
      int labelNumber
    )

成功時為 labelNumber，否則為 -1。

在直譯程式中定義子常式。

int def_subroutine
    (
      int SubroutineNumber
    )

成功則傳回 0，否則傳回 -1。

此方法將 NdbOperation 定義為 DELETE 運算。當呼叫 NdbTransaction::execute() 方法時，此運算會從資料表中刪除一個 Tuple。

virtual int deleteTuple
    (
      void
    )

無.

成功時返回 0，失敗時返回 -1。

此方法定義具有相等性的搜尋條件。如果屬性具有給定的值，則條件為真。若要設定多個屬性的搜尋條件，請多次呼叫 equal()；在這種情況下，必須滿足所有條件才能選取 Tuple。

如果屬性的大小固定，則其值必須包含所有位元組。特別是，Char 值必須填補原生空間。如果屬性的大小可變，則其值必須以 1 或 2 個小端長度位元組開始 (如果其型別為 Long*，則為 2 個)。

使用 insertTuple() 時，您也可以使用 setValue() 定義搜尋索引鍵。請參閱 NdbOperation::setValue()。

有 10 個版本的 equal()，每個版本的參數略有不同。所有這些版本都會顯示在此處

int  equal
    (
      const char* name,
      const char* value
    )

int  equal
    (
      const char* name,
      Int32       value
    )

int  equal
    (
      const char* name,
      Uint32      value
    )

int  equal
    (
      const char* name,
      Int64       value
    )

int  equal
    (
      const char* name,
      Uint64      value
    )

int  equal
    (
      Uint32      id,
      const char* value
    )

int  equal
    (
      Uint32 id,
      Int32  value
    )

int  equal
    (
      Uint32 id,
      Uint32 value
    )

int  equal
    (
      Uint32 id,
      Int64  value
    )

int  equal
    (
      Uint32 id,
      Uint64 value
    )

此方法需要兩個參數

如果發生錯誤，則返回 -1。

此方法用於取代 blob 屬性的 getValue() 或 setValue()。它會建立一個 blob 控制代碼（NdbBlob 物件）。使用相同引數的第二次呼叫會傳回先前建立的控制代碼。此控制代碼會連結到操作，並自動維護。

此方法有兩種形式，取決於呼叫時使用的是 blob 屬性的名稱還是 ID

virtual NdbBlob* getBlobHandle
    (
      const char* name
    )

或

virtual NdbBlob* getBlobHandle
    (
      Uint32 id
    )

此方法採用單一參數，可以是下列其中之一

無論使用哪種參數類型，此方法都會傳回 NdbBlob 執行個體的指標。

傳回目前操作的鎖定控制代碼指標。與 NdbRecord 搭配使用時，必須先使用 OO_LOCKHANDLE 操作選項要求鎖定控制代碼。對於其他操作，可以單獨使用此方法。在任何情況下，在執行操作之前，都無法使用此方法傳回的 NdbLockHandle 物件。

const NdbLockHandle* getLockHandle
    (
      void
    ) const

或

const NdbLockHandle* getLockHandle
    (
      void
    )

無.

可供 NdbTransaction 方法 unlock() 和 releaseLockHandle() 使用的 NdbLockHandle 指標。

此方法取得操作的鎖定模式。

LockMode getLockMode
    (
      void
    ) const

無.

LockMode 值。請參閱 NdbOperation::LockMode。

此方法取得最近發生的錯誤（NdbError 物件）。

const NdbError& getNdbError
    (
      void
    ) const

無.

NdbError 物件。

此方法擷取發生最新錯誤的方法編號。

int getNdbErrorLine
    (
      void
    ) const

無.

方法編號（整數）。

此方法用於擷取與操作相關聯的資料表物件。

const NdbDictionary::Table* getTable
    (
      void
    ) const

無.

指向 Table 執行個體的指標。

此方法擷取操作使用的資料表名稱。

const char* getTableName
    (
      void
    ) const

無.

資料表名稱。

取得此操作的 NdbTransaction 物件。

virtual NdbTransaction* getNdbTransaction
    (
      void
    ) const

無.

指向 NdbTransaction 物件的指標。

此方法用於擷取此操作的存取類型。

Type getType
    (
      void
    ) const

無.

Type 值。

此方法準備擷取屬性值。NDB API 會為 NdbRecAttr 物件配置記憶體，稍後將使用該物件來取得屬性值。這可以使用許多 NdbRecAttr 存取子方法之一來完成，要使用的確切方法取決於屬性的資料類型。（這包括泛型 NdbRecAttr::aRef() 方法，它會以 char* 擷取資料，而不論其實際類型為何。您應該注意，這不是類型安全的，需要使用者明確轉換。）

此方法不會從資料庫提取屬性值；在呼叫 NdbTransaction::execute() 之前，此方法傳回的 NdbRecAttr 物件是不可讀取或列印的。

如果特定屬性未變更，則對應的 NdbRecAttr 具有 UNDEFINED 狀態。可以使用 NdbRecAttr::isNULL() 來檢查此情況，在這種情況下，它會傳回 -1。

請參閱 NdbTransaction::execute() 和 NdbRecAttr::isNULL()。

此方法有三個版本，每個版本都有不同的參數

NdbRecAttr* getValue
    (
      const char* name,
      char*       value = 0
    )

NdbRecAttr* getValue
    (
      Uint32 id,
      char*  value = 0
    )

NdbRecAttr* getValue
    (
      const NdbDictionary::Column* col,
      char*                        value = 0
    )

此方法的所有三種形式都有兩個參數，第二個參數是選擇性的（預設值為 0）。它們僅在第一個參數的類型方面有所不同，可以是下列任何一種

在這三種情況下，第二個參數都是一個字元緩衝區，其中會傳回非 NULL 屬性值。如果屬性為 NULL，則只會將其儲存在此方法傳回的 NdbRecAttr 物件中。

如果在 getValue() 方法呼叫中未指定 值，或如果傳遞 0 作為值，則 NdbRecAttr 物件會提供記憶體管理來儲存接收到的資料。如果接收到的資料的最大大小超過小固定大小，則會使用 malloc() 來儲存資料：對於小大小，會提供一個小的固定內部緩衝區（範圍為 32 個位元組）。此儲存體由 NdbRecAttr 執行個體管理；它會在釋放操作時釋放，例如在交易關閉時；您想要保留的任何寫入此處的資料都應在此記憶體釋放發生之前複製到其他位置。

如果您為 值 傳遞非零指標，則假設此指標指向的記憶體部分足以容納資料行的最大值；任何傳回的資料都會寫入該位置。指標應至少為 32 位元對齊。

在此方法中，無法使用索引欄來取代資料表欄。在資料表欄不可用的情況下，您可以使用使用 getName() 取得的屬性名稱來代替。

指向 NdbRecAttr 物件的指標，該物件用於保留屬性的值，或 NULL 指標，表示發生錯誤。

NdbOperation

此結構用於指定要作為 NdbRecord 操作一部分取得的額外值。

構成此結構的元素如下表所示

無法使用 GetValueSpec 指定 Blob 讀取。

解譯的程式指令，將值加到屬性。可以透過名稱或 ID 指定屬性。因此，此方法有四個版本，它們具有略有不同的參數，如簽章下所示。

此指令使用暫存器 6 和 7，並在其操作過程中覆寫這些暫存器。

對於掃描和 NdbRecord 操作，請改用 NdbInterpretedCode 介面。

int incValue
    (
      const char* anAttrName, 
      Uint32 aValue
    )

int incValue
    (
      const char* anAttrName, 
      Uint64 aValue
    )

int incValue
    (
      Uint32 anAttrId, 
      Uint32 aValue
    )

int incValue
    (
      Uint32 anAttrId, 
      Uint64 aValue
    )

成功則傳回 0，否則傳回 -1。

此方法定義要作為 INSERT 操作的 NdbOperation。當呼叫 NdbTransaction::execute() 方法時，此操作會將新的元組新增到表格。

virtual int insertTuple
    (
      void
    )

無.

成功時返回 0，失敗時返回 -1。

終止整個交易。

int interpret_exit_last_row
    (
      void
    )

無

成功時返回 0；否則返回 -1。

使用狀態 NOT OK 和可選的錯誤代碼（請參閱第 2.4.2 節，「依類型劃分的 NDB 錯誤代碼」）退出解譯的程式。

int interpret_exit_nok
    (
      Uint32 ErrorCode
    )

int interpret_exit_nok
    (
      void
    )

成功則傳回 0，否則傳回 -1。

使用狀態 OK 退出解譯的程式。

int interpret_exit_ok
    (
      void
    )

無

成功則傳回 0，否則傳回 -1。

使用解譯的程式刪除元組。

virtual 
int interpretedDeleteTuple
    (
      void
    )

無.

成功則傳回 0，否則傳回 -1。

使用解譯的程式更新元組。

virtual
int interpretedUpdateTuple
    (
      void
    )

無.

成功則傳回 0，否則傳回 -1。

使用解譯的程式寫入元組。

virtual
int interpretedWriteTuple
    (
      void
    )

無.

成功則傳回 0，否則傳回 -1。

將 32 位元常數值載入暫存器。

int load_const_u32
    (
      Uint32 RegDest, 
      Uint32 Constant
    )

成功則傳回 0，否則傳回 -1。

將 64 位元常數值載入暫存器。

int load_const_u64
    (
      Uint64 RegDest, 
      Uint64 Constant
    )

成功則傳回 0，否則傳回 -1。

將 NULL 載入暫存器。

int load_const_null
    (
      Uint32 RegDest
    )

成功則傳回 0，否則傳回 -1。

此類型描述執行讀取操作時使用的鎖定模式。

下表顯示此類型的可能值及其描述

還支援髒讀 (LM_Dirty)，但這通常僅用於內部用途，不應用於部署在生產環境中的應用程式。

NdbOperation

這些選項會傳遞至 NdbRecord 的主要索引鍵和掃描接管操作方法，這些方法在 NdbTransaction 和 NdbScanOperation 類別中定義。

大多數 NdbTransaction::*Tuple() 方法（請參閱第 2.3.25 節，「NdbTransaction 類別」）採用額外的 sizeOfOptions 參數。這是可選的，旨在允許介面實作保持與可能傳遞舊版（較小）OperationOptions 結構的舊版未重新編譯的用戶端向後相容。此效果是透過將 sizeof(OperationOptions) 傳遞到此參數中來實現的。

每個選項類型都透過在 optionsPresent 中設定對應的位元來標記為存在。（只有在 optionsPresent 中標記的選項類型才需要有合理的資料。）所有資料都會在操作定義時從 OperationOptions 結構（和任何子結構）中複製出來。如果不需要選項，則可以傳遞 NULL 來代替。

構成此結構的元素如下表所示

將依名稱或 ID 識別的屬性讀入暫存器。

int read_attr
    (
      const char* anAttrName, 
      Uint32 RegDest
    )

int read_attr
    (
      Uint32 anAttrId, 
      Uint32 RegDest
    )

成功時，傳回 0；否則傳回 -1。

此方法將 NdbOperation 定義為 READ 作業。當呼叫 NdbTransaction::execute() 方法時，此作業會讀取一個元組。

virtual int readTuple
    (
      LockMode mode
    )

mode 指定讀取作業使用的鎖定模式。如需可能的值，請參閱 NdbOperation::LockMode。

成功時返回 0，失敗時返回 -1。

從直譯程式子常式返回。

int ret_sub
    (
      void
    )

無.

成功則傳回 0，否則傳回 -1。

此方法定義要設定或更新的屬性。

有許多 NdbOperation::setValue() 方法會將特定類型作為輸入（傳值而非傳遞指標）。應用程式程式設計師有責任使用正確的類型。

NDB API 會檢查應用程式是否將正確的長度傳送到介面，如 length 參數中所指定。 char* 值可以包含任何資料類型或任何類型的陣列。如果未提供長度，或將長度設定為零，則 API 會假設指標是正確的，並且不會檢查它。

若要設定 NULL 值，請使用以下結構

setValue("ATTR_NAME", (char*)NULL);

當您使用 insertTuple() 時，NDB API 會自動偵測到它應該改用 equal()。

此外，在使用 insertTuple() 時，無需在其他屬性之前對索引鍵屬性使用 setValue()。

有 14 個版本的 NdbOperation::setValue()，每個版本的參數略有不同，如下所示

int setValue
    (
      const char* name,
      const char* value
)

int setValue
    (
      const char* name,
      Int32       value
    )

int setValue
    (
      const char* name,
      Uint32      value
    )

int setValue
    (
      const char* name,
      Int64       value
    )

int setValue
    (
      const char* name,
      Uint64      value
    )

int setValue
    (
      const char* name,
      float       value
    )

int setValue
    (
      const char* name,
      double      value
    )

int setValue
    (
      Uint32      id,
      const char* value
    )

int setValue
    (
      Uint32 id,
      Int32  value
    )

int setValue
    (
      Uint32 id,
      Uint32 value
    )

int setValue
    (
      Uint32 id,
      Int64  value
    )

int setValue
    (
      Uint32 id,
      Uint64 value
    )

int setValue
    (
      Uint32 id,
      float  value
    )

int setValue
    (
      Uint32 id,
      double value
    )

此方法需要以下兩個參數

如果失敗，則傳回 -1。

NdbOperation

此結構用於指定要設定的額外值，作為 NdbRecord 作業的一部分。

構成此結構的元素如下表所示

將兩個暫存器值的差儲存在第三個暫存器中。

int sub_reg
    (
      Uint32 RegSource1, 
      Uint32 RegSource2, 
      Uint32 RegDest
    )

成功則傳回 0，否則傳回 -1。

直譯程式指令，從直譯作業中的屬性減去一個值。 可以依名稱或 ID 指定屬性。 因此，此方法有四個版本，其參數略有不同，如 簽名 下所示。

與 incValue() 一樣，此指令使用暫存器 6 和 7，並在其操作過程中覆寫這些暫存器。

對於掃描和 NdbRecord 操作，請改用 NdbInterpretedCode 介面。

int subValue
    (
      const char* anAttrName, 
      Uint32 aValue
    )

int subValue
    (
      const char* anAttrName, 
      Uint64 aValue
    )

int subValue
    (
      Uint32 anAttrId, 
      Uint32 aValue
    )

int subValue
    (
      Uint32 anAttrId, 
      Uint64 aValue
    )

成功則傳回 0，否則傳回 -1。

Type 用於描述作業存取類型。每個存取類型都由 NdbOperation 或其子類別之一支援，如下表所示

下表顯示了可能的值及其描述

此方法將 NdbOperation 定義為 UPDATE 作業。當呼叫 NdbTransaction::execute() 方法時，此作業會更新資料表中找到的元組。

virtual int updateTuple
    (
      void
    )

無.

成功時返回 0，失敗時返回 -1。

從暫存器寫入屬性值。要寫入的屬性可以依名稱或 ID 指定。

int write_attr
    (
      const char* anAttrName, 
      Uint32 RegSource
    )

int write_attr
    (
      Uint32 anAttrId, 
      Uint32 RegSource
    )

成功時返回 0；否則返回 -1。

此方法將 NdbOperation 定義為 WRITE 作業。當呼叫 NdbTransaction::execute() 方法時，此作業會將元組寫入資料表。如果元組已存在，則會更新它；否則會執行插入。

virtual int writeTuple
    (
      void
    )

無.

成功時返回 0，失敗時返回 -1。