CDPotion.Domain.IndexedDB (cdpotion v0.1.1)
Summary
Types
Data entry.
Database with an array of object stores.
Key.
Key path.
Key range.
Object store.
Object store index.
Functions
Clears all entries from an object store.
Deletes a database.
Delete a range of entries from an object store
Disables events from backend.
Enables events from backend.
Gets metadata of an object store.
Requests data from object store or index.
Requests database with given name in given frame.
Requests database names for given security origin.
Types
Link to this type
data_entry()
@type data_entry() :: %{ key: CDPotion.Domain.Runtime.remote_object(), primaryKey: CDPotion.Domain.Runtime.remote_object(), value: CDPotion.Domain.Runtime.remote_object() }
Data entry.
Link to this type
database_with_object_stores()
@type database_with_object_stores() :: %{ name: String.t(), objectStores: [object_store()], version: number() }
Database with an array of object stores.
Link to this type
key()
@type key() :: %{ array: [key()] | nil, date: number() | nil, number: number() | nil, string: String.t() | nil, type: :number | :string | :date | :array }
Key.
Link to this type
key_path()
@type key_path() :: %{ array: [String.t()] | nil, string: String.t() | nil, type: :null | :string | :array }
Key path.
Link to this type
key_range()
@type key_range() :: %{ lower: key() | nil, lowerOpen: boolean(), upper: key() | nil, upperOpen: boolean() }
Key range.
Link to this type
object_store()
@type object_store() :: %{ autoIncrement: boolean(), indexes: [object_store_index()], keyPath: key_path(), name: String.t() }
Object store.
Link to this type
object_store_index()
@type object_store_index() :: %{ keyPath: key_path(), multiEntry: boolean(), name: String.t(), unique: boolean() }
Object store index.
Functions
Link to this function
clear_object_store(security_origin \\ nil, storage_key \\ nil, storage_bucket \\ nil, database_name, object_store_name)
Clears all entries from an object store.
Parameters:
securityOrigin:string: (Optional) At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.storageKey:string: (Optional) Storage key.storageBucket:Storage.StorageBucket: (Optional) Storage bucket. If not specified, it uses the default bucket.databaseName:string: Database name.objectStoreName:string: Object store name.
Link to this function
delete_database(security_origin \\ nil, storage_key \\ nil, storage_bucket \\ nil, database_name)
Deletes a database.
Parameters:
securityOrigin:string: (Optional) At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.storageKey:string: (Optional) Storage key.storageBucket:Storage.StorageBucket: (Optional) Storage bucket. If not specified, it uses the default bucket.databaseName:string: Database name.
Link to this function
delete_object_store_entries(security_origin \\ nil, storage_key \\ nil, storage_bucket \\ nil, database_name, object_store_name, key_range)
Delete a range of entries from an object store
Parameters:
securityOrigin:string: (Optional) At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.storageKey:string: (Optional) Storage key.storageBucket:Storage.StorageBucket: (Optional) Storage bucket. If not specified, it uses the default bucket.databaseName:string: description not provided :(objectStoreName:string: description not provided :(keyRange:KeyRange: Range of entry keys to delete
Link to this function
disable()
Disables events from backend.
Link to this function
enable()
Enables events from backend.
Link to this function
get_metadata(security_origin \\ nil, storage_key \\ nil, storage_bucket \\ nil, database_name, object_store_name)
Gets metadata of an object store.
Parameters:
securityOrigin:string: (Optional) At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.storageKey:string: (Optional) Storage key.storageBucket:Storage.StorageBucket: (Optional) Storage bucket. If not specified, it uses the default bucket.databaseName:string: Database name.objectStoreName:string: Object store name.
Link to this function
request_data(security_origin \\ nil, storage_key \\ nil, storage_bucket \\ nil, database_name, object_store_name, index_name, skip_count, page_size, key_range \\ nil)
Requests data from object store or index.
Parameters:
securityOrigin:string: (Optional) At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.storageKey:string: (Optional) Storage key.storageBucket:Storage.StorageBucket: (Optional) Storage bucket. If not specified, it uses the default bucket.databaseName:string: Database name.objectStoreName:string: Object store name.indexName:string: Index name, empty string for object store data requests.skipCount:integer: Number of records to skip.pageSize:integer: Number of records to fetch.keyRange:KeyRange: (Optional) Key range.
Link to this function
request_database(security_origin \\ nil, storage_key \\ nil, storage_bucket \\ nil, database_name)
Requests database with given name in given frame.
Parameters:
securityOrigin:string: (Optional) At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.storageKey:string: (Optional) Storage key.storageBucket:Storage.StorageBucket: (Optional) Storage bucket. If not specified, it uses the default bucket.databaseName:string: Database name.
Link to this function
request_database_names(security_origin \\ nil, storage_key \\ nil, storage_bucket \\ nil)
Requests database names for given security origin.
Parameters:
securityOrigin:string: (Optional) At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.storageKey:string: (Optional) Storage key.storageBucket:Storage.StorageBucket: (Optional) Storage bucket. If not specified, it uses the default bucket.