brick_sqlite 3.2.0+1

brick_sqlite: ^3.2.0+1 copied to clipboard

• DEPRECATION Query(providerArgs: {'collate':}) is now Query(forProviders: [SqliteProviderQuery(collate:)])
• DEPRECATION Query(providerArgs: {'having':}) is now Query(forProviders: [SqliteProviderQuery(having:)])
• DEPRECATION Query(providerArgs: {'groupBy':}) is now Query(forProviders: [SqliteProviderQuery(groupBy:)])
• Association ordering is supported. For example, Query(orderBy: [OrderBy.desc('assoc', associationField: 'name')]) on DemoModel will produce the following SQL statement:

  'SELECT DISTINCT `DemoModel`.* FROM `DemoModel` ORDER BY `DemoModelAssoc`.name DESC'
  

• New SqliteProviderQuery adds Sqlite-specific support for the new Query.
• Column enum is enhanced, performing the conversion between Dart and SQLite column types on the enum instead of in Migration.
• Barrel files are no longer imported to src/ implementations
• Upgrade brick_core to 1.3.0
• Update analysis to modern lints

• Expose a generic type for MemoryCacheProvider models
• Expose a generic type for SqliteProvider models

• Apply standardized lints
• Upgrade minimum Dart to 2.18
• Add extra documentation to the @Sqlite(unique:) annotation

• Support Dart 3

Please follow the v3 migration guide to easily upgrade.

• Combine brick_sqlite_abstract to this package, adding db.dart as an export. This merge also includes SqliteSerializable and SqliteModel, both now exported by brick_sqlite/brick_sqlite.dart
• BREAKING CHANGE Rename main export sqlite.dart to brick_sqlite.dart
• Remove brick_sqlite_abstract dependency
• Add collection as a direct dependency
• Add transaction to SqliteProvider
• Update signature for rawQuery to mirror Sqflite's signature

• Support deeply-nested association querying:

  Where('pizza').isExactly(
    Where('customer').isExactly(
      Where('name', name)
    ),
  )
  // In this example, Car, Pizza, and Customer are all independent Brick models.
  // Car has `final List<Pizza> pizzas`
  // Pizza has `final Person customer`
  // Customer has `final String name`
  

• Use the table name prefix in SQL queries for identically-named association columns

• Loosen dependency restrictions to major versions
• Privatize SqliteProvider.MIGRATION_VERSIONS_TABLE_NAME to _migrationVersionsTableName
• BREAKING CHANGE Use sqflite_common instead of sqflite, permitting this package to be used without Flutter.

• When using a DateTime field with an operator (ORDER BY, HAVING, GROUP BY, etc), wrap the ORDER BY queries in datetime

• Fix edge case where 'ambiguous column name' was thrown on exists queries with an association constraint and declared OFFSET
• Add Flutter Lints
• Change instance and data positional arguments in SqliteAdapter to input to match generator variable

• Require provider in SqliteAdapter#fromSqlite, SqliteAdapter#toSqlite, SqliteAdapter#beforeSave, SqliteAdapter#afterSave

• Migrate to null safety

