@terascope/types / data-types / DataTypeFieldConfig
Interface: DataTypeFieldConfig
Defined in: packages/types/src/data-types.ts:117
The configuration for an individual field
Indexable
[
extra:string]:unknown
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
array? | boolean | Indicates whether the field is an array | packages/types/src/data-types.ts:126 |
description? | string | A description for the fields | packages/types/src/data-types.ts:131 |
doc_values? | boolean | Doc values are enabled by default on nearly all field types, except for text fields. If you know that a field won’t be used for sorting, aggregations, or scripting, you can disable doc values in order to reduce disk usage. Default true | packages/types/src/data-types.ts:148 |
format? | string | Specify the format for a specific fields. Currently this is only support with FieldType.Date | packages/types/src/data-types.ts:160 |
indexed? | boolean | Specifies whether the field is index in elasticsearch (Not supported by some field types... see indexedRequiredFieldTypes for types that cannot be false) Default true | packages/types/src/data-types.ts:140 |
is_primary_date? | boolean | The default date field used primarily for naming timeseries indices | packages/types/src/data-types.ts:172 |
locale? | string | Specify the locale for the field (not compatible with all fields) Must be represented in a Language Tags (BCP 47) | packages/types/src/data-types.ts:154 |
time_resolution? | TimeResolution | Indicates whether the data has second or millisecond resolutions used with the is_primary_date | packages/types/src/data-types.ts:178 |
type | DeprecatedFieldType | FieldType | The type of field | packages/types/src/data-types.ts:121 |
use_fields_hack? | boolean | A temporary flag to fix KeywordCaseInsensitive to be a type keyword with case insensitive .text fields | packages/types/src/data-types.ts:166 |