drift

drift 2.35.0

• Add support for FTS5 queries in the Dart API: match, matchExp, highlight, snippet, bm25 and rank are now available as extension methods on FTS5 tables from package:drift/extensions/fts5.dart (#3843). Thanks to @minhqdao!
• Breaking change (web): Remove PortToChannel extension on dart:html types. Use WebPortToChannel extension on MessagePort from package:web instead.
• Web: Fix race to OPFS file handle in compatiblity check.

drift_dev 2.35.0

• Warn when a table class is annotated with @DriftDatabase instead of silently
  generating nothing (#3854).

drift 2.34.4

• Allow using rowid extension on virtual tables, as they usually provide rowids as well.

drift_dev 2.34.6

• Remove legacy command used to migrate from moor from drift.
• Fix drift_dev command not completing when spawning a schema isolate fails.
• Support analyzer versions 14.x.

• Web: Use navigator locks around OPFS access to avoid file locking issues.

• Web: Flush IndexedDB writes after statements, making writes more reliable.

sqlite3.wasm files are now attached to drift releases directly, making it easier to download compatible workers and WebAssembly files.

drift 2.34.1

• Fix reads queued in a MultiExecutor connection pool being resumed in the wrong zone once an executor became available. Because Drift's cancellation tokens are zone-scoped, this could cause queries to be cancelled or observed in the wrong zone (#3824).

drift_dev 2.34.2

• Drift files: Support for dart placeholder in update statements to reference companions.
• Allow circular references between tables (#3780).

sqlparser 0.44.6

• Fix join analysis to properly treat the left side of a RIGHT or FULL join as nullable (#3812).
• Fix CaseInsensitiveMap.containsKey to be case-insensitive.

• Use BEGIN IMMEDIATE to start transactions.
• Make TableInfo's == and hashCode take into account the database its attached to.

• Add length extension for blob expressions.
• Add SqlDialect.duckdb for use with the drift_duckdb package.

• DevTools extension: Make error messages selectable.

• Potentially breaking change Migrate to version 3.x of the sqlite3 package. To upgrade:
  • For the web, update sqlite3.wasm from a 3.x release.
  • If you've previously used sqlcipher_flutter_libs, see this for encryption support and note that SQLite3MultipleCiphers requires additional pragmas to be compatible with SQLCipher databases.
• serializableConnection(), json1 and TableMigration are no longer marked as experimental.
• Improve performance of mapping large result sets through joined select statements.

• In step-by-step migrations, automatically throw an error if a database downgrade is attempted. This has always been unsupported, but could lead to the database silently having a wrong user_version.

• Web: Fix databases being moved from IndexedDB to OPFS even if moveExistingIndexedDbToOpfs is disabled.

• Add rightOuterJoin and fullOuterJoin.
• Wasm: Add the WasmProbeResult.moveFromIndexedDBToOpfs() method and the moveExistingIndexedDbToOpfs parameter on WasmDatabase.open. They can be used to move an existing database stored in IndexedDB to OPFS.

• Allow specifying ordering for columns in @TableIndex annotation.
• Add DelegatedDatabase.externalExecutor, allowing transactions started externally to be used with drift.
• Add Batch.insertFromSelect to insert rows from a select statement in a batch.
• Devtools extension: Support exporting databases.

• Legacy wasm database: Fix cast issue when compiling with dart2wasm.
• NativeDatabase.createBackground: Allow enabling isolateDebugLog.

• Add escapeChar argument to like() to generate an ESCAPE clause.
• Native database: Cache prepared statements by default.

• Query delegates: Support nested transactions in SupportedTransactionDelegate.
• Add WasmProbeResult.exportDatabase to export an existing web database as a Uint8List.
• Fix drift server isolates leaking when their only client isolate exits without closing the database.

• Allow passing sqlite3 callback to NativeDatabase to customize how SQLite bindings are obtained.

• Add isNotNull() column filter for the manager APIs.
• Add optional orderBy parameter to more aggregate function extension.

• Add support for window functions with WindowFunctionExpression.

• Fix shared worker feature detection when the main app is compiled with dart2wasm.

• Report SqliteExceptions occurring on workers as SqliteException instances. Previously, they were sent as strings only.
• Fix LazyDatabase being closed without ever being used potentially leaking resources.

• Add TypeConverter.jsonb to directly store values in the JSONB format used by SQLite.
• Deprecate TypeConverter.json utility in favor of TypeConverter.json2. The new method avoids encoding values twice when mapping drift row classes to JSON.
• Add runWithInterceptor method to databases to only apply interceptors in a restricted block.

• Fix TableStatements.insertAll to only apply a database-specific pragma for SQLite databases.
• Don't attempt to roll-back transactions that failed to begin.
• Fix unhandled exception when cancelling transactions.
• Fix deadlock when drift databases are used in a fake_async Zone and then closed outside that zone.

• Allow building compound select statements in Dart.
• Support NULLS FIRST and NULLS LAST in manager API.

• Fix generated SQL for insertFromSelect statements with upserts.
• Fix alterTable for databases where legacy_alter_table is not writable.
• Allow package:drift/web.dart to be imported into Dart apps compiled with dart2wasm.

• Add sqliteAny() method to tables to declare ANY columns.
• Add missing parentheses around adjacent expressions of the same precedence.
• Fix creating tables that are both STRICT and WITHOUT ROWID.
• WASM: Report worker failures to make them easier to diagnose.
• Allow closing stream queries synchronously, making drift easier to use in widget tests.

• To infer whether serialization is required for inter-isolate communication, drift now sends a test message instead serializing by default.
• The manager API now ignores references whose target column is a foreign key itself.
• The DevTools extension can now clear drift databases.
• View.from is now declared to return a JoinedSelectStatement, the type it returns at runtime.

• Fix upcoming unreachable_switch_default lint.

• Migrate legacy package:drift/web.dart to the new JS interop SDK libraries. For backwards compatibility, the channel() extension on the MessagePort class in dart:html has been kept. Once dart:html is removed from the Dart SDK, that extension will have to be removed from drift as well.
• Fix cast errors in the protocol for remote workers when compiling with dart2wasm.
• Introduce a faster protocol for communicating with workers. This protocol is enabled automatically after upgrading drift_worker.js.

• Improve manager API to be able to resolve references when running queries.
• Add readPool parameter to NativeDatabase. It will spawn an additional pool of isolates used to serve multiple reads in parallel, which can improve performance in some specific workloads.
• Add TableIndex.sql, allowing database indexes to be defined in SQL without using drift files.
• Add DataClassName.implementing, which can be used to make drift-generated row classes implement existing interfaces.
• Mark legacy package:drift/web.dart as deprecated. Users should migrate to package:drift/wasm.dart.

• Support version 1.x of package:web.

• Fix exclusively breaking the database connection on the web. Please note that this requires an updated drift_worker.js to fix.

• Add exclusively method to database classes, allowing a block to temporarily take exclusive control over a database connection without starting a transaction.
• Add the enableMigrations parameter to WasmDatabase to control whether drift migrations are enabled on that database.
• Add initiallyDeferred option to references() column builder for foreign key constraints.
• Add dropColumn method to Migrator.
• Add selectExpressions method to build select statements without a FROM clause.
• Fix encoding BigInt arguments in batched statements sent to web workers. Note that the fix also requires the latest drift_worker.js to be effective.
• Both transaction and exclusively will wait for the transaction or the exclusive lock to be set up before invoking their callback now.
• Fix stream queries possibly cancelling a migration if they are the first method on the database.

• Adds a new interface for writing most simple statements without manually creating select statements and expressions. For a detailed description, see the documentation website. This feature requires additional code to be generated - if you prefer using the existing APIs exclusively, you can use the generate_manager: false builder option
• Add AggregateFunctionExpression to write custom aggregate function invocations in the Dart query builder.
• The json_group_array and jsonb_group_array functions now contain an orderBy and filter parameter.

• Adds companion entry to DataClassName to override the name of the generated companion class.
• Add the TypeConverter.extensionType factory to create type converters for extension types.
• Fix invalid SQL syntax being generated for BLOB literals on postgres.

• When a migration throws, the database will now block subsequent operations instead of potentially allowing them to operate on a database in an inconsistent state.
• Statements built through the Dart query builder will now run in the context active while they are running, instead of the context active at the time they were created. For instance, creating an UpdateStatement with database.update outside of a transaction and then calling UpdateStatement.write inside of a transaction will now perform the update inside of the transaction, instead of causing a deadlock.
• Improve stack traces for errors happening on drift isolates (which includes usages of NativeDatabase.createInBackground).
• Don't cache EXPLAIN statements, avoiding schema locks.
• Deprecate Value.ofNullable in favor of Value.absentIfNull, which is more explicit about its behavior and allows nullable types too.
• Migrate WasmDatabase to dart:js_interop and package:web.

• Methods in the query builder API now respect custom types.
• Support DialectAwareSqlType, custom types that depend on the dialect of the active database connection. This can be used to use native types not supported by drift (like UUIDs) on databases that support it while falling back to a text type on sqlite3.
• Close wasm databases hosted in workers after the last client disconnects.
• Add enableMigrations parameter to NativeDatabase which can be used to optionally disable database migrations when opening databases.
• Support jsonb functions in the Dart query builder.

• Fix WasmProbeResult.open ignoring the ìnitializeDatabase callback.

• Add the QueryInterceptor API to easily monitor or transform all database calls made by drift.
• Add the count() extension on tables to easily count rows in tables or views.

• Fix a race condition causing query streams to not emit new data around some transaction setups.

• Fix a bug when running batches over serialized communication channels.

• Add APIs to setup Wasm databases with custom drift workers.
• Add support for custom types, which are useful when extending drift to support other database engines.
• Drift now provides a DevTools extension embedding the drift inspector written by Koen Van Looveren.
• Add Expression.and and Expression.or to create disjunctions and conjunctions of sub-predicates.
• Step-by-step migrations now save the intermediate schema version after each step.

• Fix readWithConverter throwing an exception for null values in non- nullable columns.

• Add support for table-valued functions in the Dart query builder.
• Add the @TableIndex annotation for table classes to add an index to the table.
• Support json_each and json_tree.
• Add the TypeConverter.json method to define type converters storing JSON values more easily.
• Add TypedResult.readWithConverter to read a column with a type converter from a join result row.

• Allow using .read() for a column added to a join from the table, fixing a regression in drift 2.11.0.
• Make step-by-step migrations easier to customize with Migrator.runMigrationSteps.

• Add support for subqueries in the Dart query builder.
• Add isInExp and isNotInExp to construct IS IN expressions with arbitrary expressions.
• Add the substr extension on Expression<String> to call the sqlite3 function from the Dart API.
• Add isolateSetup to NativeDatabase.createInBackground() to override native libraries or perform other database-unrelated setup work.
• Add WasmDatabase.probe(), a method probing for available implementations and existing databases on the web without opening one directly.

• Adds the schema steps command to drift_dev. It generates an API making it easier to write safe schema migrations (docs).
• Fix drift WASM not being unusable after a previous database implementation becomes unavailable in the browser.

• Forbid schemaVersion returning 0, as this causes issues in the migrator.
• Drift web support is now stable! By using a WasmDatabase.open factory as described in https://drift.simonbinder.eu/web/, you can run a drift database in modern browsers!

• Fix prepared statements leaking when the statement cache is disabled.
• Disable prepared statement caching by default.

• Performance improvement: Cache and re-use prepared statements - thanks to @davidmartos96
• Fix a deadlock after rolling back a transaction in a remote isolate.
• Remove unintended log messages when using connectToDriftWorker.

• Don't keep databases in an unusable state if the setup callback throws an exception. Instead, drift will retry the next time the database is used.
• Allow targeting partial indices in DoUpdate (#2394)
• Fix deadlocks when computeWithDatabase is called inside a transaction().

• Add support for CASE expressions without a base in the Dart API with the CaseWhenExpression class.
• Add the new package:drift/web/workers.dart library which makes it easier to create web workers for drift.

• Add insertReturningOrNull for potentially empty inserts.
• Add insertFromSelect to InsertStatement to run INSERT INTO SELECT statements.
• Add rowid parameter to companions for tables with rowids that don't have a visible alias for the rowid.
• After opening a database with a higher schema version than the current one set in the database class, the schema version in the database will now be downgraded.
• When using a drift isolate in the same engine group, errors on the remote end are reported directly instead of wrapping them in a DriftRemoteException.
• Added support for DO NOTHING during upsert operations with constraint violations

• Add isExp, isValue, isNotExp and isNotValue methods to Expression to generate the IS operator in SQL.
• Add all() extension on tables and views to quickly query all rows.
• Add serializableConnection() and computeWithDatabase() as extensions on databases. The methods allow sharing any drift database between isolates, regardless of how the database has been set up.
• The DatabaseConnection class now implements QueryExecutor, meaning that you no longer need a special .connect() constructor to use it.

• Fix an exception when a client disconnects from a drift remote server while processing a pending table update.

• Fix DriftIsolate leaking resources for closed connections.