Class OINODbQueryFilter

Class for recursively parsing of filters and printing them as SQL conditions. Supports three types of statements

comparison: (field)-lt|le|eq|ge|gt|like(value)
negation: -not(filter)
conjunction/disjunction: (filter)-and|or(filter) Supported conditions are comparisons (<, <=, =, >=, >) and substring match (LIKE).

Hierarchy (View Summary)

OINOQueryFilter
- OINODbQueryFilter

Index

Constructors

constructor

new OINODbQueryFilter(
    leftSide: string | OINOQueryFilter,
    operation:
        | OINOQueryBooleanOperation
        | OINOQueryComparison
        | OINOQueryNullCheck,
    rightSide: string | OINOQueryFilter,
): OINODbQueryFilter
Constructor of OINOQueryFilter
Parameters
- leftSide: string | OINOQueryFilter
  left side of the filter, either another filter or a column name
- operation: OINOQueryBooleanOperation | OINOQueryComparison | OINOQueryNullCheck
  operation of the filter, either OINOQueryComparison or OINOQueryBooleanOperation
- rightSide: string | OINOQueryFilter
  right side of the filter, either another filter or a value
Returns OINODbQueryFilter
Inherited from OINOQueryFilter.constructor
- Defined in common/src/OINOQueryParams.ts:62

Properties

`Readonly`leftSide

leftSide: string | OINOQueryFilter

`Readonly`operator

operator: OINOQueryBooleanOperation | OINOQueryComparison | OINOQueryNullCheck

`Readonly`rightSide

rightSide: string | OINOQueryFilter

Methods

isEmpty

isEmpty(): boolean
Does filter contain any valid conditions.

Returns boolean
Inherited from OINOQueryFilter.isEmpty
- Defined in common/src/OINOQueryParams.ts:198

`Static`and

and(leftSide: OINOQueryFilter, rightSide: OINOQueryFilter): OINOQueryFilter
Combine two filters with an AND operation.
Parameters
- leftSide: OINOQueryFilter
  left side filter
- rightSide: OINOQueryFilter
  right side filter
Returns OINOQueryFilter
Inherited from OINOQueryFilter.and
- Defined in common/src/OINOQueryParams.ts:154

`Static`buildSql

buildSql(
    filter: OINOQueryFilter,
    dataModel: OINODbDataModel,
    statement: OINODbSqlStatement,
): string
Build filter as SQL condition based on the datamodel of the API, appending any values to the given statement.

Column names are validated against the datamodel and values are added to statement (bound as parameters, or inlined as escaped literals when the statement is in legacy mode).
Parameters
- filter: OINOQueryFilter
  filter to build
- dataModel: OINODbDataModel
  data model (and database) to use for formatting of values
- statement: OINODbSqlStatement
  statement being assembled (collects bind values / provides placeholders)
Returns string
- Defined in db/src/OINODbQueryParams.ts:53

`Static`combine

combine(
    leftSide: OINOQueryFilter,
    operation: OINOQueryBooleanOperation,
    rightSide: OINOQueryFilter,
): OINOQueryFilter
Construct a new OINOQueryFilter as combination of (boolean and/or) of two filters.
Parameters
- leftSide: OINOQueryFilter
  left side to combine
- operation: OINOQueryBooleanOperation
  boolean operation to use in combination
- rightSide: OINOQueryFilter
  right side to combine
Returns OINOQueryFilter
Inherited from OINOQueryFilter.combine
- Defined in common/src/OINOQueryParams.ts:132

`Static`not

not(leftSide: OINOQueryFilter): OINOQueryFilter
Negate a filter with a NOT operation.
Parameters
- leftSide: OINOQueryFilter
  left side filter
Returns OINOQueryFilter
Inherited from OINOQueryFilter.not
- Defined in common/src/OINOQueryParams.ts:185

`Static`or

or(leftSide: OINOQueryFilter, rightSide: OINOQueryFilter): OINOQueryFilter
Combine two filters with an OR operation.
Parameters
- leftSide: OINOQueryFilter
  left side filter
- rightSide: OINOQueryFilter
  right side filter
Returns OINOQueryFilter
Inherited from OINOQueryFilter.or
- Defined in common/src/OINOQueryParams.ts:170

`Static`parse

parse(filterString: string): OINOQueryFilter
Constructor for OINOQueryFilter as parser of http parameter.

Supports three types of statements:
- comparison: (field)-lt|le|eq|ge|gt|like(value)
- negation: -not(filter)
- conjunction/disjunction: (filter)-and|or(filter)
- null check: -isnull(field) or -isNotNull(field)
Parameters
- filterString: string
  string representation of filter from HTTP-request
Returns OINOQueryFilter
Inherited from OINOQueryFilter.parse
- Defined in common/src/OINOQueryParams.ts:90

`Static`printSql

printSql(filter: OINOQueryFilter, dataModel: OINODbDataModel): string
Print filter as an inline (non-parameterized) SQL condition string.
Parameters
- filter: OINOQueryFilter
  filter to print
- dataModel: OINODbDataModel
  data model (and database) to use for formatting of values
Returns string
Deprecated
Prefer buildSql with a parameterized OINODbSqlStatement.
- Defined in db/src/OINODbQueryParams.ts:97

Class OINODbQueryFilter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OINODbQueryFilter

Properties

ReadonlyleftSide

Readonlyoperator

ReadonlyrightSide

Methods

isEmpty

Returns boolean

Staticand

Parameters

Returns OINOQueryFilter

StaticbuildSql

Parameters

Returns string

Staticcombine

Parameters

Returns OINOQueryFilter

Staticnot

Parameters

Returns OINOQueryFilter

Staticor

Parameters

Returns OINOQueryFilter

Staticparse

Parameters

Returns OINOQueryFilter

StaticprintSql

Parameters

Returns string

Deprecated

Settings

On This Page

`Readonly`leftSide

`Readonly`operator

`Readonly`rightSide

`Static`and

`Static`buildSql

`Static`combine

`Static`not

`Static`or

`Static`parse

`Static`printSql