wasm library
Experimental access to sqlite3 on the web.
Using this library requires additional setup, see the readme of the
sqlite3 package for details.
Also, please note that this library is not production-ready at the moment and should be used with caution. In particular, the implementation of the virtual file system used to store persistent databases may change in a way that requires migration work in the future.
As long as this library is marked as experimental, it is not subject to semantic versioning.
Classes
-
AggregateContext<
V> - Application-defined context used to compute results in aggregate functions.
-
AggregateFunction<
V> - Interface for application-defined aggregate functions.
- AllowedArgumentCount
- Describes how many arguments an application-defined sql function can take.
- CommonDatabase
- An opened sqlite3 database.
- CommonPreparedStatement
- A prepared statement.
- CommonSqlite3
-
Provides access to
sqlite3functions, such as opening new databases. - Cursor
- Base class for result sets.
- FileSystem
-
A virtual file system implementation for web-based
sqlite3databases. - IndexedDbFileSystem
- A file system storing files divided into blocks in an IndexedDB database.
- IteratingCursor
- A Cursor that can only be read once, obtaining rows from the database "on the fly" as moveNext is called.
- OpfsFileSystem
-
A FileSystem for the
sqlite3wasm library based on the file system access API. - ResultSet
- Stores the full result of a select statement.
- Row
- A single row in the result of a select statement.
- SqlError
- Common result codes, https://www.sqlite.org/rescode.html Result Codes
- SqlExtendedError
- Extended Result Codes, https://www.sqlite.org/rescode.html
- SqlFlag
- Flags for file open operations, https://www.sqlite.org/c3ref/c_open_autoproxy.html Flags For File Open Operations
- SqlFunctionFlag
- Function flags, https://www.sqlite.org/c3ref/c_deterministic.html
- SqliteEnvironment
- An environment under which sqlite is running on the web.
- SqliteUpdate
- A data change notification from sqlite.
- SqlPrepareFlag
- SqlSpecialDestructor
- Special destructors, https://www.sqlite.org/c3ref/c_static.html
- SqlTextEncoding
- Text Encodings, https://www.sqlite.org/c3ref/c_any.html These constant define integer codes that represent the various text encodings supported by SQLite.
- SqlType
- Datatypes, https://sqlite.org/c3ref/c_blob.html
- Version
- Version information about the sqlite3 library in use.
- WasmSqlite3
- A WebAssembly version of the CommmonSqlite3 interface.
-
WindowFunction<
V> - A window function for sqlite3.
Enums
- OpenMode
- Controls how databases should be opened by sqlite
- SqliteUpdateKind
- The kind of an SqliteUpdate received through a CommonDatabase.updates stream.
Constants
- SQLITE_DELETE → const int
- SQLITE_INSERT → const int
- SQLITE_UPDATE → const int
Properties
- bigIntMaxValue64 → BigInt
-
final
- bigIntMinValue64 → BigInt
-
final
Typedefs
- CollatingFunction = int Function(String? textA, String? textB)
- A collating function provided to a sql collation.
-
ScalarFunction
= Object? Function(List<
Object?> arguments) - A scalar function exposed to sql.
Exceptions / Errors
- FileSystemException
- An exception thrown by a FileSystem implementation.
- SqliteException
- Thrown by sqlite methods.