Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattgson/gybson
A type-safe, auto-generated, lazy loading ORM for Node.js. Designed to maximise developer productivity.
https://github.com/mattgson/gybson
graphql mysql nodejs orm postgresql sql typescript
Last synced: about 1 month ago
JSON representation
A type-safe, auto-generated, lazy loading ORM for Node.js. Designed to maximise developer productivity.
- Host: GitHub
- URL: https://github.com/mattgson/gybson
- Owner: MattGson
- License: mit
- Created: 2020-07-11T04:00:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-11T04:07:26.000Z (almost 2 years ago)
- Last Synced: 2024-11-20T20:41:38.976Z (about 2 months ago)
- Topics: graphql, mysql, nodejs, orm, postgresql, sql, typescript
- Language: TypeScript
- Homepage: https://mattgson.github.io/Gybson/
- Size: 3.52 MB
- Stars: 5
- Watchers: 4
- Forks: 3
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/gybson)
[](https://github.com/MattGson/Gybson)
[](https://travis-ci.org/github/MattGson/Gybson)
[![Star on GitHub][github-star-badge]][github-star-link]
[![Github last commit][last-commit]][last-commit-link]
[![Pull Requests Welcome][prs-badge]][prs-link]
[github-star-badge]: https://img.shields.io/github/last-commit/MattGson/Gybson.svg?style=for-the-badge&logo=github&logoColor=ffffff
[github-star-link]: https://github.com/MattGson/Gybson/stargazers
[last-commit]: https://img.shields.io/github/stars/MattGson/Gybson.svg?style=for-the-badge&logo=github&logoColor=ffffff
[last-commit-link]: https://github.com/MattGson/Gybson/commits
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge
[prs-link]: https://github.com/MattGson/Gybson
Gybson is a type-safe, auto-generated Node.js query client (light-weight ORM) for working with SQL databases in Typescript.
Optimized for super fast lazy loading, using batching and caching, it's perfect for GraphQL apps.
Gybson is built on top of trusted open-source projects:
- [Knex](https://github.com/knex/knex)
- [DataLoader](https://github.com/graphql/dataloader)
Gybson works with MySQL and PostgreSQL databases.
## Why Gybson?
Gybson was created to make working with relational databases in Typescript as productive as possible.
Just run `gybson generate` and you have a fully type-safe database client created for your exact schema.
### Knex
Gybson is built on top of the very popular SQL query builder [Knex](https://github.com/knex/knex).
GybsonClient wraps a Knex client instance so it is very easy to integrate into apps already using Knex.
---
## Key features
### IDE Auto-completion
You can maximise developer efficiency with auto-completion in any IDE.
### Type-safe
Gybson comes with automated type safety out of the box so you know exactly what data goes in and out of your database. Clean, usable types are generated directly from your database schema.
### Auto-generated
Unlike most ORMs you don't have to define complex types and relations in code. You can get started using Gybson in 5 minutes and work with plain JavaScript objects.
### GraphQL optimized
Gybson uses [dataloader](https://github.com/graphql/dataloader) under the hood to batch and cache (de-dupe) database requests to minimise round trips.
---
## A simple example
If your schema is defined as
```sql
CREATE TABLE users (
id INT AUTO_INCREMENT;
username: VARCHAR NOT NULL;
password: VARCHAR NOT NULL;
last_logon: Date;
)
```
You can query:
```typescript
const id = await gybson.users.insert({
values: {
username: 'name',
password: 'secret',
last_logon: new Date(),
},
});
const user = await gybson.users.loadOne({
where: {
id,
},
});
console.log(user);
/*
{
user_id: 1;
username: 'name';
password: 'secret';
last_logon: '2020-10-21T09:00:00';
}
*/
```