Class bpxForeignKey

Namespace

PolarDataInterop.Catalog

Assembly

PolarDataInterop.dll

This class contains the details of a relationship (foreign key).

public class bpxForeignKey

Inheritance

object

bpxForeignKey

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Globals.IsNumericType(object)

Properties

DeleteRule

Returns the DeleteRule. One of: 'CASCADE', 'SET_NULL', 'RESTRICTED'

public string DeleteRule { get; }

Property Value

string

ForeignKeyRelationships

Returns all detail relationships (the fields).

public Collection<bpxForeignKeyRelationship> ForeignKeyRelationships { get; }

Property Value

Collection<bpxForeignKeyRelationship>

HasIndex

Returns a boolean indicating an index was found that matches the fields in this relationship.

public bool HasIndex { get; }

Property Value

bool

Name

Returns the name

public string Name { get; }

Property Value

string

PKtableName

Returns the name of the table containing the primary key (that is referred to).

public string PKtableName { get; }

Property Value

string

UpdateRule

Returns the UpdateRule

public string UpdateRule { get; }

Property Value

string

Methods

CreateForeignKeyConstraintSQL(string)

Creates the SQL expression to create a foreign key constraint for this relationship.

public string CreateForeignKeyConstraintSQL(string pTableName)

Parameters

pTableName string

The name of the table to use.

Returns

string

The ALTER TABLE statement to create this foreign key constraint.

ToString(clsString)

public void ToString(clsString pResult)

Parameters

pResult clsString