@terascope/types / data-types / DataTypeFieldConfig

Interface: DataTypeFieldConfig

The configuration for an individual field

Indexable

[extra: string]: unknown

Properties

array?

optional array: boolean

Indicates whether the field is an array

Source

data-types.ts:121

---

description?

optional description: string

A description for the fields

Source

data-types.ts:126

---

format?

optional format: string

Specify the format for a specific fields. Currently this is only support with FieldType.Date

Source

data-types.ts:147

---

indexed?

optional 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

Source

data-types.ts:135

---

is_primary_date?

optional is_primary_date: boolean

The default date field used primarily for naming timeseries indices

Source

data-types.ts:159

---

locale?

optional locale: string

Specify the locale for the field (not compatible with all fields) Must be represented in a Language Tags (BCP 47)

Source

data-types.ts:141

---

time_resolution?

optional time_resolution: TimeResolution

Indicates whether the data has second or millisecond resolutions used with the is_primary_date

Source

data-types.ts:165

---

type

type: DeprecatedFieldType | FieldType

The type of field

Source

data-types.ts:116

---

use_fields_hack?

optional use_fields_hack: boolean

A temporary flag to fix KeywordCaseInsensitive to be a type keyword with case insensitive .text fields

Source

data-types.ts:153