Class bpxIndex

Namespace

PolarDataInterop.Catalog

Assembly

PolarDataInterop.dll

This class contains an index in a table.

public class bpxIndex

Inheritance

object

bpxIndex

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

CodedFieldNames

Returns a string of all lowercase and sorted fieldnames concatenated using pipe characters. Used to quickly find other indexes with the same fields.

public string CodedFieldNames { get; }

Property Value

string

Fields

Returns the fields in this index.

public Collection<bpxField> Fields { get; }

Property Value

Collection<bpxField>

Name

Returns the name of this index.

public string Name { get; }

Property Value

string

PrimaryKey

Returns True if this is a primary-key index.

public bool PrimaryKey { get; }

Property Value

bool

Unique

Returns True if this index enforces uniqueness.

public bool Unique { get; }

Property Value

bool

Methods

CreateIndexSQL(string)

Creates the SQL statement to create this index on the specified table name.

public string CreateIndexSQL(string pTableName)

Parameters

pTableName string

The table name to use.

Returns

string

The SQL to create this index.

FieldNamesSQL()

Returns the names of the fields as SQL names concatenated using comma's.

public string FieldNamesSQL()

Returns

string

ToString(clsString)

public void ToString(clsString pResult)

Parameters

pResult clsString