Class: ResourceReferenceQueryBuilder
@flyze/lib-data-store 3.0.0-alpha.55· latestDefined in: projects/lib-data-store/src/lib/flyze-api/gridify-filter/resource-reference.filter.ts:20
Extends
Section titled “Extends”ExecutableQueryBuilder<ResourceReferenceQueryFilterKeys,ResourceReferenceQuery>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ResourceReferenceQueryBuilder(
options?):ResourceReferenceQueryBuilder
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:100
Parameters
Section titled “Parameters”options?
Section titled “options?”AbstractQueryBuilderOptions<ResourceReferenceQueryFilterKeys, ResourceReferenceQuery>
Returns
Section titled “Returns”ResourceReferenceQueryBuilder
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder< ResourceReferenceQueryFilterKeys, ResourceReferenceQuery >.constructor
Properties
Section titled “Properties”_CurrentGroup
Section titled “_CurrentGroup”
protectedreadonly_CurrentGroup:FilterCollection<ResourceReferenceQueryFilterKeys>[]
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:59
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder._CurrentGroup
_paginationOptIn
Section titled “_paginationOptIn”
protected_paginationOptIn:boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:66
Tracks whether the caller explicitly invoked setPage / setPageSize
(or constructed the builder from a query/builder that had explicit
pagination). When false, the executor treats the query as “no
pagination” so callers can still select all rows.
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder._paginationOptIn
Accessors
Section titled “Accessors”dialect
Section titled “dialect”Get Signature
Section titled “Get Signature”get dialect():
QueryDialect
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:92
Wire-format dialect in use. Exposed (read-only) so cross-dialect
merge / copy-from guards can compare ids.
Returns
Section titled “Returns”QueryDialect
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.dialect
logicalOperator
Section titled “logicalOperator”Get Signature
Section titled “Get Signature”get logicalOperator():
object
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:84
Returns
Section titled “Returns”object
readonlyAnd:","
readonlyOr: ”|”
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.logicalOperator
operator
Section titled “operator”Get Signature
Section titled “Get Signature”get operator():
object
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:67
Returns
Section titled “Returns”object
Contains
Section titled “Contains”
readonlyContains:"=*"
EndsWith
Section titled “EndsWith”
readonlyEndsWith:"$"
readonlyEqual:"="
fyzGlob
Section titled “fyzGlob”
readonlyfyzGlob:"#Glob"
fyzRegex
Section titled “fyzRegex”
readonlyfyzRegex:"#Reg"
fyzRegex64
Section titled “fyzRegex64”
readonlyfyzRegex64:"#Reg64"
GreaterThan
Section titled “GreaterThan”
readonlyGreaterThan:">"
GreaterThanOrEqual
Section titled “GreaterThanOrEqual”
readonlyGreaterThanOrEqual:">="
LessThan
Section titled “LessThan”
readonlyLessThan:"<"
LessThanOrEqual
Section titled “LessThanOrEqual”
readonlyLessThanOrEqual:"<="
NotContains
Section titled “NotContains”
readonlyNotContains:"!*"
NotEndsWith
Section titled “NotEndsWith”
readonlyNotEndsWith:"!$"
NotEqual
Section titled “NotEqual”
readonlyNotEqual:"!="
NotStartsWith
Section titled “NotStartsWith”
readonlyNotStartsWith:"!^"
StartsWith
Section titled “StartsWith”
readonlyStartsWith:"^"
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.operator
Get Signature
Section titled “Get Signature”get query():
QUERY
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:99
Read-only access to the most recent build result. Lazily computes
(and caches) when called on a dirty builder. Mirrors the
gridify-compatible query field so existing call sites
(e.g. base.query.filter) continue to compile.
Returns
Section titled “Returns”QUERY
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.query
Methods
Section titled “Methods”addCondition()
Section titled “addCondition()”Call Signature
Section titled “Call Signature”addCondition(
field,operator,value,caseSensitive?,escapeValue?):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:118
Add a condition to the filter - default behavior
Parameters
Section titled “Parameters”ResourceReferenceQueryFilterKeys
the field to filter on
operator
Section titled “operator”ConditionalOperator
the operator to use
the value to compare against
string | number | boolean
caseSensitive?
Section titled “caseSensitive?”boolean
whether the comparison is case sensitive defaults to true
escapeValue?
Section titled “escapeValue?”boolean
whether to escape the value defaults to true
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.addCondition
Call Signature
Section titled “Call Signature”addCondition(
field,operator,value,caseSensitive?,escapeValue?):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:128
Experimental
Extended addCondition to support multiple values as OR grouped conditions
Parameters
Section titled “Parameters”ResourceReferenceQueryFilterKeys
the field to filter on
operator
Section titled “operator”ConditionalOperator
the operator to use
the value to compare against
string[] | number[] | boolean[]
caseSensitive?
Section titled “caseSensitive?”boolean
whether the comparison is case sensitive defaults to true
escapeValue?
Section titled “escapeValue?”boolean
whether to escape the value defaults to true
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.addCondition
addOrderBy()
Section titled “addOrderBy()”addOrderBy(
field,descending?):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:109
Parameters
Section titled “Parameters”ResourceReferenceQueryFilterKeys
descending?
Section titled “descending?”boolean
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.addOrderBy
and(
_optional?):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:138
Adds an AND logical operator.
Parameters
Section titled “Parameters”_optional?
Section titled “_optional?”boolean
Kept for signature compatibility with the previous
gridify-backed implementation. The standalone builder does not
validate operator placement; the dialect’s postProcessFilter
hook handles trailing-operator artefacts.
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.and
build()
Section titled “build()”build():
ResourceReferenceQuery
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:148
Serialise the current state via the configured dialect. Result is cached until the next mutation; repeated calls return structurally cloned copies so callers can safely mutate the returned object.
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.build
buildExecutableExpression()
Section titled “buildExecutableExpression()”buildExecutableExpression():
ExecutableQuery<ResourceReferenceQueryFilterKeys,ResourceReferenceQuery>
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/executable.filter.d.ts:8
Based on the current FilterCollection, builds an ExecutableQuery. A executable query is ‘abstract syntax tree’ representation of the query that can be executed against data.
Returns
Section titled “Returns”ExecutableQuery<ResourceReferenceQueryFilterKeys, ResourceReferenceQuery>
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.buildExecutableExpression
endGroup()
Section titled “endGroup()”endGroup():
this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:130
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.endGroup
hasExplicitPagination()
Section titled “hasExplicitPagination()”hasExplicitPagination():
boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:108
Whether setPage / setPageSize was ever called on this builder (or
inherited via copy-from / non-default values on a source query). When
false, in-memory executors should skip pagination entirely.
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.hasExplicitPagination
hasFilter()
Section titled “hasFilter()”hasFilter():
boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:150
Checks if any filter exists in the current query
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.hasFilter
hasFilterOnKey()
Section titled “hasFilterOnKey()”hasFilterOnKey(
key):boolean
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:152
Checks if a filter on the given key exists in the current query
Parameters
Section titled “Parameters”ResourceReferenceQueryFilterKeys
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.hasFilterOnKey
merge()
Section titled “merge()”merge(
base):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:157
Consumes another query builder, query object or filter string and merges its filters into the current builder.
Parameters
Section titled “Parameters”string | ResourceReferenceQuery | AbstractQueryBuilder<ResourceReferenceQueryFilterKeys, ResourceReferenceQuery>
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.merge
or(
_optional?):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:142
Adds an OR logical operator. See and() for the _optional note.
Parameters
Section titled “Parameters”_optional?
Section titled “_optional?”boolean
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.or
setPage()
Section titled “setPage()”setPage(
page):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:101
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.setPage
setPageSize()
Section titled “setPageSize()”setPageSize(
size):this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:102
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.setPageSize
startGroup()
Section titled “startGroup()”startGroup():
this
Defined in: node_modules/@flyze/lib-db-models/gridify-filter/abstract.filter.d.ts:129
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”ExecutableQueryBuilder.startGroup