Filters

Filters are used for reading.

FilterInstance

pydantic model crudcreator.Filter.FilterInstance

Represents a filter instance on a field.

field field_name: str [Required]

The name of the field to filter on.

field filter_value: Any [Required]

The value to filter with.

field filtration_type: FilterationEnum [Required]

How to filter the field?

FilterType

pydantic model crudcreator.Filter.FilterType

An instance of this class represents a filter scheme on a field.

field default: Any = None

What value should be given to the filter if it is not filled in?

field filtration_type: FilterationEnum [Required]

How to filter the field?

field force_long_name: bool = False

field is_mandatory: bool [Required]

Is the filter mandatory?

FilterationEnum

class crudcreator.Filter.FilterationEnum

Different ways of filtering on a field.

contain: str = 'contain'

Field value must contain filter value.

different_of: str = 'different_of'

Field value must be different from filter value.

equal: str = 'equal'

Field value must match filter value exactly.

max: str = 'max'

The field value must not exceed the filter value.

min: str = 'min'

The value of the field must be at least that of the filter.

pattern: str = 'pattern'

The field value must match the pattern.

% : zero, one or more characters.

_ : one character.