Class bpxTable

Namespace

PolarDataInterop.Catalog

Assembly

PolarDataInterop.dll

This class contains the details of a table in the catalog.

public class bpxTable

Inheritance

object

bpxTable

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)

Fields

Fields

Returns the collection of fields in this table.

public Collection<bpxField> Fields

Field Value

Collection<bpxField>

Properties

Catalog

Returns the catalog that holds this table.

public bpxCatalog Catalog { get; }

Property Value

bpxCatalog

Description

Returns the description for this table as found in the extended properties.

public string Description { get; }

Property Value

string

ForeignKeys

Returns a collection of foreign keys in this table.

public Collection<bpxForeignKey> ForeignKeys { get; }

Property Value

Collection<bpxForeignKey>

Indexes

Returns the indexes found for this table.

public Collection<bpxIndex> Indexes { get; }

Property Value

Collection<bpxIndex>

Name

Returns the name

public string Name { get; }

Property Value

string

NameInDatabase

Returns the name in the database.

public string NameInDatabase { get; }

Property Value

string

PrimaryKeyFields

Returns the fields in the primary key of this table.

public Collection<bpxField> PrimaryKeyFields { get; }

Property Value

Collection<bpxField>

PrimaryKeyIndex

Returns the index on the primary key in this table.

public bpxIndex PrimaryKeyIndex { get; }

Property Value

bpxIndex

TableType

Returns the type of table. Like 'BASE_TABLE', 'VIEW'

public string TableType { get; }

Property Value

string

UnderlyingQuery

Returns the underlying query for this table in case of a VIEW.

public string UnderlyingQuery { get; }

Property Value

string

Methods

CreateDataSQL(clsString, string)

This method exports SQL statements to import the data in this table in another database.

public string CreateDataSQL(clsString pResultString = null, string pAdditionalWhere = "")

Parameters

pResultString clsString

The clsString object that will hold the SQL statements.

pAdditionalWhere string

An additional where to filter the data to export.

Returns

string

The insert-statements to import the data.

CreateTableSQL(bool, bool, bool, clsString)

This method creates the SQL statements to create the table, relationships and indexes in the database.

public string CreateTableSQL(bool pCreateFieldsSQL = true, bool pCreateRelationshipsSQL = false, bool pCreateIndexesSQL = false, clsString pResultString = null)

Parameters

pCreateFieldsSQL bool

Pass as True to include the base 'CREATE TABLE' or 'CREATE VIEW' statement in the result.

pCreateRelationshipsSQL bool

Pass as True to create the SQL for all relationships (foreign keys).

pCreateIndexesSQL bool

Pass as True to create the SQL for all indexes in this table.

pResultString clsString

The clsString object that will hold the SQL statements.

Returns

string

The SQL to create this table.

ToString(clsString)

public void ToString(clsString pResult)

Parameters

pResult clsString