xLucene Translator: `Query Access Query Access Query Access`
query-access/query-access.QueryAccess
Type parameters
Name | Type |
---|---|
T | extends ts.AnyObject = ts.AnyObject |
Table of contents
Constructors
Properties
- allowEmpty
- allowImplicitQueries
- constraints
- defaultGeoField
- defaultGeoSortOrder
- defaultGeoSortUnit
- excludes
- filterNilVariables
- includes
- parsedTypeConfig
- preventPrefixWildcard
- typeConfig
- variables
Methods
Constructors
constructor
• new QueryAccess<T
>(config?
, options?
): QueryAccess
<T
>
Type parameters
Name | Type |
---|---|
T | extends AnyObject = AnyObject |
Parameters
Name | Type |
---|---|
config | QueryAccessConfig <T > |
options | QueryAccessOptions |
Returns
QueryAccess
<T
>
Defined in
xlucene-translator/src/query-access/query-access.ts:33
Properties
allowEmpty
• Readonly
allowEmpty: boolean
Defined in
xlucene-translator/src/query-access/query-access.ts:24
allowImplicitQueries
• Readonly
allowImplicitQueries: boolean
Defined in
xlucene-translator/src/query-access/query-access.ts:20
constraints
• Optional
Readonly
constraints: string
[]
Defined in
xlucene-translator/src/query-access/query-access.ts:18
defaultGeoField
• Optional
Readonly
defaultGeoField: string
Defined in
xlucene-translator/src/query-access/query-access.ts:21
defaultGeoSortOrder
• Optional
Readonly
defaultGeoSortOrder: SortOrder
Defined in
xlucene-translator/src/query-access/query-access.ts:22
defaultGeoSortUnit
• Optional
Readonly
defaultGeoSortUnit: string
Defined in
xlucene-translator/src/query-access/query-access.ts:23
excludes
• Readonly
excludes: keyof T
[]
Defined in
xlucene-translator/src/query-access/query-access.ts:16
filterNilVariables
• Readonly
filterNilVariables: boolean
Defined in
xlucene-translator/src/query-access/query-access.ts:28
includes
• Readonly
includes: keyof T
[]
Defined in
xlucene-translator/src/query-access/query-access.ts:17
parsedTypeConfig
• Readonly
parsedTypeConfig: xLuceneTypeConfig
Defined in
xlucene-translator/src/query-access/query-access.ts:26
preventPrefixWildcard
• Readonly
preventPrefixWildcard: boolean
Defined in
xlucene-translator/src/query-access/query-access.ts:19
typeConfig
• Readonly
typeConfig: xLuceneTypeConfig
Defined in
xlucene-translator/src/query-access/query-access.ts:25
variables
• Readonly
variables: xLuceneVariables
Defined in
xlucene-translator/src/query-access/query-access.ts:27
Methods
clearCache
▸ clearCache(): void
Returns
void
Defined in
xlucene-translator/src/query-access/query-access.ts:61
restrict
▸ restrict(q
): string
Validate and restrict a xlucene query
Parameters
Name | Type |
---|---|
q | string |
Returns
string
a restricted xlucene query
Defined in
xlucene-translator/src/query-access/query-access.ts:71
restrictSearchQuery
▸ restrictSearchQuery(query
, opts?
, _overrideParsedQuery?
): Promise
<SearchParams
>
Converts a restricted xlucene query to an elasticsearch search query
Parameters
Name | Type |
---|---|
query | string |
opts? | RestrictSearchQueryOptions |
_overrideParsedQuery? | Node |
Returns
Promise
<SearchParams
>
a restricted elasticsearch search query
Defined in
xlucene-translator/src/query-access/query-access.ts:205
restrictSourceFields
▸ restrictSourceFields(includes?
, excludes?
): Object
Restrict requested source to all or subset of the ones available
NOTE: this will remove restricted fields and will not throw
Parameters
Name | Type |
---|---|
includes? | keyof T [] |
excludes? | keyof T [] |
Returns
Object
Name | Type | |
---|---|---|
excludes | undefined \ | keyof T [] |
includes | undefined \ | keyof T [] |