common library

Exports common interfaces that are implemented by both the dart:ffi and the dart:js WASM version of this library.

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.
BaseVfsFile
A VirtualFileSystemFile base class that implements xRead to zero-fill the buffer in case of short reads.
BaseVirtualFileSystem
A VirtualFileSystem implementation that uses a Random instance for xRandomness and DateTime.now for xCurrentTime.
CommonDatabase
An opened sqlite3 database.
CommonPreparedStatement
A prepared statement.
CommonSqlite3
Provides access to sqlite3 functions, such as opening new databases.
Cursor
Base class for result sets.
CustomStatementParameter
A parameter passed to prepared statements that decides how it gets mapped to SQL in applyTo.
DatabaseConfig
Make configuration changes to the database connection.
IteratingCursor
A Cursor that can only be read once, obtaining rows from the database "on the fly" as moveNext is called.
ResultSet
Stores the full result of a select statement.
Row
A single row in the result of a select statement.
SqlDeviceCharacteristics
SqlError
Common result codes, https://www.sqlite.org/rescode.html Result Codes
SqlExtendedError
Extended Result Codes, https://www.sqlite.org/rescode.html
SqlFileLockingLevels
File lock levels, https://www.sqlite.org/c3ref/c_lock_exclusive.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
Sqlite3Filename
A filename passed to VirtualFileSystem.xOpen.
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
StatementParameters
A set of values that can be used to bind parameters in a SQL query.
Version
Version information about the sqlite3 library in use.
VirtualFileSystem
A virtual filesystem used by sqlite3 to access the current I/O environment.
VirtualFileSystemFile
A file implemented by a VFS author and returned by VirtualFileSystem.xOpen.
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_DBCONFIG_DQS_DDL → const int
SQLITE_DBCONFIG_DQS_DML → const int
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.
XOpenResult = ({VirtualFileSystemFile file, int outFlags})
The result of VirtualFileSystem.xOpen.

Exceptions / Errors

SqliteException
Thrown by sqlite methods.
VfsException
An exception thrown by VirtualFileSystem implementations written in Dart to signal that an operation could not be completed.