alter_table_columns
- alter_table_columns(
table_name: string,
column_alterations: Record<string, string>[],
options: Record<string, string>,
callback?: GPUdbCallback,
): Promise<AlterTableColumnsResponse>Parameters
- table_name: string
Table on which the operation will be performed. Must be an existing table or view, in [schema_name.]table_name format, using standard name resolution rules.
- column_alterations: Record<string, string>[]
List of alter table add/delete/change column requests - all for the same table. Each request is a map that includes ‘column_name’, ‘action’ and the options specific for the action. Note that the same options as in alter table requests but in the same map as the column name and the action. For example: [‘column_name’:‘col_1’,‘action’:‘change_column’,‘rename_column’:‘col_2’,‘column_name’:‘col_1’,‘action’:‘add_column’, ‘type’:‘int’,‘default_value’:‘1’].
- options: Record<string, string>
Optional parameters.
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<AlterTableColumnsResponse>
Promise<Types.AlterTableColumnsResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:4604
- table_name: string
alter_table_columns_request
- alter_table_columns_request(
request: AlterTableColumnsRequest,
callback?: GPUdbCallback,
): Promise<AlterTableColumnsResponse>Apply various modifications to columns in a table, view. The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table’s columns—a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.
Parameters
- request: AlterTableColumnsRequest
Request object containing the parameters for the operation
Optionalcallback: GPUdbCallbackOptional callback function
Returns Promise<AlterTableColumnsResponse>
Promise<Types.AlterTableColumnsResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:4570
- request: AlterTableColumnsRequest
Apply various modifications to columns in a table, view. The available modifications include the following:
Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.
Manage a table’s columns—a column can be added, removed, or have its type and properties modified, including whether it is dictionary encoded or not.