CDPotion.Domain.IndexedDB (cdpotion v0.1.0)

Summary

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

Disables events from backend.

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.