Object

無.

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

ForeignKey 類別有一個公用類型，即 FkAction 類型。

建立全新的外部索引鍵參考，或是現有外部索引鍵參考的複本。

新執行個體

ForeignKey
    (
      void
    )

複製建構函式

ForeignKey
    (
      const ForeignKey&
    )

對於新執行個體：無。

對於複製建構函式：現有 ForeignKey 執行個體的參考。

ForeignKey 的新執行個體。

下表顯示可能的值，以及對應的參考動作

擷取呼叫此方法的 ForeignKey 執行個體的名稱。

const char* getName
    (
      void
    ) const

無.

ForeignKey 的名稱。

擷取呼叫此方法的 ForeignKey 執行個體的父資料表。

const char* getParentTable
      (
        void
      ) const

無.

指向 ForeignKey 父資料表的指標。

擷取呼叫此方法的 ForeignKey 執行個體的子資料表。

const char* getChildTable
      (
        void
      ) const

無.

指向此 ForeignKey 子資料表的指標。

擷取此 ForeignKey 父資料表中的資料行數。

unsigned getParentColumnCount
      (
        void
      ) const

無.

父資料表中的資料行數。

擷取此 ForeignKey 子資料表中的資料行數。

unsigned getChildColumnCount
      (
        void
      ) const

無.

子資料表中的資料行數。

如果子資料表參照父資料表的主索引鍵，則傳回 0。

const char* getParentIndex
    (
      void
    ) const

無.

請參閱說明。

如果子參照是使用子資料表的主索引鍵解析的，則傳回 0。

const char* getChildIndex
    (
      void
    ) const

無.

請參閱說明。

此方法會取得指定索引的父資料表中外鍵欄位的序號。關於在 NDB API 中處理欄位的資訊，請參閱 Column::getColumnNo() 的文件。

int getParentColumnNo
    (
      unsigned no
    ) const

無.

欄位的序號。

此方法會取得指定索引的子資料表中外鍵欄位的序號。關於在 NDB API 中處理欄位的資訊，請參閱 Column::getColumnNo() 的文件。

int getChildColumnNo
    (
      unsigned no
    ) const

無.

欄位的序號。

取得外鍵的 ON UPDATE 動作。這是一個 ForeignKey::FkAction，且具有下列其中一個值：NoAction、Restrict、Cascade 或 SetNull。

FkAction getOnUpdateAction
    (
      void
    ) const

無.

欄位的序號。

取得外鍵的 ON DELETE 動作。這是一個 ForeignKey::FkAction，且具有下列其中一個值：NoAction、Restrict、Cascade 或 SetNull。

FkAction getOnDeleteAction
    (
      void
    ) const

無.

欄位的序號。

設定呼叫此方法的 ForeignKey 實例的名稱。

void setName
    (
      const char*
    )

ForeignKey 的名稱。

無.

設定 ForeignKey 的父資料表，可提供資料表的參考，以及選擇性地提供一個索引來作為外鍵。

void setParent
    (
      const Table&,
      const Index* index = 0,
      const Column* cols[] = 0
    )

一個 Table 的參考 (必要)。選擇性地，可以使用指定的欄位或多個欄位的索引。

無.

設定 ForeignKey 的子資料表，可提供資料表的參考，以及選擇性地提供一個索引來作為外鍵。

void setChild
    (
      const Table&,
      const Index* index = 0,
      const Column* cols[] = 0
    )

一個 Table 的參考 (必要)。選擇性地，可以使用指定的欄位或多個欄位的索引。

無.

設定外鍵的 ON UPDATE 動作。

void setOnUpdateAction
  (
    FkAction
  )

要執行的 ON UPDATE 動作。這必須是一個 ForeignKey::FkAction，其值必須是 NoAction、Restrict、Cascade 或 SetNull 其中之一。

無

設定外鍵的 ON DELETE 動作。

void setOnUpdateAction
  (
    FkAction
  )

要執行的 ON UPDATE 動作，類型為 ForeignKey::FkAction。必須是 NoAction、Restrict、Cascade 或 SetNull 其中之一的值。

無

取得此 ForeignKey 物件的物件狀態 (請參閱 Object::Status)。

virtual Object::Status getObjectStatus
    (
      void
    ) const

無.

ForeignKey 物件的狀態，以 Object::Status 類型的值表示。請參閱此類型的文件，以了解可能的值及其解釋。

取得此 ForeignKey 物件的物件 ID (請參閱 Object::getObjectId())。

virtual int getObjectId
    (
      void
    ) const

無.

由 Object::getObjectId() 傳回的 ForeignKey 物件 ID。

取得此 ForeignKey 物件的物件版本 (請參閱 Object::getObjectVersion())。

virtual int getObjectVersion
    (
      void
    ) const

無.

由 Object::getObjectVersion() 傳回的 ForeignKey 物件的版本號碼 (整數)。