Definition
Assembly: CloudNimble.BlazorEssentials.IndexedDb.dll Namespace: CloudNimble.BlazorEssentials.IndexedDb Inheritance: System.ObjectSyntax
Summary
Defines a store to add to databaseConstructors
.ctor
Add new ObjectStore definitionSyntax
Parameters
| Name | Type | Description |
|---|---|---|
database | CloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase | - |
attribute | CloudNimble.BlazorEssentials.IndexedDb.ObjectStoreAttribute | - |
.ctor
Add new ObjectStore definitionSyntax
Parameters
| Name | Type | Description |
|---|---|---|
database | CloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase | - |
name | string | - |
keyPath | string | - |
autoIncrement | bool | - |
.ctor Inherited
Inherited from
objectSyntax
Properties
AutoIncrement
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
Property Value
Type:bool
Database
IDMManagerSyntax
Property Value
Type:CloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase
Indexes
Provides a set of additional indexes if required.Syntax
Property Value
Type:System.Collections.Generic.List<CloudNimble.BlazorEssentials.IndexedDb.IndexedDbIndex>
KeyPath
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
Property Value
Type:string?
Name
The name for the storeSyntax
Property Value
Type:string
Methods
AddAsync
Adds a new record/object to the specified ObjectStoreSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData | - |
Returns
Type:System.Threading.Tasks.Task
Type Parameters
TData-
AddAsync
Adds a new record/object to the specified ObjectStoreSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData | - |
Returns
Type:System.Threading.Tasks.Task<TKey>
Type Parameters
TData-TKey-
AddAsync
Adds a new record/object to the specified ObjectStoreSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData | - |
key | TKey | - |
Returns
Type:System.Threading.Tasks.Task<TKey>
Type Parameters
TData-TKey-
BatchAddAsync
Add an array of new record/object in one transaction to the specified storeSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData[] | - |
Returns
Type:System.Threading.Tasks.Task
Type Parameters
TData-
BatchAddAsync
Add an array of new record/object in one transaction to the specified storeSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData[] | - |
Returns
Type:System.Threading.Tasks.Task<TKey[]>
Type Parameters
TData-TKey-
BatchDeleteAsync
Delete multiple records from the store based on the idSyntax
Parameters
| Name | Type | Description |
|---|---|---|
ids | TKey[] | - |
Returns
Type:System.Threading.Tasks.Task
Type Parameters
TKey-
BatchPutAsync
Put an array of new record/object in one transaction to the specified storeSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData[] | - |
Returns
Type:System.Threading.Tasks.Task
Type Parameters
TData-
BatchPutAsync
Put an array of new record/object in one transaction to the specified storeSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData[] | - |
Returns
Type:System.Threading.Tasks.Task<TKey[]>
Type Parameters
TData-TKey-
ClearStoreAsync
Clears all of the records from a given store.Syntax
Returns
Type:System.Threading.Tasks.Task
CountAsync
Count records in ObjectStoreSyntax
Returns
Type:System.Threading.Tasks.Task<int>
CountAsync
Count records in ObjectStoreSyntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey | - |
Returns
Type:System.Threading.Tasks.Task<int>
Type Parameters
TKey-
CountAsync
Count records in ObjectStoreSyntax
Parameters
| Name | Type | Description |
|---|---|---|
key | CloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey> | - |
Returns
Type:System.Threading.Tasks.Task<int>
Type Parameters
TKey-
DeleteAsync
Deletes a record from the store based on the idSyntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey | - |
Returns
Type:System.Threading.Tasks.Task
Type Parameters
TKey-
Equals Inherited Virtual
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
obj | object? | - |
Returns
Type:bool
Equals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
GetAllAsync
Gets all of the records in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
count | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TResult-
GetAllAsync
Gets all of the records by Key in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey | - |
count | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
GetAllAsync
Gets all of the records by KeyRange in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
key | CloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey> | - |
count | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
GetAllAsync
Gets all of the records by ArrayKey in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey[] | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
GetAllKeysAsync
Gets all of the records keys in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
count | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TResult-
GetAllKeysAsync
Gets all of the records keys by Key in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey | - |
count | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
GetAllKeysAsync
Gets all of the records by KeyRange in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
key | CloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey> | - |
count | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
GetAllKeysAsync
Gets all of the records by ArrayKey in a given store.Syntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey[] | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
GetAsync
Retrieve a record by KeySyntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey | the key of the record |
Returns
Type:System.Threading.Tasks.Task<TResult?>
Type Parameters
TKey-TResult-
GetHashCode Inherited Virtual
Inherited from
objectSyntax
Returns
Type:int
GetKeyAsync
Retrieve a record key by KeySyntax
Parameters
| Name | Type | Description |
|---|---|---|
key | TKey | the key of the record |
Returns
Type:System.Threading.Tasks.Task<TResult?>
Type Parameters
TKey-TResult-
GetType Inherited
Inherited from
objectSyntax
Returns
Type:System.Type
MemberwiseClone Inherited
Inherited from
objectSyntax
Returns
Type:object
PutAsync
Updates and existing recordSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData | - |
Returns
Type:System.Threading.Tasks.Task
Type Parameters
TData-
PutAsync
Updates and existing recordSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData | - |
Returns
Type:System.Threading.Tasks.Task<TKey>
Type Parameters
TData-TKey-
PutAsync
Updates and existing recordSyntax
Parameters
| Name | Type | Description |
|---|---|---|
data | TData | - |
key | TKey | - |
Returns
Type:System.Threading.Tasks.Task<TKey>
Type Parameters
TData-TKey-
QueryAsync
Gets all of the records using a filter expressionSyntax
Parameters
| Name | Type | Description |
|---|---|---|
filter | string | expression that evaluates to true/false, each record es passed to “obj” parameter |
count | System.Nullable<int> | - |
skip | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TResult-
QueryAsync
Gets all of the records using a filter expressionSyntax
Parameters
| Name | Type | Description |
|---|---|---|
name | string | - |
filter | string | expression that evaluates to true/false, each record es passed to “obj” parameter |
key | TKey | - |
count | System.Nullable<int> | - |
skip | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
QueryAsync
Gets all of the records using a filter expressionSyntax
Parameters
| Name | Type | Description |
|---|---|---|
filter | string | expression that evaluates to true/false, each record es passed to “obj” parameter |
key | CloudNimble.BlazorEssentials.IndexedDb.KeyRange<TKey> | - |
count | System.Nullable<int> | - |
skip | System.Nullable<int> | - |
Returns
Type:System.Threading.Tasks.Task<System.Collections.Generic.List<TResult>>
Type Parameters
TKey-TResult-
ReferenceEquals Inherited
Inherited from
objectSyntax
Parameters
| Name | Type | Description |
|---|---|---|
objA | object? | - |
objB | object? | - |
Returns
Type:bool
ToString Inherited Virtual
Inherited from
objectSyntax
Returns
Type:string?