IldFKey Class Reference

This class describes the foreign keys of tables. More...

#include <ildblink/ildrel.h>

Inheritance diagram for IldFKey:

Public Member Functions
IlInt	getId () const
	Get the identifier of the key. More...
const char *	getPName () const
	Get the primary key name. More...
const char *	getPOwner () const
	Get the owner of the table of the referenced primary key. More...
IlUShort	getPrimaryColCount () const
	Get the number of column of the referenced primary key. More...
const char *	getPrimaryColumn (IlUShort i) const
	Get the name of a column from the referenced primary key. More...
const char *	getPTable () const
	Get the table of the primary key. More...
Public Member Functions inherited from IldKey
const IldColumn *	getColumn (IlUShort index) const
	Get a column from the relation. More...
IlUShort	getCount () const
	Get the number of columns in the key. More...
IldKeyType	getKeyType () const
	Get the type of the key. More...
const char *	getName () const
	Get the name. More...
IlBoolean	isForeign () const
	Tell if the key is foreign. More...
IlBoolean	isPrimary () const
	Tell is the key is a primary key. More...
IlBoolean	isSpecialColumn () const
	Tell if this key is a special columns key. More...

Detailed Description

This class describes the foreign keys of tables.

Library: dbkernel

See also

IldDbms, IldKey, IldRelation, IldTableIndex

Member Function Documentation

getId()

IlInt IldFKey::getId

(

)

const

Get the identifier of the key.

Returns

The identifier of the foreign key when one exists.

getPName()

const char * IldFKey::getPName

(

)

const

Get the primary key name.

Returns

The name of the primary key referenced by the foreign key.

If the primary key is not named, a null pointer is returned.

getPOwner()

const char * IldFKey::getPOwner

(

)

const

Get the owner of the table of the referenced primary key.

Returns

The name of the owner of the referenced primary key.

getPrimaryColCount()

IlUShort IldFKey::getPrimaryColCount

(

)

const

Get the number of column of the referenced primary key.

Returns

The number of columns in the referenced primary key.

getPrimaryColumn()

const char * IldFKey::getPrimaryColumn

(

IlUShort

i

)

const

Get the name of a column from the referenced primary key.

Parameters

i	The column index.

Returns

The name of the i ^th column from the referenced primary key.

getPTable()

const char * IldFKey::getPTable

(

)

const

Get the table of the primary key.

Returns

The name of the table to which the referenced primary key is attached.