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
object
Attribute
IndexAttribute
HashIndexAttribute
SortedIndexAttribute
Inherited Members
Namespace: VeloxDB.ObjectInterface
Assembly: vlxdb.dll
Syntax
public abstract class IndexAttribute : Attribute

Constructors

IndexAttribute(string, bool, params string[])

Declaration
public IndexAttribute(string name, bool isUnique, params string[] properties)
Parameters
Type Name Description
string name

Index's name
bool isUnique

If true, VeloxDB will enforce hash index uniqueness.
string[] properties

Names of the properties that hash index should include.

IndexAttribute(string, string, bool, bool)

Declaration
public IndexAttribute(string name, string cultureName, bool caseSensitive, bool isUnique)
Parameters
Type Name Description
string name

Index's name
string cultureName

The name of the culture to use to compare strings inside the index.
bool caseSensitive

Indicates whether string comparisons inside the index are case sensitive.
bool 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
bool

CultureName

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

Declaration
public string CultureName { get; }
Property Value
Type Description
string

IsUnique

Gets if hash index has unique constraint.

Declaration
public bool IsUnique { get; }
Property Value
Type Description
bool

Name

Gets the name.

Declaration
public string Name { get; }
Property Value
Type Description
string