note

VeloxDB is still in beta and APIs are subject to change. We are in the process of completing the documentation, so some sections may be incomplete or empty at this time.

Class SortedIndexAttribute

Apply this attribute to a DatabaseObject class to define a sorted index.

Inheritance

System.Object

IndexAttribute

SortedIndexAttribute

Inherited Members

IndexAttribute.Name

IndexAttribute.CultureName

IndexAttribute.CaseSensitive

IndexAttribute.IsUnique

Namespace: VeloxDB.ObjectInterface

Assembly: vlxdb.dll

Syntax

public sealed class SortedIndexAttribute : IndexAttribute

Constructors

SortedIndexAttribute(String, Boolean, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, bool isUnique, string name1, SortOrder sortOrder1)

Parameters

Type	Name	Description
System.String	name	Index's name
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the key property.
SortOrder	sortOrder1	Sort order of the key property.

SortedIndexAttribute(String, Boolean, String, SortOrder, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, bool isUnique, string name1, SortOrder sortOrder1, string name2, SortOrder sortOrder2)

Parameters

Type	Name	Description
System.String	name	Index's name
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the first key property.
SortOrder	sortOrder1	Sort order of the first key property.
System.String	name2	Name of the second key property.
SortOrder	sortOrder2	Sort order of the second key property.

SortedIndexAttribute(String, Boolean, String, SortOrder, String, SortOrder, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, bool isUnique, string name1, SortOrder sortOrder1, string name2, SortOrder sortOrder2, string name3, SortOrder sortOrder3)

Parameters

Type	Name	Description
System.String	name	Index's name
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the first key property.
SortOrder	sortOrder1	Sort order of the first key property.
System.String	name2	Name of the second key property.
SortOrder	sortOrder2	Sort order of the second key property.
System.String	name3	Name of the third key property.
SortOrder	sortOrder3	Sort order of the third key property.

SortedIndexAttribute(String, Boolean, String, SortOrder, String, SortOrder, String, SortOrder, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, bool isUnique, string name1, SortOrder sortOrder1, string name2, SortOrder sortOrder2, string name3, SortOrder sortOrder3, string name4, SortOrder sortOrder4)

Parameters

Type	Name	Description
System.String	name	Index's name
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the first key property.
SortOrder	sortOrder1	Sort order of the first key property.
System.String	name2	Name of the second key property.
SortOrder	sortOrder2	Sort order of the second key property.
System.String	name3	Name of the third key property.
SortOrder	sortOrder3	Sort order of the third key property.
System.String	name4	Name of the fourth key property.
SortOrder	sortOrder4	Sort order of the fourth key property.

SortedIndexAttribute(String, Boolean, String[])

Declaration

public SortedIndexAttribute(string name, bool isUnique, params string[] properties)

Parameters

Type	Name	Description
System.String	name	Index's name
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String[]	properties	Names of the properties that hash index should include.

SortedIndexAttribute(String, String, Boolean, Boolean, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, string cultureName, bool caseSensitive, bool isUnique, string name1, SortOrder sortOrder1)

Parameters

Type	Name	Description
System.String	name	Index's name
System.String	cultureName	The name of the culture to use to compare strings inside the index.
System.Boolean	caseSensitive	Indicates whether string comparisons inside the index are case sensitive.
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the key property.
SortOrder	sortOrder1	Sort order of the key property.

SortedIndexAttribute(String, String, Boolean, Boolean, String, SortOrder, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, string cultureName, bool caseSensitive, bool isUnique, string name1, SortOrder sortOrder1, string name2, SortOrder sortOrder2)

Parameters

Type	Name	Description
System.String	name	Index's name
System.String	cultureName	The name of the culture to use to compare strings inside the index.
System.Boolean	caseSensitive	Indicates whether string comparisons inside the index are case sensitive.
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the first key property.
SortOrder	sortOrder1	Sort order of the first key property.
System.String	name2	Name of the second key property.
SortOrder	sortOrder2	Sort order of the second key property.

SortedIndexAttribute(String, String, Boolean, Boolean, String, SortOrder, String, SortOrder, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, string cultureName, bool caseSensitive, bool isUnique, string name1, SortOrder sortOrder1, string name2, SortOrder sortOrder2, string name3, SortOrder sortOrder3)

Parameters

Type	Name	Description
System.String	name	Index's name
System.String	cultureName	The name of the culture to use to compare strings inside the index.
System.Boolean	caseSensitive	Indicates whether string comparisons inside the index are case sensitive.
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the first key property.
SortOrder	sortOrder1	Sort order of the first key property.
System.String	name2	Name of the second key property.
SortOrder	sortOrder2	Sort order of the second key property.
System.String	name3	Name of the third key property.
SortOrder	sortOrder3	Sort order of the third key property.

SortedIndexAttribute(String, String, Boolean, Boolean, String, SortOrder, String, SortOrder, String, SortOrder, String, SortOrder)

Declaration

public SortedIndexAttribute(string name, string cultureName, bool caseSensitive, bool isUnique, string name1, SortOrder sortOrder1, string name2, SortOrder sortOrder2, string name3, SortOrder sortOrder3, string name4, SortOrder sortOrder4)

Parameters

Type	Name	Description
System.String	name	Index's name
System.String	cultureName	The name of the culture to use to compare strings inside the index.
System.Boolean	caseSensitive	Indicates whether string comparisons inside the index are case sensitive.
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String	name1	Name of the first key property.
SortOrder	sortOrder1	Sort order of the first key property.
System.String	name2	Name of the second key property.
SortOrder	sortOrder2	Sort order of the second key property.
System.String	name3	Name of the third key property.
SortOrder	sortOrder3	Sort order of the third key property.
System.String	name4	Name of the fourth key property.
SortOrder	sortOrder4	Sort order of the fourth key property.

SortedIndexAttribute(String, String, Boolean, Boolean, String[])

Declaration

public SortedIndexAttribute(string name, string cultureName, bool caseSensitive, bool isUnique, params string[] properties)

Parameters

Type	Name	Description
System.String	name	Index's name
System.String	cultureName	The name of the culture to use to compare strings inside the index.
System.Boolean	caseSensitive	Indicates whether string comparisons inside the index are case sensitive.
System.Boolean	isUnique	If true, VeloxDB will enforce hash index uniqueness.
System.String[]	properties	Names of the properties that hash index should include.

See Also

VeloxDB The definitive guide: Sorted indexes

SortedIndexReader<T, TKey1>

SortedIndexReader<T, TKey1, TKey2>

SortedIndexReader<T, TKey1, TKey2>

SortedIndexReader<T, TKey1, TKey2, TKey3>

SortedIndexReader<T, TKey1, TKey2, TKey3, TKey4>