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 IndexAttribute

Base class for index attributes supported by the database.

Inheritance

System.Object

IndexAttribute

HashIndexAttribute

SortedIndexAttribute

Namespace: VeloxDB.ObjectInterface

Assembly: vlxdb.dll

Syntax

public abstract class IndexAttribute : Attribute

Constructors

IndexAttribute(String, Boolean, String[])

Declaration

public IndexAttribute(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.

IndexAttribute(String, String, Boolean, Boolean)

Declaration

public IndexAttribute(string name, string cultureName, bool caseSensitive, bool isUnique)

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.

Properties

CaseSensitive

Indicates whether string comparisons inside the index are case sensitive.

Declaration

public bool CaseSensitive { get; }

Property Value

Type	Description
System.Boolean

CultureName

Name of the culture used to compare strings in the index.

Declaration

public string CultureName { get; }

Property Value

Type	Description
System.String

IsUnique

Gets if hash index has unique constraint.

Declaration

public bool IsUnique { get; }

Property Value

Type	Description
System.Boolean

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String