AMT-Cheif
/
drift
mirror of https://github.com/AMT-Cheif/drift.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Stop mentioning `compact_query_methods` (#2036)

This commit is contained in:
Simon Binder 2022-09-05 13:54:47 +02:00
parent 161b99d8d5
commit eb7299c2d5
No known key found for this signature in database
GPG Key ID: 7891917E4147B8C0
3 changed files with 3 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/pages/docs/Advanced Features/builder_options.md
View File

@ -26,7 +26,7 @@ targets:
builders: builders:
drift_dev: drift_dev:
options: options:
compact_query_methods: true store_date_time_values_as_text: true
``` ```
## Available options ## Available options
@ -40,12 +40,6 @@ At the moment, drift supports these options:
to hold the result of generated select queries, this flag controls whether drift should to hold the result of generated select queries, this flag controls whether drift should
override `operator ==` and `hashCode` in those classes. In recent versions, it will also override `operator ==` and `hashCode` in those classes. In recent versions, it will also
override `toString` if this option is enabled. override `toString` if this option is enabled.
* `compact_query_methods` (defaults to `true`):
For queries declared on a `@DriftDatabase` or `@DriftAccessor` annotation, drift used to generate three methods:
A base method returning a `Selectable` and then two helper methods returning a `Stream` or a `Future`.
As the `Selectable` class contains its own methods to convert it to a `Stream` and `Future`, the two
later methods only exist for backwards compatibility. When this flag is enabled, drift won't write them at all.
This flag is enabled by default in moor 3.0 and drift, but it can still be disabled.
* `skip_verification_code`: Generated tables contain a significant chunk of code to verify integrity * `skip_verification_code`: Generated tables contain a significant chunk of code to verify integrity
of inserted data and report detailed errors when the integrity is violated. If you're only using of inserted data and report detailed errors when the integrity is violated. If you're only using
inserts with SQL, or don't need this functionality, enabling this flag can help to reduce the amount inserts with SQL, or don't need this functionality, enabling this flag can help to reduce the amount
@ -61,8 +55,6 @@ At the moment, drift supports these options:
(e.g. `user_name VARCHAR NOT NULL JSON KEY userName`). (e.g. `user_name VARCHAR NOT NULL JSON KEY userName`).
* `generate_connect_constructor`: Generate necessary code to support the [isolate runtime]({{ "isolates.md" | pageUrl }}). * `generate_connect_constructor`: Generate necessary code to support the [isolate runtime]({{ "isolates.md" | pageUrl }}).
This is a build option because isolates are still experimental. This will be the default option eventually. This is a build option because isolates are still experimental. This will be the default option eventually.
* `eagerly_load_dart_ast`: Drift's builder will load the resolved AST whenever it encounters a Dart file,
instead of lazily when it reads a table. This is used to investigate rare builder crashes.
* `data_class_to_companions` (defaults to `true`): Controls whether drift will write the `toCompanion` method in generated * `data_class_to_companions` (defaults to `true`): Controls whether drift will write the `toCompanion` method in generated
data classes. data classes.
* `mutable_classes` (defaults to `false`): The fields generated in generated data, companion and result set classes are final * `mutable_classes` (defaults to `false`): The fields generated in generated data, companion and result set classes are final

2
docs/pages/docs/upgrading.md
View File

@ -45,7 +45,7 @@ project. For a full list of updates, see the [changelog](https://pub.dev/package
of your queries, please open an issue! of your queries, please open an issue!
- `null_aware_type_converters`: This is always enabled now with the new - `null_aware_type_converters`: This is always enabled now with the new
semantics for type converters. semantics for type converters.
- `compact_query_method`: Has been enabled by default before, can no longer - `compact_query_methods`: Has been enabled by default before, can no longer
be disabled now. be disabled now.
- `eagerly_load_dart_ast`: This option used to not do anything for a while - `eagerly_load_dart_ast`: This option used to not do anything for a while
and has been removed entirely now. and has been removed entirely now.

1
drift_dev/CHANGELOG.md
View File

@ -19,6 +19,7 @@
- Removes the following build options, which are always turned on now: - Removes the following build options, which are always turned on now:
- `null_aware_type_converters` - `null_aware_type_converters`
- `new_sql_code_generation` - `new_sql_code_generation`
- `compact_query_methods`
- Starting from this version, drift only supports generating non-nullable Dart code. - Starting from this version, drift only supports generating non-nullable Dart code.
You'll have to at least opt your database code into null-safety to use this and You'll have to at least opt your database code into null-safety to use this and
upcoming drift releases. upcoming drift releases.