MySQL NDB集群API开发指南::2.3.6 ForeignKey类

ForeignKey类概述

父类

对象

子类

没有一个。

方法

类的公共方法ForeignKey类以及每个方法的目的或用途:

表2.19 ForeignKey类的方法和说明

的名字	描述
`ForeignKey ()`	类构造函数
`~ ForeignKey ()`	类的析构函数
`getName ()`	获取外键的名称
`getParentTable ()`	获取外键的父表
`getChildTable ()`	获取外键的子表
`getParentColumnCount ()`	获取父表中的列数
`getChildColumnCount ()`	获取子表中的列数
`getParentColumnNo ()`	获取父表中的列号
`getChildColumnNo ()`	获取子表中的列号
`getParentIndex ()`	如果键指向父表的主键，则返回0
`getChildIndex ()`	如果使用子表的主键解析子引用，则返回0
`getOnUpdateAction ()`	获取外键更新操作(`FkAction`)
`getOnDeleteAction ()`	获取外键的删除操作(`FkAction`)
`setName ()`	设置外键的名称
`setParent ()`	设置外键的父表
`setChild ()`	设置外键的子表
`setOnUpdateAction ()`	设置外键更新动作(`FkAction`)
`setOnDeleteAction ()`	设置外键的删除操作(`FkAction`)
`getObjectStatus ()`	获取对象状态
`getObjectId ()`	获取对象ID
`getObjectVersion ()`	获取对象版本

类型

的ForeignKey类有一个公共类型FkAction类型。

ForeignKey ()

描述

创建一个全新的外键引用，或者一个现有外键引用的副本。

签名

新实例:

外键(void)

拷贝构造函数:

外键(const外键&)

参数

对于一个新实例:没有一个。

的一个现有实例的引用ForeignKey。

返回值

的新实例ForeignKey。

ForeignKey: FkAction

介绍信息FkAction，它是一种枚举，当对父表执行更新或删除操作时，它为外键的引用操作建模。

枚举值

下表显示了可能的值，以及相应的引用动作:

表2.20 ForeignKey::FkAction数据类型值和描述

的名字	描述
`再`	`不采取行动`:延期支票。
`限制`	`限制`:拒绝对父表的操作。
`级联`	`级联`:对父表中的行执行操作;对子表中的匹配行执行相同的操作。
`SetNull`	`设置为空`:对父表中的行执行操作;将子表中任何匹配的外键列设置为`零`。
`SetDefault`	`设置默认`:目前不支持NDB集群。

另请参阅外键约束,在MySQL手册。

ForeignKey: getName ()

描述

类的名称ForeignKey为其调用方法的实例。

签名

const char* getName (void) const

参数

没有一个。

返回值

The name of TheForeignKey。

ForeignKey: getParentTable ()

描述

类的父表ForeignKey为其调用方法的实例。

签名

const char* getParentTable (void) const对象

参数

没有一个。

返回值

类的父表的指针ForeignKey。

ForeignKey: getChildTable ()

描述

类的子表ForeignKey为其调用方法的实例。

签名

const char* getChildTable (void) const

参数

没有一个。

返回值

指向这个的子表的指针ForeignKey。

ForeignKey: getParentColumnCount ()

描述

检索此对象的父表中的列数ForeignKey。

签名

unsigned getParentColumnCount (void) const

参数

没有一个。

返回值

父表中的列数。

ForeignKey: getChildColumnCount ()

描述

检索的子表中的列数ForeignKey。

签名

unsigned getChildColumnCount (void) const

参数

没有一个。

返回值

子表中的列数。

ForeignKey: getParentIndex ()

描述

如果子表引用父表的主键，则返回0。

签名

const char* getParentIndex (void) const

参数

没有一个。

返回值

看到描述。

ForeignKey: getChildIndex ()

描述

如果使用子表的主键解析子引用，则返回0。

签名

const char* getChildIndex (void) const

参数

没有一个。

返回值

看到描述。

ForeignKey: getParentColumnNo ()

描述

此方法获取给定索引的父表中外键列的序列号。请参阅相关文档10bet官方网站专栏::getColumnNo ()，以获取有关处理NDB API中的列的信息。

签名

getParentColumnNo(无符号没有)常量

参数

没有一个。

返回值

列的序列号。

ForeignKey: getChildColumnNo ()

描述

此方法获取给定索引的子表中外键列的序列号。请参阅相关文档10bet官方网站专栏::getColumnNo ()有关NDB API中处理列的信息。

签名

int getChildColumnNo (unsigned没有)常量

参数

没有一个。

返回值

列的序列号。

ForeignKey: getOnUpdateAction ()

描述

获取外键在更新行动。这是一个ForeignKey: FkAction并且有一个值再,限制,级联,或SetNull。

签名

FkAction gettonupdateaction (void) const

参数

没有一个。

返回值

列的序列号。

ForeignKey: getOnDeleteAction ()

描述

获取外键在删除行动。这是一个ForeignKey: FkAction并且有一个值再,限制,级联,或SetNull。

签名

FkAction gettondeleteaction (void) const

参数

没有一个。

返回值

列的序列号。

ForeignKey: setName ()

描述

属性的名称ForeignKey为其调用方法的实例。

签名

void setName (const char*)

参数

The name of TheForeignKey。

返回值

没有一个。

ForeignKey: setParent ()

描述

设置a的父表ForeignKey，给定对表的引用，以及可选的作为外键使用的索引。

签名

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

参数

A对A的引用表格(要求)。可选地，使用指定列的索引。

返回值

没有一个。

ForeignKey: setChild ()

描述

a的子表ForeignKey，给定对表的引用，以及可选的作为外键使用的索引。

签名

void setChild (const Table&， const Index*)指数= 0, const列*关口[] = 0)

参数

A对A的引用表格(要求)。可选地，使用指定列的索引。

返回值

没有一个。

ForeignKey: setOnUpdateAction ()

描述

设置外键在更新行动。

签名

setOnUpdateAction (FkAction)

参数

的在更新要执行的动作。这一定是ForeignKey: FkAction有一个值的再,限制,级联,或SetNull。

返回值

没有一个

ForeignKey: setOnDeleteAction ()

描述

设置外键在删除行动。

签名

setOnUpdateAction (FkAction)

参数

的在更新要执行的动作，类型ForeignKey: FkAction。必须是其中一个值再,限制,级联,或SetNull。

返回值

没有一个

ForeignKey: getObjectStatus ()

描述

获取对象状态(参见对象:状态),这ForeignKey对象。

签名

getObjectStatus (void) const

参数

没有一个。

返回值

的ForeignKey对象的状态，作为type的值对象:状态。有关可能的值及其解释，请参阅该类10bet官方网站型的文档。

ForeignKey: getObjectId ()

描述

获取对象ID(参见对象::getObjectId ()),这ForeignKey对象。

签名

getObjectId (void) const

参数

没有一个。

返回值

的ForeignKey对象的ID，作为返回对象::getObjectId ()。

ForeignKey: getObjectVersion ()

描述

获取对象版本(参见对象::getObjectVersion ()),这ForeignKey对象。

签名

getObjectVersion (void) const

参数

没有一个。

返回值

的ForeignKey对象的版本号(一个整数)，由对象::getObjectVersion ()。