driftDatabase function

QueryExecutor driftDatabase({
  1. required String name,
  2. DriftWebOptions? web,
  3. DriftNativeOptions? native,
})

Obtain a QueryExecutor to use for drift databases on the current platform.

The result of this method can be passed to GeneratedDatabase constructors of drift databases:

@DriftDatabase(...)
final class Database extends _$Database {
  Database(): super(driftDatabase(name: 'my_app', web: ...));
}

name is the name of the database to use. On native platforms, a file called $name.sqlite in getApplicationDocumentsDirectory() will be used for the database. On the web, this name is part of the FileSystem API path or the name of the IndexedDB database to use. Typically, names only consist of alphanumerical characters and underscores.

Implementation

QueryExecutor driftDatabase({
  required String name,
  connect.DriftWebOptions? web,
  connect.DriftNativeOptions? native,
}) {
  return connect.driftDatabase(name: name, web: web, native: native);
}