gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

SearchBuilder

Builder to make dynamic search query with And operator

:raises BadRequestException: [description] :raises BadRequestException: [description] :return: [description] :rtype: [type]

Functions
__init__

Create a search build to make dynamic search

model_type : Type
peewee type of the model to search
default_orders : List
define a default sort for the request
add_expression
expression : Expression
Return type : SearchBuilderType
add_join
table : Type
on : Expression
Return type : SearchBuilderType
add_ordering
order : Ordering
Return type : SearchBuilderType
add_search_params
search : SearchParams
Return type : SearchBuilderType
convert_filter_to_expression
filter_ : SearchFilterCriteria
Return type : Expression
convert_order_to_peewee_ordering

Convert a search order criteria to a peewee ordering

order : SearchSortCriteria
Return type : Ordering
convert_value

Method to convert the search value (or values) to type of field

field : Field
value : Any
Return type : Any
search_all
Return type : List
search_page
page : int - 0
number_of_items_per_page : int - 20
Return type : Paginator
set_ordering
orders : List
Return type : SearchBuilderType