gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

ResourceSearchBuilder

Search build for the resource model

:param SearchBuilder: [description] :type SearchBuilder: [type]

Attributes
entity_type: EntityType
Functions
__init__

Create a search build to make dynamic search

add_expression
expression : Expression
Return type : SearchBuilderType
add_flagged_filter

Filter the search query by a specific flag

flagged : bool
Return type : ResourceSearchBuilder
add_folder_filter

Filter the search query by a specific folder

folder_id : str
Return type : ResourceSearchBuilder
add_fs_node_extension_filter

Filter the search query by a specific extension, it will only resturn FsNode resources

extension : str
Return type : ResourceSearchBuilder
add_is_archived_filter

Filter the search query by a specific archived status

is_archived : bool
Return type : ResourceSearchBuilder
add_join
table : Type
on : Expression
Return type : SearchBuilderType
add_name_filter

Filter the search query by a specific name

name : str
Return type : ResourceSearchBuilder
add_ordering
order : Ordering
Return type : SearchBuilderType
add_origin_filter

Filter the search query by a specific origin

origin : ResourceOrigin
Return type : ResourceSearchBuilder
add_parent_filter

Filter the search query by a specific parent

parent_id : str
Return type : ResourceSearchBuilder
add_resource_type_and_sub_types_filter

Filter the search query by a specific resource type and its subtypes

resource_type : Type
Return type : ResourceSearchBuilder
add_resource_type_filter

Filter the search query by a specific resource type

resource_type : Type
Return type : ResourceSearchBuilder
add_resource_types_and_sub_types_filter

Filter the search query by resource types and its subtypes

resource_types : List
Return type : ResourceSearchBuilder
add_resource_types_filter

Filter the search query by a specific resource type

resource_types : List
Return type : ResourceSearchBuilder
add_resource_typing_name_filter

Filter the search query by a specific resource typing name

resource_typing_name : str
Return type : ResourceSearchBuilder
add_resource_typing_names_and_sub_types_filter

Filter the search query by resource types and its subtypes

resource_typing_names : List
Return type : ResourceSearchBuilder
add_search_params
search : SearchParams
Return type : SearchBuilderType
add_tag_filter
tag : Tag
value_operator : SearchOperator - SearchOperator.EQ
error_if_key_not_exists : bool - False
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