PG Filters

A simple rust helper to generate postgres sql for pagination, sorting and filtering

Usage

    let filters = PgFilters::new(
        Some(PaginationOptions {
            current_page: 1,
            per_page: 10,
            per_page_limit: 10,
            total_records: 1000,
        }),
        vec![
            SortedColumn::new("age".into(), "desc".into()),
            SortedColumn::new("name".into(), "asc".into()),
        ],
        vec![
            FilteringRule::new("where".into(), "name".into(), "=".into(), "John".into()),
            FilteringRule::new("or".into(), "age".into(), ">".into(), "18".into()),
        ],
    );

    let sql = filters.sql();
    assert_eq!(sql, " WHERE name = 'John' OR age > 18 ORDER BY age DESC, name ASC LIMIT 10 OFFSET 0");

Note

filter rules are applied in the order which they are supplied
sorting is applied after sorting on column name alphabetically (duplicates are removed)
for readability on the first filtering rule you can use where - anything other than AND/OR defaults to AND

Valid Filtering Options

The filtering accepts a filter operator and a conditional operator the valid options are below:

Filtering Operator

can be upper or lower case

"="
"!="
">"
">="
"<"
"<="
"LIKE"
"NOT LIKE"
"IN"
"NOT IN"
"IS NULL"
"IS NOT NULL"

Valid Conditional Filter Values

can be upper or lower case

"AND"
"OR"

Returned Objects

Along with the sql it also returns objects containing the pagination, sorting and filtering that has been applied e.g :

  let pagination_sql = filters.pagination.sql
  let pagination = filters.pagination.pagination

  pub struct Paginate {
      pub pagination: Pagination,
      pub sql: String,
  }

  pub struct Pagination {
        current_page,
        previous_page,
        next_page,
        total_pages,
        per_page,
        total_records,
  }

see the tests for more examples

Changelog

See the Changelog

License

Licensed under either of these:

MIT (https://opensource.org/licenses/MIT)
Apache-2.0 (https://www.apache.org/licenses/LICENSE-2.0)

pg_filters 0.1.3