https://github.com/pyrestudios/dwell
An EXPERIMENTAL reflection-based data access layer for Dart
https://github.com/pyrestudios/dwell
Last synced: about 1 year ago
JSON representation
An EXPERIMENTAL reflection-based data access layer for Dart
- Host: GitHub
- URL: https://github.com/pyrestudios/dwell
- Owner: PyreStudios
- Created: 2022-04-29T18:02:10.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-05T03:05:11.000Z (about 2 years ago)
- Last Synced: 2024-05-01T11:28:33.604Z (about 2 years ago)
- Language: Dart
- Size: 46.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Dwell
A reflection based data abstraction layer for Dart
[](https://codecov.io/gh/PyreStudios/dwell)
This package is intended for non-clientside development (servers, clis, etc). It uses reflection and will not work with Flutter (sorry). If you find this package useful, please voice your opinion on [keeping reflection around in dart here](https://github.com/dart-lang/sdk/issues/44489).
## Features
Dwell helps create a data abstraction layer (like an ORM sort of, but not quite) by providing a DSL for creating and executing queries against common databases. Dwell tries to keep you in control of your queries, but helps abstract some of the pain points away.
Currently, we only support Postgres, but adding adapter support for other databases should be relatively painless.
## Getting started
TODO: List prerequisites and provide or point to information on how to
start using the package.
## Usage
```dart
import 'package:dwell/dwell.dart';
import 'package:dwell/src/adapters/postgres_adapter.dart';
import 'package:postgres/postgres.dart';
class Post implements SchemaObject {
String uuid;
String content;
// Dwell only supports named parameters.
Post({required this.uuid, required this.content});
@override
Map toMap() {
return {
'uuid': uuid,
'content': content,
};
}
}
final _adapter = PostgresAdapter(
connection: PostgreSQLConnection("localhost", 5432, "dart_test",
username: "dart", password: "dart"));
class PostsTable extends Table {
PostsTable() : super(name: 'posts');
@override
Adapter get adapter => _adapter;
static final uuid = Column('uuid', primaryKey: true);
static final content = Column('content');
}
void main() async {
var p = Post(
'abc-123',
'This is a test post',
);
var table = PostsTable();
// For now, adapter opening and closing needs to be controlled by the user
await _adapter.open();
// You should probably use migrations instead of something like this, but
// we're not your parents, so we won't stop you.
await _adapter.connection.execute('''
CREATE TABLE IF NOT EXISTS posts (
uuid varchar(255) NOT NULL,
content text NOT NULL,
PRIMARY KEY (uuid)
);
''');
await table.delete().where(PostsTable.uuid, '=', p.uuid).execute();
await table.insert(p);
// update content
p.content = "fresh content only";
// persist updated content
await table.update(p).execute();
final post = await table.findByPk('abc-123');
print(post.toMap());
await _adapter.close();
}
```
## Additional information
TODO: Tell users more about the package: where to find more information, how to
contribute to the package, how to file issues, what response they can expect
from the package authors, and more.