Skip to content

AlterTableAlterColumns

Description

      description: |
        Modify existing columns in table `id`, such as renaming or changing data types.

Request Schema

    AlterTableAlterColumnsRequest:
      type: object
      required:
        - alterations
      properties:
        id:
          type: array
          items:
            type: string
        alterations:
          type: array
          items:
            $ref: '#/components/schemas/ColumnAlteration'
          description: List of column alterations to perform

Response Schema

    AlterTableAlterColumnsResponse:
      type: object
      required:
        - version
      properties:
        version:
          type: integer
          format: int64
          minimum: 0
          description: Version of the table after altering columns

Column Alteration

    ColumnAlteration:
      type: object
      required:
        - column
      properties:
        column:
          type: string
          description: Name of the column to alter
        rename:
          type: string
          description: New name for the column (optional)
        cast_to:
          type: string
          description: New data type to cast the column to (optional)