Type - Kinetica Docs

Metadata about a GPUdb type.

Defined in src/utils.ts:163
Defined in src/utils.ts:293

Constructors

Properties

Methods

create generateSchema fromTable fromType fromTypeInfo

Constructors

constructor

new Type(label: string, …columns: Column[]): Type
Creates a Type object.
Parameters
- label: string
  A user-defined description string
- …columns: Column[]
  The columns that make up the type
Returns Type
- Defined in src/utils.ts:175

Properties

`Readonly`columns

columns: Column[]

The list of columns that the type comprises

Defined in src/utils.ts:167

`Readonly`label

label: string

A user-defined description string

Defined in src/utils.ts:165

Methods

create

create(gpudb: GPUdb): Promise<string>
Creates a new type in GPUdb based on the metadata in the Type object.
Parameters
- gpudb: GPUdb
  GPUdb client instance
Returns Promise<string>
Promise resolving to the type ID
- Defined in src/utils.ts:223

generateSchema

generateSchema():
fields: name: string; type: string
| string[] [];
name: string;
type: string;
Generates an Avro record schema based on the metadata in the Type object.

Returns
fields: name: string; type: string | string[] [];
name: string;
type: string;
- Defined in src/utils.ts:206

`Static`fromTable

fromTable(gpudb: GPUdb, tableName: string): Promise<Type>
Creates a Type object containing metadata about the type stored in the specified table.
Parameters
- gpudb: GPUdb
  GPUdb client instance
- tableName: string
  The table from which to obtain type metadata
Returns Promise<Type>
Promise resolving to the Type object
- Defined in src/utils.ts:247

`Static`fromType

fromType(gpudb: GPUdb, typeId: string): Promise<Type>
Creates a Type object containing metadata about the specified type in GPUdb.
Parameters
- gpudb: GPUdb
  GPUdb client instance
- typeId: string
  The type for which to obtain metadata
Returns Promise<Type>
Promise resolving to the Type object
- Defined in src/utils.ts:277

`Static`fromTypeInfo

fromTypeInfo(
label: string,
typeSchema:
| string
| fields: name: string; type: string
| string[] [] ,
properties: Record<string, string[]>,
): Type
Creates a Type object using data returned from GPUdb show_table or show_types.
Parameters
- label: string
- typeSchema: string | fields: name: string; type: string | string[] []
- properties: Record<string, string[]>
Returns Type
- Defined in src/utils.ts:183