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

# alter_table_metadata

### alter\_table\_metadata

<ul>
  <li>
    alter\_table\_metadata(\
    &#x20;table\_names: string\[],\
    &#x20;metadata\_map: Record\<string, string>,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[AlterTableMetadataResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AlterTableMetadataResponse.md)>

    Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

    #### Parameters

    <ul>
      <li>
        table\_names: string\[]

        Names of the tables whose metadata will be updated, in \[schema\_name.]table\_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned.
      </li>

      <li>
        metadata\_map: Record\<string, string>

        A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
      </li>

      <li>
        `Optional`options: Record\<string, string>

        Optional parameters.
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AlterTableMetadataResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AlterTableMetadataResponse.md)>

    Promise\<Types.AlterTableMetadataResponse> - Promise resolving to the response

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

### alter\_table\_metadata\_request

<ul>
  <li>
    alter\_table\_metadata\_request(\
    &#x20;request: [AlterTableMetadataRequest](https://docs.kinetica.com/content/api/javascript/interfaces/AlterTableMetadataRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md),\
    ): Promise\<[AlterTableMetadataResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AlterTableMetadataResponse.md)>

    Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

    #### Parameters

    <ul>
      <li>
        request: [AlterTableMetadataRequest](https://docs.kinetica.com/content/api/javascript/interfaces/AlterTableMetadataRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/javascript/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[AlterTableMetadataResponse](https://docs.kinetica.com/content/api/javascript/interfaces/AlterTableMetadataResponse.md)>

    Promise\<Types.AlterTableMetadataResponse> - Promise resolving to the response

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


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