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 . IndexedDbObjectStore
Summary Defines a store to add to database
Constructors Add new ObjectStore definition
Syntax public IndexedDbObjectStore ( CloudNimble . BlazorEssentials . IndexedDb . IndexedDbDatabase database , CloudNimble . BlazorEssentials . IndexedDb . ObjectStoreAttribute attribute = null )
Parameters Name Type Description databaseCloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase- attributeCloudNimble.BlazorEssentials.IndexedDb.ObjectStoreAttribute-
Add new ObjectStore definition
Syntax public IndexedDbObjectStore ( CloudNimble . BlazorEssentials . IndexedDb . IndexedDbDatabase database , string name , string keyPath = "id" , bool autoIncrement = false )
Parameters Name Type Description databaseCloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase- namestring- keyPathstring- autoIncrementbool-
Inherited Syntax Properties If true, the object store has a key generator. Defaults to false.
Note that every object store has its own separate auto increment counter.
Syntax public bool AutoIncrement { get ; init ; }
Property Value Type: bool
IDMManager
Syntax public CloudNimble . BlazorEssentials . IndexedDb . IndexedDbDatabase Database { get ; init ; }
Property Value Type: CloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase
Provides a set of additional indexes if required.
Syntax public System . Collections . Generic . List < CloudNimble . BlazorEssentials . IndexedDb . IndexedDbIndex > Indexes { get ; init ; }
Property Value Type: System.Collections.Generic.List<CloudNimble.BlazorEssentials.IndexedDb.IndexedDbIndex>
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 this property is null, the application must provide a key for each modification operation.
Syntax public string KeyPath { get ; init ; }
Property Value Type: string?
The name for the store
Syntax public string Name { get ; internal set ; }
Property Value Type: string
Methods Adds a new record/object to the specified ObjectStore
Syntax public System . Threading . Tasks . Task AddAsync < TData >( TData data ) where TData : notnull
Parameters Name Type Description dataTData-
Returns Type: System.Threading.Tasks.Task
Type Parameters Adds a new record/object to the specified ObjectStore
Syntax public System . Threading . Tasks . Task < TKey > AddAsync < TData , TKey >( TData data )
Parameters Name Type Description dataTData-
Returns Type: System.Threading.Tasks.Task<TKey>
Type Parameters Adds a new record/object to the specified ObjectStore
Syntax public System . Threading . Tasks . Task < TKey > AddAsync < TData , TKey >( TData data , TKey key )
Parameters Name Type Description dataTData- keyTKey-
Returns Type: System.Threading.Tasks.Task<TKey>
Type Parameters Add an array of new record/object in one transaction to the specified store
Syntax public System . Threading . Tasks . Task BatchAddAsync < TData >( TData [] data )
Parameters Name Type Description dataTData[]-
Returns Type: System.Threading.Tasks.Task
Type Parameters Add an array of new record/object in one transaction to the specified store
Syntax public System . Threading . Tasks . Task < TKey []> BatchAddAsync < TData , TKey >( TData [] data )
Parameters Name Type Description dataTData[]-
Returns Type: System.Threading.Tasks.Task<TKey[]>
Type Parameters Delete multiple records from the store based on the id
Syntax public System . Threading . Tasks . Task BatchDeleteAsync < TKey >( TKey [] ids )
Parameters Name Type Description idsTKey[]-
Returns Type: System.Threading.Tasks.Task
Type Parameters Put an array of new record/object in one transaction to the specified store
Syntax public System . Threading . Tasks . Task BatchPutAsync < TData >( TData [] data )
Parameters Name Type Description dataTData[]-
Returns Type: System.Threading.Tasks.Task
Type Parameters Put an array of new record/object in one transaction to the specified store
Syntax public System . Threading . Tasks . Task < TKey []> BatchPutAsync < TData , TKey >( TData [] data )
Parameters Name Type Description dataTData[]-
Returns Type: System.Threading.Tasks.Task<TKey[]>
Type Parameters Clears all of the records from a given store.
Syntax public System . Threading . Tasks . Task ClearStoreAsync ()
Returns Type: System.Threading.Tasks.Task
Count records in ObjectStore
Syntax public System . Threading . Tasks . Task < int > CountAsync ()
Returns Type: System.Threading.Tasks.Task<int>
Count records in ObjectStore
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 ObjectStore
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 Deletes a record from the store based on the id
Syntax public System . Threading . Tasks . Task DeleteAsync < TKey >( TKey key ) where TKey : notnull
Parameters Name Type Description keyTKey-
Returns Type: System.Threading.Tasks.Task
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 in a given store.
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 by Key in a given store.
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 by KeyRange in a given store.
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 by ArrayKey in a given store.
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 in a given store.
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 by Key in a given store.
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 by KeyRange in a given store.
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 by ArrayKey in a given store.
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 Retrieve a record by Key
Syntax public System . Threading . Tasks . Task < TResult > GetAsync < TKey , TResult >( TKey key )
Parameters Name Type Description keyTKeythe key of the record
Returns Type: System.Threading.Tasks.Task<TResult?>
Type Parameters Inherited Virtual Syntax public virtual int GetHashCode ()
Returns Type: int
Retrieve a record key by Key
Syntax public System . Threading . Tasks . Task < TResult > GetKeyAsync < TKey , TResult >( TKey key )
Parameters Name Type Description keyTKeythe key of the record
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
Updates and existing record
Syntax public System . Threading . Tasks . Task PutAsync < TData >( TData data ) where TData : notnull
Parameters Name Type Description dataTData-
Returns Type: System.Threading.Tasks.Task
Type Parameters Updates and existing record
Syntax public System . Threading . Tasks . Task < TKey > PutAsync < TData , TKey >( TData data )
Parameters Name Type Description dataTData-
Returns Type: System.Threading.Tasks.Task<TKey>
Type Parameters Updates and existing record
Syntax public System . Threading . Tasks . Task < TKey > PutAsync < TData , TKey >( TData data , TKey key )
Parameters Name Type Description dataTData- keyTKey-
Returns Type: System.Threading.Tasks.Task<TKey>
Type Parameters 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 name , string filter , TKey key , System . Nullable < int > count = null , System . Nullable < int > skip = null )
Parameters Name Type Description namestring- 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? 
