FieldDefinition

9 min

ODP Node SDK

ODP Node SDK / ODP / FieldDefinition

Interface: FieldDefinition

Defined in: src/Api/Types/Schema.ts:6

The ODP Field definition payload for schema APIs. See V3 Schema API for details.

Properties

description?

optional description: string

Defined in: src/Api/Types/Schema.ts:24

Description of the field and how it will be referenced in the ODP UI. While optional, it's use is strongly encouraged.

display_name

display_name: string

Defined in: src/Api/Types/Schema.ts:19

The user-friendly name used within ODP. Must be unique across all display names within the object.

name

name: string

Defined in: src/Api/Types/Schema.ts:11

The name of the field. Lower snake case, alphanumeric, must start with an alpha character. Must be unique across all field names within the object.

primary?

optional primary: boolean

Defined in: src/Api/Types/Schema.ts:29

Used when creating new objects to denote this field should be used as the primary key for the object. Should be undefined or false for all other fields.

type

type: "string" | "number" | "boolean" | "timestamp" | "vector"

Defined in: src/Api/Types/Schema.ts:15

The type of the field: string, number, timestamp, boolean or vector.