Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supabase/postgrest-dart
Dart client for PostgREST
https://github.com/supabase/postgrest-dart
Last synced: about 1 month ago
JSON representation
Dart client for PostgREST
- Host: GitHub
- URL: https://github.com/supabase/postgrest-dart
- Owner: supabase
- License: mit
- Archived: true
- Created: 2020-09-09T04:55:43.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-13T01:28:25.000Z (over 1 year ago)
- Last Synced: 2024-05-01T16:25:41.472Z (6 months ago)
- Language: Dart
- Homepage: https://supabase.com
- Size: 293 KB
- Stars: 137
- Watchers: 12
- Forks: 38
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Postgrest Dart
> **Warning**
> This repository has been moved to the [supabase-flutter repo](https://github.com/supabase/supabase-flutter/tree/main/packages/postgrest).
Dart client for [PostgREST](https://postgrest.org). The goal of this library is to make an "ORM-like" restful interface.
## Using
The usage should be the same as postgrest-js except:
- `data` is directly returned by awaiting the query when count option is not specified.
- Exceptions will not be returned within the response, but will be thrown.
- `is_` and `in_` filter methods are suffixed with `_` sign to avoid collisions with reserved keywords.
You can find detail documentation from [here](https://supabase.com/docs/reference/dart/select).
#### Reading your data
```dart
import 'package:postgrest/postgrest.dart';
final url = 'https://example.com/postgrest/endpoint';
final client = PostgrestClient(url);
final response = await client.from('users').select();
```
#### Reading your data and converting it to an object
```dart
import 'package:postgrest/postgrest.dart';
final url = 'https://example.com/postgrest/endpoint';
final client = PostgrestClient(url);
final response = await client
.from('users')
.select()
.withConverter((data) => data.map(User.fromJson).toList());
```
#### Insert records
```dart
import 'package:postgrest/postgrest.dart';
final url = 'https://example.com/postgrest/endpoint';
final client = PostgrestClient(url);
try {
await client.from('users')
.insert([
{'username': 'supabot', 'status': 'ONLINE'}
]);
} on PostgrestException catch (error, stacktrace) {
// handle a PostgrestError
print('$error \n $stacktrace');
} catch (error, stacktrace) {
// handle other errors
print('$error \n $stracktrace');
}
```
#### Update a record
```dart
import 'package:postgrest/postgrest.dart';
final url = 'https://example.com/postgrest/endpoint';
final client = PostgrestClient(url);
await client.from('users')
.update({'status': 'OFFLINE'})
.eq('username', 'dragarcia');
```
#### Delete records
```dart
import 'package:postgrest/postgrest.dart';
final url = 'https://example.com/postgrest/endpoint';
final client = PostgrestClient(url);
await client.from('users')
.delete()
.eq('username', 'supabot');
```
#### Get Count
```dart
import 'package:postgrest/postgrest.dart';
final url = 'https://example.com/postgrest/endpoint';
final client = PostgrestClient(url);
final response = await client.from('countries')
.select('*', FetchOptions(count: CountOption.exact));
final data = response.data;
final count = response.count;
```
## Contributing
- Fork the repo on [GitHub](https://github.com/supabase/postgrest-dart)
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes and merge
## License
This repo is licensed under MIT.
## Credits
- https://github.com/supabase/postgrest-js - ported from postgrest-js library