Back to bricks list
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