Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Field

import type { Field } from "https://googleapis.deno.dev/v1/connectors:v2.ts";

Message contains EntityType's Field metadata.

interface Field {
additionalDetails?: {
[key: string]: any;
}
;
dataType?:
| "DATA_TYPE_UNSPECIFIED"
| "INT"
| "SMALLINT"
| "DOUBLE"
| "DATE"
| "DATETIME"
| "TIME"
| "STRING"
| "LONG"
| "BOOLEAN"
| "DECIMAL"
| "UUID"
| "BLOB"
| "BIT"
| "TINYINT"
| "INTEGER"
| "BIGINT"
| "FLOAT"
| "REAL"
| "NUMERIC"
| "CHAR"
| "VARCHAR"
| "LONGVARCHAR"
| "TIMESTAMP"
| "NCHAR"
| "NVARCHAR"
| "LONGNVARCHAR"
| "NULL"
| "OTHER"
| "JAVA_OBJECT"
| "DISTINCT"
| "STRUCT"
| "ARRAY"
| "CLOB"
| "REF"
| "DATALINK"
| "ROWID"
| "BINARY"
| "VARBINARY"
| "LONGVARBINARY"
| "NCLOB"
| "SQLXML"
| "REF_CURSOR"
| "TIME_WITH_TIMEZONE"
| "TIMESTAMP_WITH_TIMEZONE";
defaultValue?: any;
description?: string;
jsonSchema?: JsonSchema;
key?: boolean;
name?: string;
nullable?: boolean;
reference?: Reference;
}

§Properties

§
additionalDetails?: {
[key: string]: any;
}
[src]

The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields.

§
dataType?: "DATA_TYPE_UNSPECIFIED" | "INT" | "SMALLINT" | "DOUBLE" | "DATE" | "DATETIME" | "TIME" | "STRING" | "LONG" | "BOOLEAN" | "DECIMAL" | "UUID" | "BLOB" | "BIT" | "TINYINT" | "INTEGER" | "BIGINT" | "FLOAT" | "REAL" | "NUMERIC" | "CHAR" | "VARCHAR" | "LONGVARCHAR" | "TIMESTAMP" | "NCHAR" | "NVARCHAR" | "LONGNVARCHAR" | "NULL" | "OTHER" | "JAVA_OBJECT" | "DISTINCT" | "STRUCT" | "ARRAY" | "CLOB" | "REF" | "DATALINK" | "ROWID" | "BINARY" | "VARBINARY" | "LONGVARBINARY" | "NCLOB" | "SQLXML" | "REF_CURSOR" | "TIME_WITH_TIMEZONE" | "TIMESTAMP_WITH_TIMEZONE"
[src]

The data type of the Field.

§
defaultValue?: any
[src]

The following field specifies the default value of the Field provided by the external system if a value is not provided.

§
description?: string
[src]

A brief description of the Field.

§
jsonSchema?: JsonSchema
[src]

JsonSchema of the field, applicable only if field is of type STRUCT

§
key?: boolean
[src]

The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity.

§
name?: string
[src]

Name of the Field.

§
nullable?: boolean
[src]

Specifies whether a null value is allowed.

§
reference?: Reference
[src]

Reference captures the association between two different entity types. Value links to the reference of another entity type.