Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gavanitrate/faunadb-http-dart
A pure Dart implementation of a FaunaDB client and provides query classes that closely mimic FQL functions.
https://github.com/gavanitrate/faunadb-http-dart
dart database faunadb flutter
Last synced: about 1 month ago
JSON representation
A pure Dart implementation of a FaunaDB client and provides query classes that closely mimic FQL functions.
- Host: GitHub
- URL: https://github.com/gavanitrate/faunadb-http-dart
- Owner: gavanitrate
- License: mit
- Created: 2020-06-18T22:02:54.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T09:21:05.000Z (8 months ago)
- Last Synced: 2024-07-05T05:06:04.462Z (2 months ago)
- Topics: dart, database, faunadb, flutter
- Language: Dart
- Homepage:
- Size: 181 KB
- Stars: 33
- Watchers: 3
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fauna - Dart
README
# faunadb-http
A pure Dart implementation of a [FaunaDB][faunadb] client. This library also provides query classes that closely mimic
FQL functions.
[faunadb]: https://fauna.com/
## Usage
### Basic Example
```dart
import 'package:faunadb_http/faunadb_http.dart';
import 'package:faunadb_http/query.dart';
void main() async {
final config = FaunaConfig.build(
secret: '',
);
final client = FaunaClient(config);
final query = Paginate(Match(Index('all_customers')));
final result = await client.query(query);
print(result);
client.close();
}
```
### Writing Queries
After importing the query classes from this package
(as in the example above), your queries will look almost identical to [FQL][fql].
Check out the [FQL Cheat Sheet][cheat_sheet] to see all valid FQL functions.
[fql]: https://docs.fauna.com/fauna/current/api/fql/
[cheat_sheet]: https://docs.fauna.com/fauna/current/api/fql/cheat_sheet
#### Example Queries
```dart
// segment from example/crud.dart
//
// create
//
final createCollection = CreateCollection(Obj({'name': 'users'}));
final createDocument = Create(
Collection('users'),
Obj({
'data': {'name': 'Gavan Singh'}
}),
);
final createIndex = CreateIndex(Obj({
'name': 'user-by-name',
'source': Collection('users'),
'terms': [
{
'field': ['data', 'name']
}
]
}));
final createFunction = CreateFunction(Obj({
'name': 'double',
'body': Query(Lambda('x', Add([Var('x'), Var('x')])))
}));
//
// read
//
final callDoubleFunction = Call(Function_('double'), arguments: 2);
final paginateUsers = Paginate(
Match(Index('user-by-name'), terms: ['Gavan Singh']),
);
final readUser = Get(Ref(Collection('users'), '281080202238362125'));
final readAllUsers = Map_(
Paginate(Match(Index('all_Users'))),
Lambda(
'userRef',
Let(
{
'userDoc': Get(Var('userRef')),
},
Obj(
{
'id': Select(['ref', 'id'], Var('userDoc')),
'name': Select(['data', 'name'], Var('userDoc')),
},
),
),
),
);
final paginateCollections = Paginate(Collections());
//
// update
//
final updateUser = Update(
Ref(Collection('users'), '281080202238362125'),
Obj({
'data': {'isCool': true}
}),
);
//
// delete
//
final deleteUser = Delete(Ref(Collection('users'), '281080202238362125'));
```
### Query Differences
There are some cases where your queries will have to be written slightly differently from pure FQL. Here are examples of
each type of difference.
- Optional FQL arguments are named arguments in Dart.
- `Repeat('x', number: 10)`
- `Paginate(Collections(), size: 2)`
- FQL functions with a variable number of arguments (such as Sum, GT etc.) accept a Dart List instead.
- `Add([1, Var('x')])`
- Some FQL functions and arguments are reserved keywords in Dart; simply add a trailing underscore to them.
- `Map` becomes `Map_`
- `Function` becomes `Function_`
- `default` becomes `default_`
## Build
The `json_serializable` package provides JSON serialization to the query classes.
Run `pub run build_runner build` to generate the boilerplate code to add JSON serialization.
`pub run build_runner watch` is great when trying things out.
## Contributors
Can be found in `CONTRIBUTORS.md`