Struct Database

pub struct Database { /* private fields */ }

Database provides a connection to a database; you can use an Database object to open a transaction on your database then create, manipulate, and delete objects (data) in that database. The object provides the only way to get and manage versions of the database.

Implementations

impl Database

pub fn builder(name: &str) -> DatabaseBuilder

Available on crate feature builder only.

Creates a new instance of DatabaseBuilder.

pub fn name(&self) -> String

Returns the name of the database.

pub fn version(&self) -> Result<u32, Error>

Returns the version of the database.

pub fn store_names(&self) -> Vec<String>

Returns a list of the names of ObjectStores in the database.

pub fn transaction<T>( &self, store_names: &[T], mode: TransactionMode, ) -> Result<Transaction, Error>

where T: AsRef<str>,

Returns a new transaction with the given scope (which can be a single object store name or an array of names), mode (TransactionMode::ReadOnly or TransactionMode::ReadWrite).

pub fn close(&self)

Closes the connection once all running transactions have finished.

pub fn create_object_store( &self, name: &str, params: ObjectStoreParams, ) -> Result<ObjectStore, Error>

Creates a new object store with the given name and options and returns a new ObjectStore. Returns an Error if not called within an upgrade transaction.

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

Deletes the object store with the given name. Returns an Error if not called within an upgrade transaction.

pub fn on_abort<F>(&mut self, callback: F)

where F: FnOnce(Event) + 'static,

Adds an event handler for abort event.

pub fn on_close<F>(&mut self, callback: F)

where F: FnOnce(Event) + 'static,

Adds an event handler for close event.

pub fn on_error<F>(&mut self, callback: F)

where F: FnOnce(Event) + 'static,

Adds an event handler for error event.

pub fn on_version_change<F>(&mut self, callback: F)

where F: FnOnce(Event) + 'static,

Adds an event handler for versionchange event.

pub fn forget_callbacks(&mut self)

Release memory management of the callbacks to JS GC.

Note: This may leak memory. Read more about it here.

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.

impl From<Database> for IdbDatabase

fn from(database: Database) -> Self

Converts to this type from the input type.

impl From<Database> for JsValue

fn from(value: Database) -> Self

Converts to this type from the input type.

impl From<IdbDatabase> for Database

fn from(inner: IdbDatabase) -> Self

Converts to this type from the input type.

impl TryFrom<EventTarget> for Database

type Error = Error

The type returned in the event of a conversion error.

fn try_from(target: EventTarget) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsValue> for Database

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.