Documentation Index Fetch the complete documentation index at: https://easyaf.dev/llms.txt
Use this file to discover all available pages before exploring further.
Definition Assembly: CloudNimble.BlazorEssentials.IndexedDb.dllNamespace: CloudNimble.BlazorEssentials.IndexedDbInheritance: System.ObjectSyntax CloudNimble . BlazorEssentials . IndexedDb . IndexedDbIndex
Summary Defines an Index for a given object store.
Constructors Syntax public IndexedDbIndex ( CloudNimble . BlazorEssentials . IndexedDb . IndexedDbObjectStore objectStore , string name , string keyPath , bool multiEntry = false , bool unique = false )
Parameters Name Type Description objectStoreCloudNimble.BlazorEssentials.IndexedDb.IndexedDbObjectStore- namestring- keyPathstring- multiEntrybool- uniquebool-
Exceptions Exception Description IndexedDbException
Inherited Syntax Properties Syntax public CloudNimble . BlazorEssentials . IndexedDb . IndexedDbDatabase Database { get ; init ; }
Property Value Type: CloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase
the identifier for the property in the object/record that is saved and is to be indexed.
can be multiple properties separated by comma
if null will default to index name
Syntax public string KeyPath { get ; }
Property Value Type: string
Affects how the index behaves when the result of evaluating the index’s key path yields an array.
If true, there is one record in the index for each item in an array of keys.
If false, then there is one record for each key that is an array.
Syntax public bool MultiEntry { get ; }
Property Value Type: bool
The name of the index.
Syntax public string Name { get ; }
Property Value Type: string
Only use for indexes
If true, this index does not allow duplicate values for a key.
Syntax public CloudNimble . BlazorEssentials . IndexedDb . IndexedDbObjectStore ObjectStore { get ; init ; }
Property Value Type: CloudNimble.BlazorEssentials.IndexedDb.IndexedDbObjectStore
Only use for indexes
If true, this index does not allow duplicate values for a key.
Syntax public bool Unique { get ; }
Property Value Type: bool
Methods Count records in Index
Syntax public System . Threading . Tasks . Task < int > CountAsync ()
Returns Type: System.Threading.Tasks.Task<int>
Count records in Index
Syntax public System . Threading . Tasks . Task < int > CountAsync < TKey >( TKey key )
Parameters Name Type Description keyTKey-
Returns Type: System.Threading.Tasks.Task<int>
Type Parameters Count records in Index
Syntax public System . Threading . Tasks . Task < int > CountAsync < TKey >( CloudNimble . BlazorEssentials . IndexedDb . KeyRange < TKey > key )
Parameters Name Type Description keyCloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey>-
Returns Type: System.Threading.Tasks.Task<int>
Type Parameters Inherited Virtual Syntax public virtual bool Equals ( object obj )
Parameters Name Type Description objobject?-
Returns Type: bool
Inherited Syntax public static bool Equals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Gets all of the records that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllAsync < TResult >( System . Nullable < int > count = null )
Parameters Name Type Description countSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllAsync < TKey , TResult >( TKey key , System . Nullable < int > count = null )
Parameters Name Type Description keyTKey- countSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllAsync < TKey , TResult >( CloudNimble . BlazorEssentials . IndexedDb . KeyRange < TKey > key , System . Nullable < int > count = null )
Parameters Name Type Description keyCloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey>- countSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllAsync < TKey , TResult >( TKey [] key )
Parameters Name Type Description keyTKey[]-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records keys that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllKeysAsync < TResult >( System . Nullable < int > count = null )
Parameters Name Type Description countSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records keys that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllKeysAsync < TKey , TResult >( TKey key , System . Nullable < int > count = null )
Parameters Name Type Description keyTKey- countSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllKeysAsync < TKey , TResult >( CloudNimble . BlazorEssentials . IndexedDb . KeyRange < TKey > key , System . Nullable < int > count = null )
Parameters Name Type Description keyCloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey>- countSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records that match a given query in the specified index.
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> GetAllKeysAsync < TKey , TResult >( TKey [] key )
Parameters Name Type Description keyTKey[]-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Returns the first record that matches a query against a given index
Syntax public System . Threading . Tasks . Task < TResult > GetAsync < TKey , TResult >( TKey queryValue )
Parameters Name Type Description queryValueTKey-
Returns Type: System.Threading.Tasks.Task<TResult>
Type Parameters Inherited Virtual Syntax public virtual int GetHashCode ()
Returns Type: int
Returns the first record keys that matches a query against a given index
Syntax public System . Threading . Tasks . Task < TResult > GetKeyAsync < TKey , TResult >( TKey key )
Parameters Name Type Description keyTKey-
Returns Type: System.Threading.Tasks.Task<TResult>
Type Parameters Inherited Syntax public System . Type GetType ()
Returns Type: System.Type
Inherited Syntax protected internal object MemberwiseClone ()
Returns Type: object
Gets all of the records using a filter expression
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> QueryAsync < TResult >( string filter , System . Nullable < int > count = null , System . Nullable < int > skip = null )
Parameters Name Type Description filterstringexpression that evaluates to true/false, each record es passed to “obj” parameter countSystem.Nullable<int>- skipSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records using a filter expression
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> QueryAsync < TKey , TResult >( string filter , TKey key , System . Nullable < int > count = null , System . Nullable < int > skip = null )
Parameters Name Type Description filterstringexpression that evaluates to true/false, each record es passed to “obj” parameter keyTKey- countSystem.Nullable<int>- skipSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Gets all of the records using a filter expression
Syntax public System . Threading . Tasks . Task < System . Collections . Generic . List < TResult >> QueryAsync < TKey , TResult >( string filter , CloudNimble . BlazorEssentials . IndexedDb . KeyRange < TKey > key , System . Nullable < int > count = null , System . Nullable < int > skip = null )
Parameters Name Type Description filterstringexpression that evaluates to true/false, each record es passed to “obj” parameter keyCloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey>- countSystem.Nullable<int>- skipSystem.Nullable<int>-
Returns Type: System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters Inherited Syntax public static bool ReferenceEquals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Inherited Virtual Syntax public virtual string ToString ()
Returns Type: string? 
