Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace BucketCommandDescriptor

Command descriptor for querylanguage BUCKET command.

Properties

Methods

Properties

Optional category

category: undefined | string

querylanguage command designation for example; reporting vs filtering

Optional declaredFields

declaredFields: Array<AbstractField>

Fields declared in command fragment from user specified query string.

Optional defaultValue

defaultValue: undefined | string

Default value to use in place of null if a result does not fit into any of the specified / calculated ranges.

displayQueryString

displayQueryString: string

Command fragment display string from user specified query string formatted by query builder.

internalQueryString

internalQueryString: string

Command fragment internal string from user specified query string formatted by query builder.

Optional isHidden

isHidden: undefined | false | true

Field denoting if this is a hidden command that is not shown in the query string.

Optional maxBuckets

maxBuckets: undefined | number

number of auto calculated ranges to compute if specified. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Const name

name: string = "BUCKET"

Optional ranges

ranges: Array<BucketRange>

List of the specified numeric ranges.

Optional referencedFields

referencedFields: Array<AbstractField>

Fields referenced in command fragment from user specified query string.

Optional span

span: undefined | number

Size of each numeric range if specified. Data type should match numeric field data type specified in the query string. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Methods

getDeserializedJsonObj

getJsonObj