> ## Documentation Index
> Fetch the complete documentation index at: https://docs.insforge.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Table Schema



## OpenAPI

````yaml https://raw.githubusercontent.com/InsForge/InsForge/main/openapi/tables.yaml patch /api/database/tables/{tableName}/schema
openapi: 3.0.3
info:
  title: Insforge Tables API
  version: 1.0.0
servers: []
security: []
paths:
  /api/database/tables/{tableName}/schema:
    patch:
      tags:
        - Admin
      summary: Update Table Schema
      parameters:
        - name: tableName
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                addColumns:
                  type: array
                  description: Add new columns to the table
                  items:
                    type: object
                    required:
                      - columnName
                      - type
                    properties:
                      columnName:
                        type: string
                        description: Name of the new column
                      type:
                        type: string
                        enum:
                          - string
                          - integer
                          - float
                          - boolean
                          - datetime
                          - uuid
                          - json
                          - file
                        description: Data type of the column
                      isNullable:
                        type: boolean
                        default: true
                        description: Whether the column allows NULL values
                      isUnique:
                        type: boolean
                        default: false
                        description: Whether the column values must be unique
                      defaultValue:
                        type: string
                        description: Default value for the column
                dropColumns:
                  type: array
                  description: Remove columns from the table
                  items:
                    type: string
                    description: Name of the column to drop
                updateColumns:
                  type: array
                  description: Modify existing columns (rename or change default)
                  items:
                    type: object
                    required:
                      - columnName
                    properties:
                      columnName:
                        type: string
                        description: Current name of the column
                      newColumnName:
                        type: string
                        description: New name for the column (optional)
                        minLength: 1
                        maxLength: 64
                      defaultValue:
                        type: string
                        description: New default value for the column (optional)
                addForeignKeys:
                  type: array
                  description: >-
                    Add foreign key constraints (one entry per constraint;
                    composite keys list multiple column mappings)
                  items:
                    $ref: '#/components/schemas/ForeignKeyConstraint'
                dropForeignKeys:
                  type: array
                  description: Constraint names of foreign keys to drop
                  items:
                    type: string
                    description: Name of the foreign key constraint to drop
                renameTable:
                  type: object
                  description: Rename the table
                  required:
                    - newTableName
                  properties:
                    newTableName:
                      type: string
                      description: New name for the table
                      minLength: 1
                      maxLength: 64
      responses:
        '200':
          description: Table schema updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Success message
                  tableName:
                    type: string
                    description: Name of the updated table
                  operations:
                    type: array
                    description: List of operations performed
                    items:
                      type: string
              example:
                message: Table schema updated successfully
                tableName: posts
                operations:
                  - added 2 columns
                  - dropped 1 columns
                  - renamed 1 columns
                  - added 1 foreign keys
                  - dropped 1 foreign keys
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                columnExists:
                  value:
                    error: COLUMN_EXISTS
                    message: Column 'title' already exists in table 'posts'
                    statusCode: 400
                    nextActions: Choose a different column name or drop it first
                columnNotFound:
                  value:
                    error: COLUMN_NOT_FOUND
                    message: Column 'nonexistent' not found in table 'posts'
                    statusCode: 400
                    nextActions: Check column name with GET /api/tables/{tableName}/schema
                foreignKeyExists:
                  value:
                    error: FOREIGN_KEY_EXISTS
                    message: Foreign key on column 'user_id' already exists
                    statusCode: 400
                    nextActions: >-
                      Drop the existing foreign key first or use a different
                      column
        '404':
          description: Table not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error: TABLE_NOT_FOUND
                message: Table 'nonexistent' does not exist
                statusCode: 404
                nextActions: Check table name and try again
      security:
        - bearerAuth: []
        - apiKey: []
components:
  schemas:
    ForeignKeyConstraint:
      type: object
      description: >-
        A table-level foreign key constraint. One entry per constraint;
        composite keys list multiple column mappings.
      required:
        - referenceTable
        - referenceColumns
        - onDelete
        - onUpdate
      properties:
        constraintName:
          type: string
          description: >-
            Constraint name. Returned when reading the schema; derived by the
            backend on create.
        referenceTable:
          type: string
          minLength: 1
          description: Table being referenced
        referenceColumns:
          type: array
          minItems: 1
          description: Ordered (source → reference) column pairs
          items:
            type: object
            required:
              - sourceColumn
              - referenceColumn
            properties:
              sourceColumn:
                type: string
                description: Column in the current table
              referenceColumn:
                type: string
                description: Column in the referenced table
        onDelete:
          type: string
          enum:
            - CASCADE
            - SET NULL
            - SET DEFAULT
            - NO ACTION
            - RESTRICT
        onUpdate:
          type: string
          enum:
            - CASCADE
            - SET NULL
            - SET DEFAULT
            - NO ACTION
            - RESTRICT
    ErrorResponse:
      type: object
      required:
        - error
        - message
        - statusCode
      properties:
        error:
          type: string
          description: Error code for programmatic handling
        message:
          type: string
          description: Human-readable error message
        statusCode:
          type: integer
          description: HTTP status code
        nextActions:
          type: string
          description: Suggested action to resolve the error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key

````