rdb_pagination/
lib.rs

1/*!
2# RDB Pagination
3
4SQL query extension library for handling pagination and sorting in relational databases.
5
6## Usage
7
8Use `#[derive(OrderByOptions)]` to have a struct implement the `OrderByOptions` trait.
9
10```rust
11use educe::Educe;
12use rdb_pagination::{prelude::*, PaginationOptions, SqlJoin, SqlOrderByComponent};
13
14# #[cfg(feature = "derive")]
15# {
16#[derive(Debug, Clone, Educe, OrderByOptions)]
17#[educe(Default)]
18#[orderByOptions(name = component)]
19#[orderByOptions(
20    join((component, component_type_id), (component_type, id)),
21    join((component_type, component_general_type_id), (component_general_type, id)),
22    join((component_type, component_vendor_id), (component_vendor, id)),
23)]
24pub struct ComponentOrderBy {
25    #[educe(Default = 103)]
26    #[orderByOptions(("component_general_type", "id"), unique)]
27    pub component_general_type_id:    OrderMethod,
28    #[orderByOptions(("component_general_type", "name"), unique)]
29    pub component_general_type_name:  OrderMethod,
30    #[educe(Default = 102)]
31    #[orderByOptions(("component_general_type", "order"))]
32    pub component_general_type_order: OrderMethod,
33    #[educe(Default = 105)]
34    #[orderByOptions(("component_vendor", "id"), unique, nulls_first)]
35    pub vendor_id:                    OrderMethod,
36    #[orderByOptions(("component_vendor", "name"), unique)]
37    pub vendor_name:                  OrderMethod,
38    #[educe(Default = 104)]
39    #[orderByOptions(("component_vendor", "order"))]
40    pub vendor_order:                 OrderMethod,
41    #[educe(Default = 106)]
42    #[orderByOptions(("component_type", "id"), unique)]
43    pub component_type_id:            OrderMethod,
44    #[educe(Default = 101)]
45    #[orderByOptions(("component_type", "order"))]
46    pub component_type_order:         OrderMethod,
47    #[educe(Default = 107)]
48    #[orderByOptions(("component", "id"), unique)]
49    pub id:                           OrderMethod,
50}
51
52let order_by = ComponentOrderBy {
53    component_general_type_id: OrderMethod::from(-1i8),
54    ..ComponentOrderBy::default()
55};
56
57let pagination_options = PaginationOptions::default().page(3).items_per_page(20).order_by(order_by);
58
59let mut buffer = String::new();
60
61# #[cfg(feature = "mysql")]
62assert_eq!("LIMIT 20 OFFSET 40", pagination_options.to_mysql_limit_offset(&mut buffer));
63
64buffer.clear();
65
66let (joins, order_by_components) = pagination_options.order_by.to_sql();
67
68# #[cfg(feature = "mysql")]
69assert_eq!(
70    "LEFT JOIN `component_type` ON `component_type`.`id` = `component`.`component_type_id`\nLEFT JOIN `component_vendor` ON `component_vendor`.`id` = `component_type`.`component_vendor_id`",
71    SqlJoin::format_mysql_join_clauses(&joins, &mut buffer)
72);
73
74buffer.clear();
75
76# #[cfg(feature = "mysql")]
77assert_eq!(
78    "ORDER BY `component_type`.`component_general_type_id` DESC, `component_type`.`order` ASC, `component_vendor`.`order` ASC, `component_type`.`component_vendor_id` IS NOT NULL, `component_type`.`component_vendor_id` ASC, `component`.`component_type_id` ASC, `component`.`id` ASC",
79    SqlOrderByComponent::format_mysql_order_by_components(&order_by_components, &mut buffer)
80);
81# }
82```
83*/
84
85#![cfg_attr(docsrs, feature(doc_auto_cfg))]
86
87pub use rdb_pagination_core::*;
88#[cfg(feature = "derive")]
89pub use rdb_pagination_derive::*;
90
91/// A convenience module appropriate for glob imports.
92///
93/// ```rust
94/// use rdb_pagination::prelude::*;
95/// ```
96pub mod prelude {
97    pub use rdb_pagination_core::{OrderByOptions, OrderMethod, OrderMethodValue};
98    #[cfg(feature = "derive")]
99    pub use rdb_pagination_derive::OrderByOptions;
100
101    #[doc(hidden)]
102    pub mod rdb_pagination_prelude {
103        pub use rdb_pagination_core::{
104            Name, NullStrategy, OrderBuilder, Relationship, SqlJoin, SqlOrderByComponent,
105        };
106    }
107}
rdb_pagination/lib.rs

rdb_pagination/
lib.rs
