> ## 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.

# AlterTableRequest

> AlterTableRequest — Kinetica TypeScript API

interface AlterTableRequest \{\
&#x20;[action](#action): string;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[table\_name](#table_name): string;\
&#x20;[value](#value): string;\
}

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

##### Index

### Properties

[action](#action) [options?](#options) [table\_name](#table_name) [value](#value)&#x20;

## Properties

### action

action: string

Modification operation to be applied.

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

### `Optional`options

options?: Record\<string, string>

Optional parameters.

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

### table\_name

table\_name: string

Table on which the operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing table or view.

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

### value

value: string

The value of the modification, depending on `action`. For example, if `action` is add\_column, this would be the column name; while the column's definition would be covered by the column\_type, column\_properties, column\_default\_value, and add\_column\_expression in `options`. If `action` is ttl, it would be the number of minutes for the new TTL. If `action` is refresh, this field would be blank.

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


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