> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Type

> Type — Kinetica TypeScript API

Metadata about a GPUdb type.

<ul>
  <li>Defined in [src/utils.ts:163](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L163)</li>
  <li>Defined in [src/utils.ts:293](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L293)</li>
</ul>

##### Index

### Constructors

[constructor](#constructor)&#x20;

### Properties

[columns](#columns) [label](#label)&#x20;

### Methods

[create](#create) [generateSchema](#generateschema) [fromTable](#fromtable) [fromType](#fromtype) [fromTypeInfo](#fromtypeinfo)&#x20;

## Constructors

### constructor

<ul>
  <li>
    new Type(label: string, ...columns: [Column](https://docs.kinetica.com/content/api/typescript/classes/Column.md)\[]): Type

    Creates a Type object.

    #### Parameters

    <ul>
      <li>
        label: string

        A user-defined description string
      </li>

      <li>
        ...columns: [Column](https://docs.kinetica.com/content/api/typescript/classes/Column.md)\[]

        The columns that make up the type
      </li>
    </ul>

    #### Returns Type

    <ul>
      <li>Defined in [src/utils.ts:175](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L175)</li>
    </ul>
  </li>
</ul>

## Properties

### `Readonly`columns

columns: [Column](https://docs.kinetica.com/content/api/typescript/classes/Column.md)\[]

The list of columns that the type comprises

<ul>
  <li>Defined in [src/utils.ts:167](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L167)</li>
</ul>

### `Readonly`label

label: string

A user-defined description string

<ul>
  <li>Defined in [src/utils.ts:165](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L165)</li>
</ul>

## Methods

### create

<ul>
  <li>
    create(gpudb: [GPUdb](https://docs.kinetica.com/content/api/typescript/classes/GPUdb.md)): Promise\<string>

    Creates a new type in GPUdb based on the metadata in the Type object.

    #### Parameters

    <ul>
      <li>
        gpudb: [GPUdb](https://docs.kinetica.com/content/api/typescript/classes/GPUdb.md)

        GPUdb client instance
      </li>
    </ul>

    #### Returns Promise\<string>

    Promise resolving to the type ID

    <ul>
      <li>Defined in [src/utils.ts:223](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L223)</li>
    </ul>
  </li>
</ul>

### generateSchema

<ul>
  <li>
    generateSchema(): \{\
    &#x20;fields: \{ name: string; type: string\
    &#x20;| string\[] }\[];\
    &#x20;name: string;\
    &#x20;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; }

    <ul>
      <li>Defined in [src/utils.ts:206](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L206)</li>
    </ul>
  </li>
</ul>

### `Static`fromTable

<ul>
  <li>
    fromTable(gpudb: [GPUdb](https://docs.kinetica.com/content/api/typescript/classes/GPUdb.md), tableName: string): Promise\<Type>

    Creates a Type object containing metadata about the type stored in the specified table.

    #### Parameters

    <ul>
      <li>
        gpudb: [GPUdb](https://docs.kinetica.com/content/api/typescript/classes/GPUdb.md)

        GPUdb client instance
      </li>

      <li>
        tableName: string

        The table from which to obtain type metadata
      </li>
    </ul>

    #### Returns Promise\<Type>

    Promise resolving to the Type object

    <ul>
      <li>Defined in [src/utils.ts:247](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L247)</li>
    </ul>
  </li>
</ul>

### `Static`fromType

<ul>
  <li>
    fromType(gpudb: [GPUdb](https://docs.kinetica.com/content/api/typescript/classes/GPUdb.md), typeId: string): Promise\<Type>

    Creates a Type object containing metadata about the specified type in GPUdb.

    #### Parameters

    <ul>
      <li>
        gpudb: [GPUdb](https://docs.kinetica.com/content/api/typescript/classes/GPUdb.md)

        GPUdb client instance
      </li>

      <li>
        typeId: string

        The type for which to obtain metadata
      </li>
    </ul>

    #### Returns Promise\<Type>

    Promise resolving to the Type object

    <ul>
      <li>Defined in [src/utils.ts:277](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L277)</li>
    </ul>
  </li>
</ul>

### `Static`fromTypeInfo

<ul>
  <li>
    fromTypeInfo(\
    &#x20;label: string,\
    &#x20;typeSchema:\
    &#x20;| string\
    &#x20;| \{ fields: \{ name: string; type: string\
    &#x20;| string\[] }\[] },\
    &#x20;properties: Record\<string, string\[]>,\
    ): Type

    Creates a Type object using data returned from GPUdb show\_table or show\_types.

    #### Parameters

    <ul>
      <li>label: string</li>
      <li>typeSchema: string | \{ fields: \{ name: string; type: string | string\[] }\[] }</li>
      <li>properties: Record\<string, string\[]></li>
    </ul>

    #### Returns Type

    <ul>
      <li>Defined in [src/utils.ts:183](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/utils.ts#L183)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.