46 lines
1.4 KiB
Markdown
46 lines
1.4 KiB
Markdown
# A Sembast Persistent Service for Angel3
|
|
|
|
[](https://pub.dartlang.org/packages/angel3_sembast)
|
|
[](https://dart.dev/null-safety)
|
|
[](https://gitter.im/angel_dart/discussion)
|
|
|
|
[](https://github.com/dukefirehawk/angel/tree/angel3/packages/sembast/LICENSE)
|
|
|
|
A plugin service that persist data to Sembast for Angel3 framework.
|
|
|
|
## Installation
|
|
|
|
Add the following to your `pubspec.yaml`:
|
|
|
|
```yaml
|
|
dependencies:
|
|
angel3_sembast: ^2.0.0
|
|
```
|
|
|
|
## Usage
|
|
|
|
This library exposes one main class: `SembastService`.
|
|
|
|
### SembastService
|
|
|
|
This class interacts with a `Database` and `Store` (from `package:sembast`) and serializes data to and from Maps.
|
|
|
|
### Querying
|
|
|
|
You can query these services as follows:
|
|
|
|
```dart
|
|
/path/to/service?foo=bar
|
|
```
|
|
|
|
The above will query the database to find records where 'foo' equals 'bar'.
|
|
|
|
The former will sort result in ascending order of creation, and so will the latter.
|
|
|
|
```dart
|
|
List queried = await MyService.index({r"query": where.id(Finder(filter: Filter(...))));
|
|
```
|
|
|
|
Of course, you can use `package:sembast` queries. Just pass it as `query` within `params`.
|
|
|
|
See the tests for more usage examples.
|