本节提供有关
类的信息,该类对表
ForeignKey
的外键进行建模。NDB
- 家长班
- 儿童班
没有。
- 方法
-
下表列出了
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 )
复制构造函数:
ForeignKey ( const ForeignKey& )
- 参数
-
对于新实例:无。
对于复制构造函数:对现有实例的引用
ForeignKey
。 - 返回值
的新实例
ForeignKey
。
- 描述
ForeignKey
检索调用该方法 的实例的父表 。- 签名
const char* getParentTable ( void ) const
- 参数
没有。
- 返回值
指向 的父表的指针
ForeignKey
。
- 描述
ForeignKey
检索调用该方法 的实例的子表 。- 签名
const char* getChildTable ( void ) const
- 参数
没有。
- 返回值
指向 this 的子表的指针
ForeignKey
。
- 描述
此方法获取给定索引的父表中外键列的序列号。
Column::getColumnNo()
有关处理 NDB API 中的列的信息, 请参阅 的文档。- 签名
int getParentColumnNo ( unsigned no ) const
- 参数
没有。
- 返回值
列的序号。
- 描述
此方法获取给定索引的子表中外键列的序列号。
Column::getColumnNo()
有关处理 NDB API 中的列的信息, 请参阅文档。- 签名
int getChildColumnNo ( unsigned no ) const
- 参数
没有。
- 返回值
列的序号。
- 描述
获取外键的
ON UPDATE
动作。这是 aForeignKey::FkAction
并且具有值NoAction
、Restrict
、Cascade
或 之一SetNull
。- 签名
FkAction getOnUpdateAction ( void ) const
- 参数
没有。
- 返回值
列的序号。
- 描述
获取外键的
ON DELETE
动作。这是 aForeignKey::FkAction
并且具有值NoAction
、Restrict
、Cascade
或 之一SetNull
。- 签名
FkAction getOnDeleteAction ( void ) const
- 参数
没有。
- 返回值
列的序号。
- 描述
设置 a 的父表
ForeignKey
,给定表的引用,以及可选的用作外键的索引。- 签名
void setParent ( const Table&, const Index* index = 0, const Column* cols[] = 0 )
- 参数
对 a 的引用
Table
(必填)。可选地,索引使用指定的一个或多个列。- 返回值
没有。
- 描述
设置 a 的子表
ForeignKey
,给定表的引用,以及可选的用作外键的索引。- 签名
void setChild ( const Table&, const Index* index = 0, const Column* cols[] = 0 )
- 参数
对 a 的引用
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
。- 返回值
没有任何
- 描述
获取此对象的对象状态(请参阅 Object::Status)
ForeignKey
。- 签名
virtual Object::Status getObjectStatus ( void ) const
- 参数
没有。
- 返回值
对象的
ForeignKey
状态,作为 type 的值Object::Status
。有关可能的值及其解释,请参阅此类型的文档。
- 描述
获取此对象的对象 ID(请参阅 Object::getObjectId())
ForeignKey
。- 签名
virtual int getObjectId ( void ) const
- 参数
没有。
- 返回值
对象的
ForeignKey
ID,由 返回Object::getObjectId()
。
- 描述
获取此对象的对象版本(请参阅 Object::getObjectVersion())
ForeignKey
。- 签名
virtual int getObjectVersion ( void ) const
- 参数
没有。
- 返回值
对象的
ForeignKey
版本号(整数),由 返回Object::getObjectVersion()
。