Database

class Database extends EventTarget

Annotations: @SupportedBrowser.new(SupportedBrowser.CHROME), @SupportedBrowser.new(SupportedBrowser.FIREFOX, '15'), @SupportedBrowser.new(SupportedBrowser.IE, '10'), @Unstable.new(), @Native.new("IDBDatabase")

An indexed database object for storing client-side data in web apps.

Inheritance

Object → EventTarget → Database

Properties

hashCode no setter inherited

int get hashCode

Inherited from Interceptor.

Implementation

int get hashCode => Primitives.objectHashCode(this);

name no setter

String? get name

Implementation

String? get name native;

objectStoreNames no setter

List<String>? get objectStoreNames

Implementation

@Returns('DomStringList')
@Creates('DomStringList')
List<String>? get objectStoreNames native;

on no setter inherited

Events get on

This is an ease-of-use accessor for event streams which should only be used when an explicit accessor is not available.

Inherited from EventTarget.

Implementation

Events get on => new Events(this);

onAbort no setter

Stream<Event> get onAbort

Stream of abort events handled by this Database.

Implementation

Stream<Event> get onAbort => abortEvent.forTarget(this);

onClose no setter

Stream<Event> get onClose

Stream of close events handled by this Database.

Implementation

Stream<Event> get onClose => closeEvent.forTarget(this);

onError no setter

Stream<Event> get onError

Stream of error events handled by this Database.

Implementation

Stream<Event> get onError => errorEvent.forTarget(this);

onVersionChange no setter

Stream<VersionChangeEvent> get onVersionChange

Stream of versionchange events handled by this Database.

Implementation

Stream<VersionChangeEvent> get onVersionChange =>
    versionChangeEvent.forTarget(this);

runtimeType no setter inherited

Type get runtimeType

Inherited from Interceptor.

Implementation

Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

version no setter

int? get version

Implementation

@Creates('int|String|Null')
@Returns('int|String|Null')
int? get version native;

Methods

addEventListener() inherited

void addEventListener(
  String type,
  (dynamic Function(Event event))? listener, [
  bool? useCapture,
])

Inherited from EventTarget.

Implementation

void addEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  // TODO(leafp): This check is avoid a bug in our dispatch code when
  // listener is null.  The browser treats this call as a no-op in this
  // case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _addEventListener(type, listener, useCapture);
  }
}

close()

void close()

Implementation

void close() native;

createObjectStore()

ObjectStore createObjectStore(
  String name, {
  dynamic keyPath,
  bool? autoIncrement,
})

Implementation

ObjectStore createObjectStore(String name, {keyPath, bool? autoIncrement}) {
  var options = {};
  if (keyPath != null) {
    options['keyPath'] = keyPath;
  }
  if (autoIncrement != null) {
    options['autoIncrement'] = autoIncrement;
  }

  return _createObjectStore(name, options);
}

deleteObjectStore()

void deleteObjectStore(String name)

Implementation

void deleteObjectStore(String name) native;

dispatchEvent() inherited

bool dispatchEvent(Event event)

Inherited from EventTarget.

Implementation

bool dispatchEvent(Event event) native;

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation

dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

removeEventListener() inherited

void removeEventListener(
  String type,
  (dynamic Function(Event event))? listener, [
  bool? useCapture,
])

Inherited from EventTarget.

Implementation

void removeEventListener(
  String type,
  EventListener? listener, [
  bool? useCapture,
]) {
  // TODO(leafp): This check is avoid a bug in our dispatch code when
  // listener is null.  The browser treats this call as a no-op in this
  // case, so it's fine to short-circuit it, but we should not have to.
  if (listener != null) {
    _removeEventListener(type, listener, useCapture);
  }
}

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation

String toString() => Primitives.objectToHumanReadableString(this);

transaction()

Transaction transaction(dynamic storeName_OR_storeNames, String mode)

Implementation

Transaction transaction(storeName_OR_storeNames, String mode) {
  if (mode != 'readonly' && mode != 'readwrite') {
    throw new ArgumentError(mode);
  }

  &#47;&#47; TODO(sra): Ensure storeName_OR_storeNames is a string or List<String>,
  &#47;&#47; and copy to JavaScript array if necessary.

  &#47;&#47; Try and create a transaction with a string mode.  Browsers that expect a
  &#47;&#47; numeric mode tend to convert the string into a number.  This fails
  &#47;&#47; silently, resulting in zero ('readonly').
  return _transaction(storeName_OR_storeNames, mode);
}

transactionList()

Transaction transactionList(List<String> storeNames, String mode)

Implementation

Transaction transactionList(List<String> storeNames, String mode) {
  if (mode != 'readonly' && mode != 'readwrite') {
    throw new ArgumentError(mode);
  }
  List storeNames_1 = convertDartToNative_StringArray(storeNames);
  return _transaction(storeNames_1, mode);
}

transactionStore()

Transaction transactionStore(String storeName, String mode)

Implementation

Transaction transactionStore(String storeName, String mode) {
  if (mode != 'readonly' && mode != 'readwrite') {
    throw new ArgumentError(mode);
  }
  // Try and create a transaction with a string mode.  Browsers that expect a
  // numeric mode tend to convert the string into a number.  This fails
  // silently, resulting in zero ('readonly').
  return _transaction(storeName, mode);
}

transactionStores()

Transaction transactionStores(DomStringList storeNames, String mode)

Implementation

Transaction transactionStores(DomStringList storeNames, String mode) {
  if (mode != 'readonly' && mode != 'readwrite') {
    throw new ArgumentError(mode);
  }
  return _transaction(storeNames, mode);
}

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation

bool operator ==(Object other) => identical(this, other);

Constants

abortEvent

const EventStreamProvider<Event> abortEvent

Static factory designed to expose abort events to event handlers that are not necessarily instances of Database.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> abortEvent =
    const EventStreamProvider<Event>('abort');

closeEvent

const EventStreamProvider<Event> closeEvent

Static factory designed to expose close events to event handlers that are not necessarily instances of Database.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> closeEvent =
    const EventStreamProvider<Event>('close');

errorEvent

const EventStreamProvider<Event> errorEvent

Static factory designed to expose error events to event handlers that are not necessarily instances of Database.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<Event> errorEvent =
    const EventStreamProvider<Event>('error');

versionChangeEvent

const EventStreamProvider<VersionChangeEvent> versionChangeEvent

Static factory designed to expose versionchange events to event handlers that are not necessarily instances of Database.

See EventStreamProvider for usage information.

Implementation

static const EventStreamProvider<VersionChangeEvent> versionChangeEvent =
    const EventStreamProvider<VersionChangeEvent>('versionchange');