Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/seaql/seaography
🧠GraphQL framework for SeaORM
https://github.com/seaql/seaography
async-graphql database graphql hacktoberfest mariadb mysql postgres rust sql sqlite
Last synced: 4 days ago
JSON representation
🧠GraphQL framework for SeaORM
- Host: GitHub
- URL: https://github.com/seaql/seaography
- Owner: SeaQL
- License: apache-2.0
- Created: 2022-06-12T09:40:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T08:42:54.000Z (13 days ago)
- Last Synced: 2024-12-19T20:03:17.682Z (4 days ago)
- Topics: async-graphql, database, graphql, hacktoberfest, mariadb, mysql, postgres, rust, sql, sqlite
- Language: Rust
- Homepage:
- Size: 4.81 MB
- Stars: 409
- Watchers: 9
- Forks: 36
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
🧠A GraphQL framework and code generator for SeaORM
[](https://crates.io/crates/seaography)
[](https://docs.rs/seaography)
[](https://github.com/SeaQL/seaography/actions/workflows/tests.yaml)
# Seaography
#### Seaography is a GraphQL framework for building GraphQL resolvers using SeaORM entities. It ships with a CLI tool that can generate ready-to-compile Rust GraphQL servers from existing MySQL, Postgres and SQLite databases.
## Benefits
* Quick and easy to get started
* Generates readable code
* Extensible project structure
* Based on popular async libraries: [async-graphql](https://github.com/async-graphql/async-graphql) and [SeaORM](https://github.com/SeaQL/sea-orm)
## Features
* Relational query (1-to-1, 1-to-N)
* Pagination for queries and relations (1-N)
* Filtering with operators (e.g. gt, lt, eq)
* Order by any column
* Guard fields, queries or relations
* Rename fields
* Mutations (create, update, delete)
(Right now there is no mutation, but it's on our plan!)
## SeaORM Version Compatibility
| Seaography | SeaORM |
|----------------------------------------------------------|-------------------------------------------------------|
| [1.1](https://crates.io/crates/seaography/1.1.1) | [1.1](https://crates.io/crates/sea-orm/1.1.2) |
| [1.0](https://crates.io/crates/seaography/1.0.0) | [1.0](https://crates.io/crates/sea-orm/1.0.0) |
| [0.12](https://crates.io/crates/seaography/0.12.0) | [0.12](https://crates.io/crates/sea-orm/0.12.14) |
| [0.3](https://crates.io/crates/seaography/0.3.0) | [0.10](https://crates.io/crates/sea-orm/0.10.7) |
## Quick start - ready to serve in 3 minutes!
### Install
```sh
cargo install sea-orm-cli@^1.0.0 # used to generate entities
cargo install seaography-cli@^1.0.0
```
### MySQL
Setup the [sakila](https://github.com/SeaQL/seaography/blob/main/examples/mysql/sakila-schema.sql) sample database.
```sh
cd examples/mysql
sea-orm-cli generate entity -o src/entities -u mysql://user:[email protected]/sakila --seaography
seaography-cli ./ src/entities mysql://user:[email protected]/sakila seaography-mysql-example
cargo run
```
Go to http://localhost:8000/ and try out the following queries:
#### Fetch films and their actors
```graphql
{
film(pagination: { page: { limit: 10, page: 0 } }, orderBy: { title: ASC }) {
nodes {
title
description
releaseYear
actor {
nodes {
firstName
lastName
}
}
}
}
}
```
#### Fetch store and its employee
```graphql
{
store(filters: { storeId: { eq: 1 } }) {
nodes {
storeId
address {
address
address2
}
staff {
firstName
lastName
}
}
}
}
```
### Fetch inactive customers with pagination
```graphql
{
customer(
filters: { active: { eq: 0 } }
pagination: { page: { page: 2, limit: 3 } }
) {
nodes {
customerId
lastName
email
}
paginationInfo {
pages
current
}
}
}
```
### The query above using cursor pagination
```graphql
{
customer(
filters: { active: { eq: 0 } }
pagination: { cursor: { limit: 3, cursor: "Int[3]:271" } }
) {
nodes {
customerId
lastName
email
}
pageInfo {
hasPreviousPage
hasNextPage
endCursor
}
}
}
```
### Complex query with filters on relations
Find all inactive customers, include their address, and their payments with amount greater than 7 ordered by amount the second result
```graphql
{
customer(
filters: { active: { eq: 0 } }
pagination: { cursor: { limit: 3, cursor: "Int[3]:271" } }
) {
nodes {
customerId
lastName
email
address {
address
}
payment(
filters: { amount: { gt: "7" } }
orderBy: { amount: ASC }
pagination: { page: { limit: 1, page: 1 } }
) {
nodes {
paymentId
amount
}
paginationInfo {
pages
current
}
pageInfo {
hasPreviousPage
hasNextPage
}
}
}
pageInfo {
hasPreviousPage
hasNextPage
endCursor
}
}
}
```
### Filter using enumeration
```graphql
{
film(
filters: { rating: { eq: NC17 } }
pagination: { page: { page: 1, limit: 5 } }
) {
nodes {
filmId
rating
}
}
}
```
### Postgres
Setup the [sakila](https://github.com/SeaQL/seaography/blob/main/examples/postgres/sakila-schema.sql) sample database.
```sh
cd examples/postgres
sea-orm-cli generate entity -o src/entities -u postgres://user:pw@localhost/sakila --seaography
seaography-cli ./ src/entities postgres://user:pw@localhost/sakila seaography-postgres-example
cargo run
```
### SQLite
```sh
cd examples/sqlite
sea-orm-cli generate entity -o src/entities -u sqlite://sakila.db --seaography
seaography-cli ./ src/entities sqlite://sakila.db seaography-sqlite-example
cargo run
```
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Seaography is a community driven project. We welcome you to participate, contribute and together build for Rust's future.