Class TableIndex
Holds information for index definitions against sql tables
Inheritance
Inherited Members
Namespace: LemonEdge.Utils.Database
Assembly: Utils.dll
Syntax
public sealed class TableIndex : ICloneable<TableIndex>, ICloneable
Fields
ASOF
Declaration
public const string ASOF = "AsOfDate"
Field Value
Type | Description |
---|---|
System.String |
CANVAS
Declaration
public const string CANVAS = "CanvasItem"
Field Value
Type | Description |
---|---|
System.String |
Properties
IncludeColumnNames
A list of columns to be included in the index
Declaration
public string[] IncludeColumnNames { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
IsClustered
Indicates if the index is a clustered index.
Only one index against a table can be clustered. LemonEdge automatically creates the appropriate clustered index for your tables.
Declaration
public bool IsClustered { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsUnique
Indicates that this index points to unique row entries
Declaration
public bool IsUnique { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ItemColumnNames
A list of the column names in the index
Declaration
public string[] ItemColumnNames { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
ItemOrders
A list of the order for each ItemColumnNames
Declaration
public Order[] ItemOrders { get; set; }
Property Value
Type | Description |
---|---|
Order[] |
Name
The name of the index
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
NameWithPrefix
The name of the index prefixed with either cl_ or ix_
Declaration
public string NameWithPrefix { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
Clone()
Declaration
public TableIndex Clone()
Returns
Type | Description |
---|---|
TableIndex |
CopyFromSource(TableIndex)
Declaration
public void CopyFromSource(TableIndex source)
Parameters
Type | Name | Description |
---|---|---|
TableIndex | source |
CopyFromSource(Object)
Declaration
public void CopyFromSource(object source)
Parameters
Type | Name | Description |
---|---|---|
System.Object | source |
InsertColIndex(String, Order)
Adds the specified column and roder to this index
Declaration
public void InsertColIndex(string column, Order order)
Parameters
Type | Name | Description |
---|---|---|
System.String | column | The column to add to the index |
Order | order | The order to use for this column in the index |
InsertColIndex(String, Order, String)
Adds the specified column and order to this index before the specified beforeColumn
Declaration
public void InsertColIndex(string column, Order order, string beforeColumn)
Parameters
Type | Name | Description |
---|---|---|
System.String | column | The column to add to the index |
Order | order | The order to use for this column in the index |
System.String | beforeColumn | The column to add this column index before |
InsertColIndex(String, String)
Adds the specified column before the specified beforeColumn
using the same order as that column, to this index
Declaration
public void InsertColIndex(string column, string beforeColumn)
Parameters
Type | Name | Description |
---|---|---|
System.String | column | The column to add to the index |
System.String | beforeColumn | The column to add this column index before |
ToSQL(String)
Declaration
public string ToSQL(string tableName)
Parameters
Type | Name | Description |
---|---|---|
System.String | tableName |
Returns
Type | Description |
---|---|
System.String |
Explicit Interface Implementations
ICloneable.Clone()
Declaration
object ICloneable.Clone()
Returns
Type | Description |
---|---|
System.Object |