Skip to content

docs: add database backend and runtime feature flags to crate docs #2978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mansiverma897993 wants to merge 1 commit into
base: master
Choose a base branch
from
+36 −0
Open

docs: add database backend and runtime feature flags to crate docs #2978

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,42 @@
//!
//! + [Documentation](https://www.sea-ql.org/SeaORM)
//!
//! ## Database Backends & Feature Flags
//!
//! SeaORM supports multiple SQL databases via Cargo feature flags.
//! You must enable at least one database backend when adding SeaORM to your project.
//!
//! ### Supported Databases
//!
//! | Database | Feature Flag |
//! |-------------|-------------------|
//! | PostgreSQL | `sqlx-postgres` |
//! | MySQL | `sqlx-mysql` |
//! | SQLite | `sqlx-sqlite` |
//!
//! ### Runtime Support
//!
//! SeaORM requires an async runtime.
//! Common runtime features:
//!
//! | Runtime | Feature Flag |
//! |----------------------|--------------|
//! | Tokio (Rustls TLS) | `runtime-tokio-rustls` |
//! | Tokio (Native TLS) | `runtime-tokio-native-tls` |
//!
//! ### Example
//!
//! ```toml
//! sea-orm = { version = "2", features = [
//! "sqlx-postgres",
//! "runtime-tokio-rustls"
//! ] }
//! ```
//!
//! For Microsoft SQL Server support, see:
//! https://www.sea-ql.org/SeaORM-X/
//!
//!
//! Integration examples:
//!
//! + [Actix Example](https://github.com/SeaQL/sea-orm/tree/master/examples/actix_example)
Expand Down