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

### alter\_schema

<ul>
  <li>
    alter\_schema(\
    &#x20;schema\_name: string,\
    &#x20;action: string,\
    &#x20;value: string,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[AlterSchemaResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/AlterSchemaResponse.md)>

    Used to change the name of a SQL-style schema, specified in `schema_name`.

    #### Parameters

    <ul>
      <li>
        schema\_name: string

        Name of the schema to be altered.
      </li>

      <li>
        action: string

        Modification operation to be applied.
      </li>

      <li>
        value: string

        The value of the modification, depending on `action`. For now the only value of `action` is rename\_schema. In this case the value is the new name of the schema.
      </li>

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

        Optional parameters.
      </li>

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

        Optional callback function
      </li>
    </ul>

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

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

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

### alter\_schema\_request

<ul>
  <li>
    alter\_schema\_request(\
    &#x20;request: [AlterSchemaRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/AlterSchemaRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[AlterSchemaResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/AlterSchemaResponse.md)>

    Used to change the name of a SQL-style schema, specified in `schema_name`.

    #### Parameters

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

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

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

        Optional callback function
      </li>
    </ul>

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

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

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


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