Class TablesAPI`Internal`

The class that encapsulates the tables DDL API

Index

Constructors

Methods

addColumn alterColumn create describe drop list removeColumn renameColumn

Constructors

constructor

new TablesAPI(api: API): TablesAPI
Parameters
- api: API
Returns TablesAPI
- Defined in sdk/src/api/tables.ts:15

Methods

addColumn

addColumn(tableName: string, column: ColumnDef): Promise<BazaarMessage>
Adds a column to an existing table.
Parameters
- tableName: string
- column: ColumnDef
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/tables.ts:55

alterColumn

alterColumn(
    tableName: string,
    columnName: string,
    changes: ColumnChanges,
): Promise<BazaarMessage>
Alters a column's type, required flag, or default.
Parameters
- tableName: string
- columnName: string
- changes: ColumnChanges
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/tables.ts:86

create

create(tableName: string, columns: ColumnDef[]): Promise<BazaarMessage>
Creates a table with the given columns.
Parameters
- tableName: string
- columns: ColumnDef[]
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/tables.ts:22

describe

describe(tableName: string): Promise<ColumnDef[]>
Describes a table's schema.
Parameters
- tableName: string
Returns Promise<ColumnDef[]>
- Defined in sdk/src/api/tables.ts:47

drop

drop(tableName: string): Promise<BazaarMessage>
Drops a table.
Parameters
- tableName: string
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/tables.ts:32

list

list(): Promise<string[]>
Lists all table names.

Returns Promise<string[]>
- Defined in sdk/src/api/tables.ts:39

removeColumn

removeColumn(tableName: string, columnName: string): Promise<BazaarMessage>
Removes a column from a table.
Parameters
- tableName: string
- columnName: string
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/tables.ts:65

renameColumn

renameColumn(
    tableName: string,
    oldName: string,
    newName: string,
): Promise<BazaarMessage>
Renames a column in a table.
Parameters
- tableName: string
- oldName: string
- newName: string
Returns Promise<BazaarMessage>
- Defined in sdk/src/api/tables.ts:75