Skip to content

CreateTableIndex

Description

      description: |
        Create an index on a table column for faster search operations.
        Supports vector indexes (IVF_FLAT, IVF_HNSW_SQ, IVF_PQ, etc.) and scalar indexes (BTREE, BITMAP, FTS, etc.).
        Index creation is handled asynchronously. 
        Use the `ListTableIndices` and `DescribeTableIndexStats` operations to monitor index creation progress.

Request Schema

    CreateTableIndexRequest:
      type: object
      required:
        - column
        - index_type
      properties:
        id:
          type: array
          items:
            type: string
        column:
          type: string
          description: Name of the column to create index on
        index_type:
          type: string
          enum: 
            - BTREE
            - BITMAP
            - LABEL_LIST
            - IVF_FLAT
            - IVF_PQ
            - IVF_HNSW_SQ
            - FTS
          description: Type of index to create
        metric_type:
          type: string
          enum: 
            - l2
            - cosine
            - dot
          nullable: true
          description: Distance metric type for vector indexes
        with_position:
          type: boolean
          nullable: true
          description: Optional FTS parameter for position tracking
        base_tokenizer:
          type: string
          nullable: true
          description: Optional FTS parameter for base tokenizer
        language:
          type: string
          nullable: true
          description: Optional FTS parameter for language
        max_token_length:
          type: integer
          nullable: true
          minimum: 0
          description: Optional FTS parameter for maximum token length
        lower_case:
          type: boolean
          nullable: true
          description: Optional FTS parameter for lowercase conversion
        stem:
          type: boolean
          nullable: true
          description: Optional FTS parameter for stemming
        remove_stop_words:
          type: boolean
          nullable: true
          description: Optional FTS parameter for stop word removal
        ascii_folding:
          type: boolean
          nullable: true
          description: Optional FTS parameter for ASCII folding

Response Schema

    CreateTableIndexResponse:
      type: object
      required:
        - location
      properties:
        id:
          type: array
          items:
            type: string
        location:
          type: string
          description: Table location (usually empty)
        properties:
          type: object
          additionalProperties:
            type: string
          description: Additional properties (usually empty)