Skip to main content

@terascope/types / data-types / DataTypeFieldConfig

Interface: DataTypeFieldConfig

Defined in: packages/types/src/data-types.ts:112

The configuration for an individual field

Indexable

[extra: string]: unknown

Properties

PropertyTypeDescriptionDefined in
array?booleanIndicates whether the field is an arraypackages/types/src/data-types.ts:121
description?stringA description for the fieldspackages/types/src/data-types.ts:126
format?stringSpecify the format for a specific fields. Currently this is only support with FieldType.Datepackages/types/src/data-types.ts:147
indexed?booleanSpecifies whether the field is index in elasticsearch (Not supported by some field types... see indexedRequiredFieldTypes for types that cannot be false) Default truepackages/types/src/data-types.ts:135
is_primary_date?booleanThe default date field used primarily for naming timeseries indicespackages/types/src/data-types.ts:159
locale?stringSpecify 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:141
time_resolution?TimeResolutionIndicates whether the data has second or millisecond resolutions used with the is_primary_datepackages/types/src/data-types.ts:165
typeDeprecatedFieldType | FieldTypeThe type of fieldpackages/types/src/data-types.ts:116
use_fields_hack?booleanA temporary flag to fix KeywordCaseInsensitive to be a type keyword with case insensitive .text fieldspackages/types/src/data-types.ts:153