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

Update packages used in documentation

This commit is contained in:
Simon Binder 2023-09-10 22:19:41 +02:00
parent c3d2065d96
commit da0392c7ce
No known key found for this signature in database
GPG Key ID: 7891917E4147B8C0
11 changed files with 97 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/lib/sample/database.dart
View File

@ -87,7 +87,7 @@ Future<WasmDatabaseResult> connect() async {
final result = await WasmDatabase.open( final result = await WasmDatabase.open(
databaseName: 'todo_example', databaseName: 'todo_example',
sqlite3Uri: Uri.parse('sqlite3.wasm'), sqlite3Uri: Uri.parse('sqlite3.wasm'),
driftWorkerUri: Uri.parse('drift_worker.dart.js'), driftWorkerUri: Uri.parse('/drift_worker.dart.js'),
); );
if (!result.chosenImplementation.fullySupported) { if (!result.chosenImplementation.fullySupported) {

66
docs/pages/docs/Advanced Features/type_converters.md
View File

@ -34,8 +34,8 @@ the object in `select`, `update` and `insert` statements. This feature
also works with [compiled custom queries]({{ "/queries/custom" | absUrl }}). also works with [compiled custom queries]({{ "/queries/custom" | absUrl }}).
{% block "blocks/alert" title="Caution with equality" color="warning" %} {% block "blocks/alert" title="Caution with equality" color="warning" %}
> If your converter returns an object that is not comparable by value, the generated dataclass will not If your converter returns an object that is not comparable by value, the generated dataclass will not
be comparable by value. be comparable by value.
{% endblock %} {% endblock %}
### Implicit enum converters ### Implicit enum converters
@ -59,23 +59,23 @@ class Tasks extends Table {
``` ```
{% block "blocks/alert" title="Caution with enums" color="warning" %} {% block "blocks/alert" title="Caution with enums" color="warning" %}
> It can be easy to accidentally invalidate your database by introducing another enum value. It can be easy to accidentally invalidate your database by introducing another enum value.
For instance, let's say we inserted a `Task` into the database in the above example and set its For instance, let's say we inserted a `Task` into the database in the above example and set its
`Status` to `running` (index = 1). `Status` to `running` (index = 1).
Now we modify `Status` enum to include another entry: Now we modify `Status` enum to include another entry:
```dart ```dart
enum Status { enum Status {
none, none,
starting, // new! starting, // new!
running, running,
stopped, stopped,
paused paused
} }
``` ```
When selecting the task, it will now report as `starting`, as that's the new value at index 1. When selecting the task, it will now report as `starting`, as that's the new value at index 1.
For this reason, it's best to add new values at the end of the enumeration, where they can't conflict For this reason, it's best to add new values at the end of the enumeration, where they can't conflict
with existing values. Otherwise you'd need to bump your schema version and run a custom update statement with existing values. Otherwise you'd need to bump your schema version and run a custom update statement
to fix this. to fix this.
{% endblock %} {% endblock %}
If you prefer to store the enum as a text, you can use `textEnum` instead. If you prefer to store the enum as a text, you can use `textEnum` instead.
@ -95,21 +95,21 @@ class Tasks extends Table {
``` ```
{% block "blocks/alert" title="Caution with enums" color="warning" %} {% block "blocks/alert" title="Caution with enums" color="warning" %}
> It can be easy to accidentally invalidate your database by renaming your enum values. It can be easy to accidentally invalidate your database by renaming your enum values.
For instance, let's say we inserted a `Task` into the database in the above example and set its For instance, let's say we inserted a `Task` into the database in the above example and set its
`Status` to `running`. `Status` to `running`.
Now we modify `Status` enum to rename `running` into `processing`: Now we modify `Status` enum to rename `running` into `processing`:
```dart ```dart
enum Status { enum Status {
none, none,
processing, processing,
stopped, stopped,
paused paused
} }
``` ```
When selecting the task, it won't be able to find the enum value `running` anymore, and will throw an error. When selecting the task, it won't be able to find the enum value `running` anymore, and will throw an error.
For this reason, it's best to not modify the name of your enum values. Otherwise you'd need to bump your schema version and run a custom update statement to fix this. For this reason, it's best to not modify the name of your enum values. Otherwise you'd need to bump your schema version and run a custom update statement to fix this.
{% endblock %} {% endblock %}
Also note that you can't apply another type converter on a column declared with an enum converter. Also note that you can't apply another type converter on a column declared with an enum converter.

18
docs/pages/docs/Getting started/index.md
View File

@ -77,16 +77,16 @@ The ["Writing queries"]({{ "writing_queries.md" | pageUrl }}) article contains e
to know to write selects, updates and inserts in drift! to know to write selects, updates and inserts in drift!
{% block "blocks/alert" title="Using the database" %} {% block "blocks/alert" title="Using the database" %}
> The database class from this guide is ready to be used with your app. The database class from this guide is ready to be used with your app.
For Flutter apps, a Drift database class is typically instantiated at the top of your widget tree For Flutter apps, a Drift database class is typically instantiated at the top of your widget tree
and then passed down with `provider` or `riverpod`. and then passed down with `provider` or `riverpod`.
See [using the database]({{ '../faq.md#using-the-database' | pageUrl }}) for ideas on how to integrate See [using the database]({{ '../faq.md#using-the-database' | pageUrl }}) for ideas on how to integrate
Drift into your app's state management. Drift into your app's state management.
The setup in this guide uses [platform channels](https://flutter.dev/docs/development/platform-integration/platform-channels), The setup in this guide uses [platform channels](https://flutter.dev/docs/development/platform-integration/platform-channels),
which are only available after running `runApp` by default. which are only available after running `runApp` by default.
When using drift before your app is initialized, please call `WidgetsFlutterBinding.ensureInitialized()` before using When using drift before your app is initialized, please call `WidgetsFlutterBinding.ensureInitialized()` before using
the database to ensure that platform channels are ready. the database to ensure that platform channels are ready.
{% endblock %} {% endblock %}
- The articles on [writing queries]({{ 'writing_queries.md' | pageUrl }}) and [Dart tables]({{ 'advanced_dart_tables.md' | pageUrl }}) introduce important concepts of the Dart API used to write queries. - The articles on [writing queries]({{ 'writing_queries.md' | pageUrl }}) and [Dart tables]({{ 'advanced_dart_tables.md' | pageUrl }}) introduce important concepts of the Dart API used to write queries.

18
docs/pages/docs/Getting started/starting_with_sql.md
View File

@ -94,14 +94,14 @@ further guides to help you learn more:
on `drift` files, which explains `import` statements and the Dart-SQL interop. on `drift` files, which explains `import` statements and the Dart-SQL interop.
{% block "blocks/alert" title="Using the database" %} {% block "blocks/alert" title="Using the database" %}
> The database class from this guide is ready to be used with your app. The database class from this guide is ready to be used with your app.
For Flutter apps, a Drift database class is typically instantiated at the top of your widget tree For Flutter apps, a Drift database class is typically instantiated at the top of your widget tree
and then passed down with `provider` or `riverpod`. and then passed down with `provider` or `riverpod`.
See [using the database]({{ '../faq.md#using-the-database' | pageUrl }}) for ideas on how to integrate See [using the database]({{ '../faq.md#using-the-database' | pageUrl }}) for ideas on how to integrate
Drift into your app's state management. Drift into your app's state management.
The setup in this guide uses [platform channels](https://flutter.dev/docs/development/platform-integration/platform-channels), The setup in this guide uses [platform channels](https://flutter.dev/docs/development/platform-integration/platform-channels),
which are only available after running `runApp` by default. which are only available after running `runApp` by default.
When using drift before your app is initialized, please call `WidgetsFlutterBinding.ensureInitialized()` before using When using drift before your app is initialized, please call `WidgetsFlutterBinding.ensureInitialized()` before using
the database to ensure that platform channels are ready. the database to ensure that platform channels are ready.
{% endblock %} {% endblock %}

12
docs/pages/docs/Getting started/writing_queries.md
View File

@ -274,12 +274,12 @@ Future<void> trackWord(String word) {
``` ```
{% block "blocks/alert" title="Unique constraints and conflict targets" %} {% block "blocks/alert" title="Unique constraints and conflict targets" %}
> Both `insertOnConflictUpdate` and `onConflict: DoUpdate` use an `DO UPDATE` Both `insertOnConflictUpdate` and `onConflict: DoUpdate` use an `DO UPDATE`
upsert in sql. This requires us to provide a so-called "conflict target", a upsert in sql. This requires us to provide a so-called "conflict target", a
set of columns to check for uniqueness violations. By default, drift will use set of columns to check for uniqueness violations. By default, drift will use
the table's primary key as conflict target. That works in most cases, but if the table's primary key as conflict target. That works in most cases, but if
you have custom `UNIQUE` constraints on some columns, you'll need to use you have custom `UNIQUE` constraints on some columns, you'll need to use
the `target` parameter on `DoUpdate` in Dart to include those columns. the `target` parameter on `DoUpdate` in Dart to include those columns.
{% endblock %} {% endblock %}
Note that this requires a fairly recent sqlite3 version (3.24.0) that might not Note that this requires a fairly recent sqlite3 version (3.24.0) that might not

24
docs/pages/docs/platforms.md
View File

@ -56,19 +56,19 @@ It only applies to your full Flutter app though, it can't override the sqlite3 v
with `flutter test`. with `flutter test`.
{% block "blocks/alert" title="A note on ffi and Android" %} {% block "blocks/alert" title="A note on ffi and Android" %}
> `package:drift/native.dart` is the recommended drift implementation for new Android apps. `package:drift/native.dart` is the recommended drift implementation for new Android apps.
However, there are some smaller issues on some devices that you should be aware of: However, there are some smaller issues on some devices that you should be aware of:
- Using `sqlite3_flutter_libs` will include prebuilt binaries for 32-bit `x86` devices which you - Using `sqlite3_flutter_libs` will include prebuilt binaries for 32-bit `x86` devices which you
probably won't need. You can apply a [filter](https://github.com/simolus3/sqlite3.dart/tree/master/sqlite3_flutter_libs#included-platforms) probably won't need. You can apply a [filter](https://github.com/simolus3/sqlite3.dart/tree/master/sqlite3_flutter_libs#included-platforms)
in your `build.gradle` to remove those binaries. in your `build.gradle` to remove those binaries.
- Opening `libsqlite3.so` fails on some Android 6.0.1 devices. This can be fixed by setting - Opening `libsqlite3.so` fails on some Android 6.0.1 devices. This can be fixed by setting
`android.bundle.enableUncompressedNativeLibs=false` in your `gradle.properties` file. `android.bundle.enableUncompressedNativeLibs=false` in your `gradle.properties` file.
Note that this will increase the disk usage of your app. See [this issue](https://github.com/simolus3/drift/issues/895#issuecomment-720195005) Note that this will increase the disk usage of your app. See [this issue](https://github.com/simolus3/drift/issues/895#issuecomment-720195005)
for details. for details.
- Out of memory errors for very complex queries: Since the regular tmp directory isn't available on Android, you need to inform - Out of memory errors for very complex queries: Since the regular tmp directory isn't available on Android, you need to inform
sqlite3 about the right directory to store temporary data. See [this comment](https://github.com/simolus3/drift/issues/876#issuecomment-710013503) sqlite3 about the right directory to store temporary data. See [this comment](https://github.com/simolus3/drift/issues/876#issuecomment-710013503)
for an example on how to do that. for an example on how to do that.
{% endblock %} {% endblock %}
## Web ## Web

10
docs/pages/docs/testing.md
View File

@ -54,22 +54,22 @@ class MyDatabase extends _$MyDatabase {
We can't distribute an sqlite installation as a pub package (at least We can't distribute an sqlite installation as a pub package (at least
not as something that works outside of a Flutter build), so you need not as something that works outside of a Flutter build), so you need
to ensure that you have the sqlite3 shared library installed on your to ensure that you have the sqlite3 shared library installed on your
system. system.
On macOS, it's installed by default. On macOS, it's installed by default.
On Linux, you can use the `libsqlite3-dev` package on Ubuntu and the On Linux, you can use the `libsqlite3-dev` package on Ubuntu and the
`sqlite3` package on Arch (other distros will have similar packages). `sqlite3` package on Arch (other distros will have similar packages).
On Windows, you can [download 'Precompiled Binaries for Windows'](https://www.sqlite.org/download.html) On Windows, you can [download 'Precompiled Binaries for Windows'](https://www.sqlite.org/download.html)
and extract `sqlite3.dll` into a folder that's in your `PATH` and extract `sqlite3.dll` into a folder that's in your `PATH`
environment variable. Then restart your device to ensure that environment variable. Then restart your device to ensure that
all apps will run with this `PATH` change. all apps will run with this `PATH` change.
{% endblock %} {% endblock %}
## Writing tests ## Writing tests
We can create an in-memory version of the database by using a We can create an in-memory version of the database by using a
`NativeDatabase.memory()` instead of a `FlutterQueryExecutor` or other implementations. A good `NativeDatabase.memory()` instead of a `FlutterQueryExecutor` or other implementations. A good
place to open the database is the `setUp` and `tearDown` methods from place to open the database is the `setUp` and `tearDown` methods from
`package:test`: `package:test`:
@ -77,7 +77,7 @@ place to open the database is the `setUp` and `tearDown` methods from
import 'package:drift/native.dart'; import 'package:drift/native.dart';
import 'package:test/test.dart'; import 'package:test/test.dart';
// the file defined above, you can test any drift database of course // the file defined above, you can test any drift database of course
import 'database.dart'; import 'database.dart';
void main() { void main() {
MyDatabase database; MyDatabase database;

19
docs/pubspec.yaml
View File

@ -11,12 +11,12 @@ dependencies:
json_annotation: ^4.8.1 json_annotation: ^4.8.1
docsy: docsy:
hosted: https://simonbinder.eu hosted: https://simonbinder.eu
version: ^0.2.2 version: ^0.2.3
code_snippets: code_snippets:
hosted: https://simonbinder.eu hosted: https://simonbinder.eu
version: ^0.0.12 version: ^0.0.13
# used in snippets # used in snippets
http: ^0.13.5 http: ^1.1.0
sqlite3: ^2.0.0 sqlite3: ^2.0.0
# Fake path_provider for snippets # Fake path_provider for snippets
path_provider: path_provider:
@ -38,16 +38,14 @@ dev_dependencies:
build_web_compilers: ^4.0.0 build_web_compilers: ^4.0.0
built_site: built_site:
hosted: https://simonbinder.eu hosted: https://simonbinder.eu
version: ^0.2.15 version: ^0.2.16
linkcheck: ^3.0.0
json_serializable: ^6.1.6 json_serializable: ^6.1.6
shelf: ^1.2.0 shelf: ^1.2.0
shelf_static: ^1.1.0 shelf_static: ^1.1.0
source_span: ^1.9.1 source_span: ^1.9.1
test: ^1.18.0 test: ^1.18.0
sqlparser: sqlparser:
zap_dev: ^0.2.2 zap_dev: ^0.2.3+1
dependency_overrides: dependency_overrides:
# todo: Remove after https://github.com/dart-lang/mime/pull/43 # todo: Remove after https://github.com/dart-lang/mime/pull/43
@ -55,10 +53,3 @@ dependency_overrides:
git: git:
url: https://github.com/simolus3/mime.git url: https://github.com/simolus3/mime.git
ref: woff2 ref: woff2
# The bootstrap_sass on pub.dev doesn't support null safety, so I'm hosting
# https://github.com/dart-league/bootstrap_sass/pull/13.
# Hopefully this can change soon once docsy migrates to bootstrap 5
bootstrap_sass:
hosted:
url: https://simonbinder.eu
version: "4.6.0"

22
docs/templates/partials/footer.html vendored
View File

@ -1,29 +1,29 @@
{% assign links = site.links %} {% assign links = site.links %}
<footer class="bg-dark py-5 row d-print-none"> <footer class="td-footer row d-print-none">
<div class="container-fluid mx-sm-5"> <div class="container-fluid">
<div class="row"> <div class="row mx-md-2">
<div class="col-6 col-sm-4 text-xs-center order-sm-2"> <div class="col-6 col-sm-4 text-xs-center order-sm-2">
{% if links.user %} {% if links.user %}
{% assign links = links.user %} {% assign links = links.user %}
{% include "partials/footer-links-block.html" %} {% include "partials/footer-links-block.html" %}
{% endif %} {% endif %}
</div> </div>
<div class="col-6 col-sm-4 text-right text-xs-center order-sm-3"> <div class="col-6 col-sm-4 text-end text-xs-center order-sm-3">
{% if links.developer %} {% if links.developer %}
{% assign links = links.developer %} {% assign links = links.developer %}
{% include "partials/footer-links-block.html" %} {% include "partials/footer-links-block.html" %}
{% endif %} {% endif %}
</div> </div>
<div class="col-12 col-sm-4 text-center py-2 order-sm-2"> <div class="td-footer__copyright-etc col-12 col-sm-4 text-center py-2 order-sm-2">
{% if site.copyright %} {% if site.copyright %}
<small class="text-white"><div>&copy; {{ site.copyright }}</div> <span><div>&copy; {{ site.copyright }}</div>
Except where otherwise noted, content on this site is licensed under a <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer">CC BY 4.0</a> license. Except where otherwise noted, content on this site is licensed under a <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer">CC BY 4.0</a> license.
Code snippets are marked with <a href="http://creativecommons.org/publicdomain/zero/1.0" target="_blank" rel="license noopener noreferrer">CC0 1.0</a>, Code snippets are marked with <a href="http://creativecommons.org/publicdomain/zero/1.0" target="_blank" rel="license noopener noreferrer">CC0 1.0</a>,
drift itself is <a href="https://github.com/simolus3/drift/blob/develop/LICENSE" rel="license" target="_blank">MIT-licensed</a>. drift itself is <a href="https://github.com/simolus3/drift/blob/develop/LICENSE" rel="license" target="_blank">MIT-licensed</a>.
</small> </span>
{% endif %} {% endif %}
{% if site.privacy_policy %} {% if site.privacy_policy %}
<small class="ml-1"><a href="{{ site.privacy_policy }}" target="_blank">{{ "footer_privacy_policy" | i18n }}</a></small> <span class="ml-1"><a href="{{ site.privacy_policy }}" target="_blank">{{ "footer_privacy_policy" | i18n }}</a></span>
{% endif %} {% endif %}
</div> </div>
</div> </div>

8
docs/website.yaml
View File

@ -16,9 +16,9 @@ site:
- name: "Contact me via e-mail" - name: "Contact me via e-mail"
url: "mailto:oss@simonbinder.eu" url: "mailto:oss@simonbinder.eu"
icon: "fa fa-envelope" icon: "fa fa-envelope"
- name: "Room in gitter" # - name: "Room in gitter"
url: "https://gitter.im/moor-dart/community" # url: "https://gitter.im/moor-dart/community"
icon: "fab fa-gitter" # icon: "fab fa-gitter"
- name: "Project on GitHub" - name: "Project on GitHub"
url: "https://github.com/simolus3/drift" url: "https://github.com/simolus3/drift"
icon: "fab fa-github" icon: "fab fa-github"
@ -29,8 +29,10 @@ site:
url: "/docs/" url: "/docs/"
- name: "Pub" - name: "Pub"
url: "https://pub.dev/packages/drift" url: "https://pub.dev/packages/drift"
external: true
- name: "GitHub" - name: "GitHub"
url: "https://github.com/simolus3/drift/" url: "https://github.com/simolus3/drift/"
external: true
- name: "API docs" - name: "API docs"
url: "/api/" url: "/api/"

2
drift_dev/pubspec.yaml
View File

@ -35,7 +35,7 @@ dependencies:
sqlparser: '^0.31.0' sqlparser: '^0.31.0'
# Dart analysis # Dart analysis
analyzer: ^5.12.0 analyzer: '>=5.12.0 <7.0.0'
analyzer_plugin: ^0.11.0 analyzer_plugin: ^0.11.0
source_span: ^1.5.5 source_span: ^1.5.5
package_config: ^2.0.0 package_config: ^2.0.0