Skip to content

DescribeTableIndexStats

Description

      description: |
        Get statistics for a specific index on a table. Returns information about
        the index type, distance type (for vector indices), and row counts.

Request Schema

    DescribeTableIndexStatsRequest:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        version:
          type: integer
          format: int64
          minimum: 0
          nullable: true
          description: Optional table version to get stats for
        index_name:
          type: string
          description: Name of the index

Response Schema

    DescribeTableIndexStatsResponse:
      type: object
      properties:
        distance_type:
          type: string
          nullable: true
          description: Distance type for vector indexes
        index_type:
          type: string
          nullable: true
          description: Type of the index
        num_indexed_rows:
          type: integer
          format: int64
          minimum: 0
          nullable: true
          description: Number of indexed rows
        num_unindexed_rows:
          type: integer
          format: int64
          minimum: 0
          nullable: true
          description: Number of unindexed rows