Class QueryHints

Hierarchy

QueryHints

Index

Constructors

constructor

Properties

_bgpHints

Methods

Constructors

constructor

new QueryHints(): QueryHints

- Defined in src/engine/context/query-hints.ts:58
Returns QueryHints

Properties

Protected _bgpHints

_bgpHints: Map<QUERY_HINT, boolean>

Methods

add

add(scope: QUERY_HINT_SCOPE, hint: QUERY_HINT): void

- Defined in src/engine/context/query-hints.ts:90
Add a query hint to the set

Parameters
- scope: QUERY_HINT_SCOPE
  
  Scope of the hint (Query, BGP, etc)
- hint: QUERY_HINT
  
  Type of hint
Returns void

clone

clone(): QueryHints

- Defined in src/engine/context/query-hints.ts:68
Clone the set of query hints

Returns QueryHints

The cloned set of query hints

has

has(scope: QUERY_HINT_SCOPE, hint: QUERY_HINT): boolean

- Defined in src/engine/context/query-hints.ts:102
Test if a hint exists

Parameters
- scope: QUERY_HINT_SCOPE
  
  Scope of the hint (Query, BGP, etc)
- hint: QUERY_HINT
  
  Type of hint
Returns boolean

True if the hint exists, False otherwise

merge

merge(other: QueryHints): QueryHints

- Defined in src/engine/context/query-hints.ts:79
Merge the current hints with another set of hints

Parameters
- other: QueryHints
  
  Query hints to merge with
Returns QueryHints

The merged set of query hints

toString

toString(): string

- Defined in src/engine/context/query-hints.ts:113
Serialize the set of query hints into a string

Returns string

A string which represents the set of query hints

Generated using TypeDoc