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 HashIndexReader<T, TKey1, TKey2, TKey3>

Reader for a 3 property composite key hash index. Use this class to lookup a DatabaseObject using hash index.

Inheritance

object

HashIndexReader<T, TKey1, TKey2, TKey3>

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: VeloxDB.ObjectInterface

Assembly: vlxdb.dll

Syntax

public sealed class HashIndexReader<T, TKey1, TKey2, TKey3> where T : DatabaseObject

Type Parameters

Name	Description
T	Type of DatabaseObject being looked up.
TKey1	Type of the first key.
TKey2	Type of the second key.
TKey3	Type of the third key.

Methods

GetObject(TKey1, TKey2, TKey3)

Gets an object by composite key.

Declaration

public T GetObject(TKey1 key1, TKey2 key2, TKey3 key3)

Parameters

Type	Name	Description
TKey1	key1	The first key.
TKey2	key2	The second key.
TKey3	key3	The third key.

Returns

Type	Description
T	Requested object if found, otherwise null.

Exceptions

Type	Condition
ObjectDisposedException	If HashIndexReader<T, TKey1> has been disposed.

GetObjects(TKey1, TKey2, TKey3)

Gets all objects by key.

Declaration

public List<T> GetObjects(TKey1 key1, TKey2 key2, TKey3 key3)

Parameters

Type	Name	Description
TKey1	key1	The first key.
TKey2	key2	The second key.
TKey3	key3	The third key.

Returns

Type	Description
List<T>	A List of objects that match the key. If no object matches, empty list is returned.

Exceptions

Type	Condition
ObjectDisposedException	If HashIndexReader<T, TKey1> has been disposed.

See Also

VeloxDB The definitive guide: Hash indexes

HashIndexAttribute

GetHashIndex<T, TKey1>(string)