Struct toql_core::table_mapper::TableMapper

pub struct TableMapper {
    pub table_name: String,
    pub canonical_table_alias: String,
    /* private fields */
}

Translates Toql fields into columns or SQL expressions.

It’s needed by the SQL Builder to turn a Query into a SQL Builder Result.

The Toql derive generates the TabeMapper instructions and puts them into the Mapped trait. Every ToqlApi function quickly checks, if TableMapperRegistry contains the TableMapper. If the mapper is missing it will call TreeMap to map an entity and all its dependencies. TreeMap itself uses from_mapped to map an entity.

Fields

table_name: String

Database table name

canonical_table_alias: String

Calculated alias from table_name

Implementations

impl TableMapper

pub fn new<T>(sql_table_name: &str) -> Self

Create new mapper for table or table alias. Example: ::new("Book") or new("Book b"). If you use an alias you must map all SQL columns with the alias too.

pub fn new_with_handler<H>(sql_table_name: &str, handler: H) -> Self where
    H: 'static + FieldHandler + Send + Sync, 

Create a new mapper with a custom handler. Use this to provide custom filter functions for all fields.

pub fn from_mapped<M: Mapped>() -> Result<TableMapper>

Create a new mapper from a struct that implements the Mapped trait.

pub fn from_mapped_with_handler<M: Mapped, H>(handler: H) -> Result<TableMapper> where
    H: 'static + FieldHandler + Send + Sync, 

Create a new mapper from a struct that implements the Mapped trait with a custom FieldHandler.

pub fn joined_mapper(&self, path_name: &str) -> Option<String>

Returns joined mapper for a path name, if any.

pub fn is_partial_join(&self, path_name: &str) -> bool

Returns true, if path name refers to a partial join table.

pub fn merged_mapper(&self, path_name: &str) -> Option<String>

Returns joined mapper for a path name, if any.

pub fn map_column<'a, T>(
    &'a mut self,
    toql_field: &str,
    column_name: T
) -> &'a mut Self where
    T: Into<String>, 

Map a column with default FieldOptions

pub fn map_column_with_options<T>(
    &mut self,
    toql_field: &str,
    column_name: T,
    options: FieldOptions
) -> &mut Self where
    T: Into<String>, 

Convenience function for generic TableMapper::map_expr_with_options.

pub fn map_expr_with_options(
    &mut self,
    toql_field: &str,
    expression: SqlExpr,
    options: FieldOptions
) -> &mut Self

pub fn map_join(
    &mut self,
    toql_path: &str,
    joined_mapper: &str,
    join_type: JoinType,
    table_expression: SqlExpr,
    on_expression: SqlExpr
) -> &mut Self

Map a join with default JoinOptions

pub fn map_join_with_options(
    &mut self,
    toql_path: &str,
    joined_mapper: &str,
    join_type: JoinType,
    table_expression: SqlExpr,
    on_expression: SqlExpr,
    options: JoinOptions
) -> &mut Self

Map a join with options.

pub fn map_merge(
    &mut self,
    toql_path: &str,
    merged_mapper: &str,
    merge_join: SqlExpr,
    merge_predicate: SqlExpr
) -> &mut Self

Map a merge with default MergeOptions.

pub fn map_merge_with_options(
    &mut self,
    toql_path: &str,
    merged_mapper: &str,
    merge_join: SqlExpr,
    merge_predicate: SqlExpr,
    options: MergeOptions
) -> &mut Self

Map a merge with default MergeOptions.

pub fn map_predicate(&mut self, name: &str, sql_expression: SqlExpr)

Map a predicate expression with default PredicateOptions.

pub fn map_predicate_with_options(
    &mut self,
    name: &str,
    sql_expression: SqlExpr,
    options: PredicateOptions
)

Map a predicate expression.

pub fn map_selection(&mut self, name: &str, fields_or_paths: Vec<String>)

Map a selection.

pub fn restrict_delete(&mut self, role_expr: RoleExpr)

Restrict deleted this struct with a role expression.

pub fn restrict_load(&mut self, role_expr: RoleExpr)

Restrict loading this struct with a role expression.

Trait Implementations

impl Debug for TableMapper

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.