• Support columnType from SQLite annotations
• When deleting many associations from a parent, remove the association in the joins table but do not delete the instance. This is only applicable to non-final instance fields. (#112)
• Support spaces in compound orderBy clauses (i.e. 'orderBy': 'firstField DESC, secondField ASC' where previously only 'orderBy': 'firstField DESC,secondField ASC' worked)

• Fix: when non-SQLite providerArgs are provided in a query, false is no longer returned from SqliteProvider#exists

• Internal: Change SqliteAdpater#fieldsToSqliteColumns type from Map<String, Map<String, dynamic>> to Map<String, RuntimeSqliteColumnDefinition>. Using such a dynamic type option will lead to inconsistency when accessing the values.
• SqliteAdapter#primaryKeyByUniqueColumn will return instance?.primaryKey instead of null when no @Sqlite(unique: true) fields exist.
• Internal: Refactor organization of files: SqliteProvider, SqliteAdapter, SqliteModelDictionary are separated. lib/sqlite.dart is now a barrel file with the same exports.

• Fix: recreate SQLite DB after reset instead of attempting to open a closed DB

• Access SQLite db safely to avoid race conditions
• Lint: do not use implicit types

• Handle empty conditions when constructing a statement from a WherePhrase
• SQL COUNT(*) does not work with OFFSET clauses; run an inexpensive SELECT query instead in .exists to accomodate OFFSET

• Revise exists in SqliteProvider to query with a SQL statement instead of hydrating whole models and associations
• Add selectStatement to QuerySqlTransformer's default constructor. When true, statement will begin SELECT FROM; when false, statement will begin SELECT COUNT(*). Defaults true.

• When searching with doesNotContain apply same fuzzy search % that Compare.contains enjoys

• Bump SQFlite
• Remove path as a dependency and rely on SQFlite's default accessors when opening a database
• Mark SqliteProvider#migrateFromStringToJoinsTable as deprecated to signal that it should be removed from implementations as soon as possible.
• Support migrations in SQLite >=3.26. 3.26 introduced a better way to update foreign key associations that is accessible in iOS's FMDB. However, since versions prior to 3.26 are used by Android, the foreign_keys hack is still necessary to maintain backwards compatibility. Hat tip to this SO answer.

• Ignore when inserting associations

• Fix SQL query for joins

• Add beforeSave and a fterSave hooks to the SqliteAdapter
• BREAKING CHANGE One-to-many and many-to-many SQLite associations are no longer stored as JSON-encoded strings (i.e. [1, 2, 3] in a varchar column). Join tables are now generated by Brick. To convert existing data, please follow the next steps carefully. If you do not care about existing migration and have not widely distributed your app, simply delete all existing migrations, delete all existing app installs, and run flutter pub run build_runner build in your project root.
  1. Run flutter pub run build_runner build in your project root.
  2. In the created migration file, remove any DropColumn commands from the up statements.
  3. Run this for each DropColumn after super.migrate.

     class MyRepository extends OfflineFirstWithRestRepository {
       @override
       Future<void> migrate() async {
         await super.migrate();
         // TODO update this table with information from the deleted `DropColumn` commands in step 2.
         final joinsTableColumnMigrations = [
           {
             'localTableName': 'User'
             'columnName': 'hats',
             'foreignTableName': 'Hat',
           },
         ];
         for (var entry in joinsTableColumnMigrations) {
           await sqliteProvider.migrateFromStringToJoinsTable(entry['columnName'], entry['localTableName'], entry['foreignTableName']);
         }
       }
     }
     

  4. Continue to remove DropColumn from generated migrations until you've safely distributed the update.

• Add StubSqlite.queryValueForColumn to discover the passed argument for a specific column
• Support OR clauses in StubSqlite. This publicly exposes StubSqlite.queryMatchesResponse.
• Bump synchronized and sqflite packages to support reentrant locks
• #52 Support multiplatform with sqlite_ffi
• BREAKING CHANGE Remove StubSqlite. sqlite_ffi is an in-memory instance of SQLite that can be used in unit test environments. StubSqlite can introduce edge cases not consistent with a real-world SQLite instance.

• Field names should always be used instead of column names in Query#providerArgs:
• Boolean responses from StubSqlite are converted to 1 and 0. QuerySqlTransformer converts input boolean values in queries to 1 or 0 to ensure they're serialized and compared properly in SQLite; this change ensures the other end performs the same conversion
• Add test coverage for StubSqlite
• Fixes an edge case in the QuerySqlTransformer where overlapping field names were replaced multiple times by the fieldsToColumns map, resulting in an improper column names

• Rename Query#params to Query#providerArgs, reflecting the much narrower purpose of the member

• Fix linter hints