diesel_dynamic_schema/
lib.rs

Help
1//! # Diesel dynamic schema
2//!
3//! Diesel is an ORM and query builder designed to reduce
4//! the boilerplate for database interactions.
5//!
6//! If this is your first time reading about Diesel, then
7//! we recommend you start with the [getting started guide].
8//! We also have [many other long form guides].
9//!
10//! [getting started guide]: https://diesel.rs/guides/getting-started/
11//! [many other long form guides]: https://diesel.rs/guides
12//!
13//! Diesel is built to provide strong compile time guarantees that your
14//! queries are valid. To do this, it needs to represent your schema
15//! at compile time. However, there are some times where you don't
16//! actually know the schema you're interacting with until runtime.
17//!
18//! This crate provides tools to work with those cases, while still being
19//! able to use Diesel's query builder. Keep in mind that many compile time
20//! guarantees are lost. We cannot verify that the tables/columns you ask
21//! for actually exist, or that the types you state are correct.
22//!
23//! # Getting Started
24//!
25//! The `table` function is used to create a new Diesel table.
26//! Note that you must always provide an explicit select clause
27//! when using this crate.
28//!
29//! ```rust
30//! # mod connection_setup {
31//! #     include!("../tests/connection_setup.rs");
32//! # }
33//! # use connection_setup::establish_connection;
34//! # use diesel::prelude::*;
35//! # use diesel::sql_types::{Integer, Text};
36//! # use diesel_dynamic_schema::table;
37//! # use diesel::dsl::sql_query;
38//! #
39//! #
40//! # fn result_main() -> QueryResult<()> {
41//! #
42//! # let conn = &mut establish_connection();
43//! #
44//! # // Create some example data by using typical SQL statements.
45//! # connection_setup::create_user_table(conn);
46//! # sql_query("INSERT INTO users (name) VALUES ('Sean'), ('Tess')").execute(conn)?;
47//! #
48//! // Use diesel-dynamic-schema to create a table and columns.
49//! let users = table("users");
50//! let id = users.column::<Integer, _>("id");
51//! let name = users.column::<Text, _>("name");
52//!
53//! // Now you can use typical Diesel syntax; see the Diesel docs for more.
54//! let results = users
55//!     .select((id, name))
56//!     .filter(name.eq("Sean"))
57//!     .load::<(i32, String)>(conn)?;
58//!
59//! # assert_eq!(results.len(), 1);
60//! # assert_eq!(results[0].1, "Sean");
61//! #
62//! for (id, name) in results {
63//!     println!("id:{} name:{}", id, name);
64//! }
65//! # Ok(())
66//! # }
67//! # result_main().unwrap()
68//! ```
69//!
70//! See the `/examples` directory for runnable code examples.
71//!
72//! ## Getting help
73//!
74//! If you run into problems, Diesel has a very active discussion forum.
75//! You can come ask for help at
76//! [github.com/diesel-rs/diesel/discussions](https://github.com/diesel-rs/diesel/discussions)
77
78// Built-in Lints
79#![warn(missing_docs)]
80
81mod column;
82mod dummy_expression;
83mod dynamic_select;
84pub mod dynamic_value;
85mod schema;
86mod table;
87
88/// A database table column.
89pub use column::Column;
90
91/// A database schema.
92pub use schema::Schema;
93
94/// A database table.
95pub use table::Table;
96
97#[doc(inline)]
98pub use self::dynamic_select::DynamicSelectClause;
99
100/// Create a new [`Table`] with the given name.
101///
102/// # Example
103///
104/// ```
105/// use diesel_dynamic_schema::table;
106///
107/// let users = table("users");
108/// ```
109pub fn table<T>(name: T) -> Table<T> {
110    Table::new(name)
111}
112
113/// Create a new [`Schema`] with the given name.
114///
115/// # Example
116///
117/// ```
118/// use diesel_dynamic_schema::schema;
119///
120/// let schema = schema("users");
121/// ```
122pub fn schema<T>(name: T) -> Schema<T> {
123    Schema::new(name)
124}
diesel_dynamic_schema/lib.rs

diesel_dynamic_schema/
lib.rs
