Getting started
Installing SeaORM and Seaography CLI
cargo install sea-orm-cli@^0.12
cargo install seaography-cli@1
CLI parameters
🧭 A GraphQL framework and code generator for SeaORM
Usage: seaography-cli [OPTIONS] <DESTINATION> <ENTITIES> <DATABASE_URL> <CRATE_NAME>
Arguments:
<DESTINATION> Project destination folder
<ENTITIES> SeaORM entities folder
<DATABASE_URL> Database URL to write in .env
<CRATE_NAME> Crate name for generated project
Options:
-f, --framework <FRAMEWORK>
Which web framework to use [default: poem] [possible values: actix, poem]
--depth-limit <DEPTH_LIMIT>
GraphQL depth limit
--complexity-limit <COMPLEXITY_LIMIT>
GraphQL complexity limit
-h, --help
Print help
-V, --version
Print version
DATABASE_URL
examples:mysql://user:pass@127.0.0.1:1235/database_name
,postgres://user:pass@127.0.0.1/base_name
,sqlite://my_db.db
Prerequisites
In order to understand how the generated code works its recommended to study the following resources:
Is a server side GraphQL library for Rust.
SeaORM is a relational ORM to help you build web services in Rust.
The web API of the generated project
A runtime for writing reliable, asynchronous, and slim applications with the Rust programming language.