Struct Database 

pub struct Database(/* private fields */);

An IDBDatabase implementation.

Implementations

impl Database

pub fn open<N>(name: N) -> OpenDbRequestBuilder<N>

where N: AsRef<str>,

Open a database with the given name. Convenience method for OpenDbRequestBuilder::new - use it when opening multiple databases.

Errors

Error	Thrown when
InvalidStateError	Thrown if the method was not called from a Versionchange transaction callback.
TransactionInactiveError	Thrown if a request is made on a source database that does not exist (for example, when the database has been deleted or removed).
ConstraintError	Thrown if an object store with the given name (based on a case-sensitive comparison) already exists in the connected database.
InvalidAccessError	Thrown if autoIncrement is set to true and keyPath is either an empty string or an array containing an empty string.

pub fn create_object_store<N>(&self, name: N) -> StoreBuilder<'_, N>

where N: AsRef<str>,

Create an object store with the given name.

pub fn close(self)

Close the database connection in a background thread.

pub fn delete(self) -> Result<Request<()>, OpenDbError>

Close and delete the database.

Errors

Undocumented as of the release of this version.

pub fn delete_object_store(&self, name: &str) -> Result<(), Error>

Delete the object store with the given name.

Errors

Error	Thrown when
InvalidStateError	Thrown if the method was not called from a Versionchange transaction callback.
TransactionInactiveError	Thrown if a request is made on a source database that does not exist (for example, when the database has been deleted or removed).
NotFoundError	Thrown when trying to delete an object store that does not exist.

pub fn name(&self) -> String

Get the database name.

pub fn object_store_names(&self) -> DomStringIter<'_>

List the names of the object stores within this database.

pub fn transaction<S>(&self, store_names: S) -> TransactionBuilder<'_, S>

where S: ObjectStoreName,

Start a transaction on the given store name(s). Finish the builder with a call to Build::build.

Errors

Error	Thrown when
NotFoundError	Thrown if an object store specified cannot be found.
InvalidAccessError	Thrown if the fn was called with an empty list of store names.

pub fn version(&self) -> f64

Get the database version.

pub fn delete_by_name(name: &str) -> Result<Request<()>, OpenDbError>

Delete the database with the given name. Convenience method for DBFactory::delete_db - use that if you need to delete more than one database.

Errors

Undocumented as of the release of this version.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Database

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl SystemRepr for Database

type Repr = DbSys

Internal web_sys-based representation type.