NdbOperation

NdbIndexScanOperation

NdbScanOperation 類別代表在交易中使用的掃描操作。此類別繼承自 NdbOperation。

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

此類別沒有公用建構子。若要建立 NdbScanOperation 的執行個體，必須使用 NdbTransaction::getNdbScanOperation() 方法。

此類別定義兩個公用類型，如下所示

呼叫此方法會關閉掃描。使用此方法關閉掃描後，此掃描傳回的資料列將不再可用。

請參閱 具有獨佔鎖定的掃描，以取得關於多個執行緒嘗試使用獨佔鎖定執行相同掃描的資訊，以及這如何影響關閉掃描。

void close
    (
      bool forceSend = false,
      bool releaseOp = false
    )

此方法採用此處列出的兩個參數

無.

此方法用於刪除目前元組。

const NdbOperation* deleteCurrentTuple
    (
      NdbTransaction* takeOverTrans,
      const NdbRecord* record,
      char* row = 0,
      const unsigned char* mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOpts = 0
    )

如需更多資訊，請參閱 第 2.3.22 節「NdbRecord 介面」。

當搭配 NdbRecord 介面使用時，此方法採用此處列出的參數

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

取得此掃描的 NdbTransaction 物件。

NdbTransaction* getNdbTransaction
    (
      void
    ) const

無.

指向 NdbTransaction 物件的指標。

此方法用於判斷給定的掃描操作是否已修剪到單個分割區。對於使用 NdbRecord 定義的掃描，可以在執行掃描之前或之後呼叫此方法。對於未使用 NdbRecord 定義的掃描，getPruned() 僅在執行掃描後才有效。

bool getPruned
    (
      void
    ) const

無.

如果掃描被修剪到單個表格分割區，則傳回 true。

此方法會鎖定目前的 tuple。

可以使用一個選擇性參數呼叫此方法，方法如下所示

NdbOperation* lockCurrentTuple
    (
      void
    )

NdbOperation* lockCurrentTuple
    (
      NdbTransaction* lockTrans
    )

當使用 NdbRecord 時，此方法也支援下列簽名

NdbOperation *lockCurrentTuple
    (
      NdbTransaction* takeOverTrans,
      const NdbRecord* record,
      char* row = 0,
      const unsigned char* mask = 0
    )

此方法也支援指定一個或多個 OperationOptions (當使用 NdbRecord 時亦是如此)

NdbOperation *lockCurrentTuple
    (
      NdbTransaction* takeOverTrans,
      const NdbRecord* record,
      char* row = 0,
      const unsigned char* mask = 0,
      const NdbOperation::OperationOptions* opts = 0,
      Uint32 sizeOfOptions = 0
    )

此方法採用單個選擇性參數—應該執行鎖定的交易。如果省略此參數，則交易為目前的交易。

當使用 NdbRecord 介面時，此方法採用下列清單中所述的這些參數

在 NdbRecAttr 樣式的掃描上呼叫 NdbRecord 掃描鎖定接管無效，在 NdbRecord 樣式的掃描上呼叫 NdbRecAttr 樣式的掃描鎖定接管也無效。

此方法傳回指向 NdbOperation 物件的指標，或 NULL。

此方法用於擷取掃描交易中的下一個 tuple。在每次呼叫 nextResult() 之後，NdbOperation::getValue() 中定義的緩衝區和 NdbRecAttr 物件會使用掃描 tuple 中的值進行更新。

當在檔案結尾後執行 nextResult() 時，NDB 會傳回錯誤碼 4210 (Ndb 傳送的資訊超出指定的長度)，並且額外的交易物件會透過將其傳回正確 TC 節點的閒置清單來釋放。

可以使用兩種方式之一來調用此方法。第一個如下所示

int nextResult
    (
      bool fetchAllowed = true,
      bool forceSend = false
    )

也可以使用此方法，如下所示

int nextResult
    (
      const char*& outRow,
      bool fetchAllowed = true,
      bool forceSend = false
    )

此方法採用以下兩個參數

也可以使用以下三個參數呼叫此方法

此方法傳回下列 4 個整數值之一，其解譯方式如下列清單所示

請參閱第 2.5.5 節「NDB API 基本掃描範例」。

此方法用於執行掃描。

virtual int readTuples
    (
      LockMode mode = LM_Read,
      Uint32   flags = 0,
      Uint32   parallel = 0,
      Uint32   batch = 0
    )

此方法採用此處列出的四個參數

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

使用此方法重新啟動掃描，而無需變更其任何 getValue() 呼叫或搜尋條件。

int restart
    (
      bool forceSend = false
    )

呼叫此方法時，將 forceSend 設定為 true 以強制傳送交易。

成功時傳回 0；失敗時傳回 -1。

此類型的數值是與 readTuples() 方法一起使用的掃描旗標。可以使用多個旗標，在這種情況下，它們會 OR 在一起作為該方法的第二個引數。如需更多資訊，請參閱 NdbScanOperation::readTuples()。

下表顯示了可能的值，以及說明

NdbScanOperation

此資料結構用於將選項傳遞給 NdbRecord 為基礎的 scanTable() 和 scanIndex() 方法（位於 NdbTransaction 類別中）。每個選項類型都會在 optionsPresent 欄位中設定對應的位元，以標記為存在。只有 optionsPresent 欄位中標記的選項類型才需要有有意義的資料。

所有資料都會在操作定義時從 ScanOptions 結構（以及任何附加結構）中複製出來。如果不需要任何選項，則可以將 NULL 作為 ScanOptions 指標傳遞。

組成此結構的元素顯示在下表中

如需更多資訊，請參閱 第 2.3.22 節「NdbRecord 介面」。

此方法用於更新目前的元組。

最初，可以使用單個可選參數呼叫此方法，方法如下所示

NdbOperation* updateCurrentTuple
    (
      void
    )


NdbOperation* updateCurrentTuple
    (
      NdbTransaction* updateTrans
    )

使用掃描 NdbRecord 時，也可以使用此方法，如下所示

NdbOperation* updateCurrentTuple
    (
      NdbTransaction*      takeOverTrans,
      const NdbRecord*     record,
      const char*          row,
      const unsigned char* mask = 0
    )

請參閱 第 2.3.22 節「The NdbRecord Interface」以取得更多資訊。

此方法採用單個選擇性參數—應該執行鎖定的交易。如果省略此參數，則交易為目前的交易。

當使用 NdbRecord 介面時，此方法會採用下列參數，如下列清單所述

此方法會傳回 NdbOperation 物件或 NULL。