Jump to

• Request
• Response

Describe a vector table.

get

http://localhost:8080/ords/pdbdba/_/db-api/stable/vecdb/vector-tables/{vector_table_name}

Returns metadata for the specified vector table.

Request

Path Parameters

• vector_table_name(required): string
  Name of the vector table. Must contain only letters, digits, and underscore (_).

There's no request body for this operation.

Security

• BasicAuth: http
  Type: http
• BearerAuth: http
  Type: http
• OAuth2: oauth2
  Type: oauth2

Back to Top

Response

Supported Media Types

• application/json
• application/problem+json

200 Response

Vector table details.

Headers

• ETag:
  Entity tag for the resource.

Body ()

Root Schema : VecDBTableNoLinks

Match All

Show Source

• object VecDBTableBaseNoLinks
• object VecDBTableNoLinks-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/VecDBTableBaseNoLinks"
        },
        {
            "type":"object",
            "properties":{
                "table_params":{
                    "type":"object",
                    "description":"Table creation controls.",
                    "nullable":true,
                    "properties":{
                        "auto_generate_id":{
                            "type":"integer",
                            "description":"1 if ID defaults to SYS_GUID(), otherwise 0."
                        }
                    },
                    "additionalProperties":true
                }
            }
        }
    ]
}

Nested Schema : VecDBTableBaseNoLinks

Type: object

Show Source

• annotations: object annotations
  Additional Properties Allowed: true

  User metadata attached to the table.
• comment: string
  Table comment.
• created: string (date-time)
  Creation timestamp of the vector table.
• embed_params: object embed_params
  Additional Properties Allowed: true

  Embedding model configuration for MODEL tables.
• index_params: object VectorIndexParams
  Additional Properties Allowed: true

  Nested index configuration for vector and metadata indexes.
• indexes: object indexes
  Additional Properties Allowed: true

  Vector and metadata index details.
• owner: string
• stats: object stats
  Additional Properties Allowed: true

  Statistics of the vector table.
• status: string
  Population status of the vector table.
• table_name: string
  The name of the vector table.
• updated: string (date-time)
  Update timestamp of the vector table.
• vector_table_type: string
  Allowed Values: [ "BYOV", "MODEL" ]

  Creation mode of the table.
• vector_type: string
  Allowed Values: [ "dense" ]

{
    "type":"object",
    "properties":{
        "table_name":{
            "type":"string",
            "description":"The name of the vector table."
        },
        "comment":{
            "type":"string",
            "description":"Table comment.",
            "nullable":true
        },
        "annotations":{
            "description":"User metadata attached to the table.",
            "type":"object",
            "nullable":true,
            "additionalProperties":true
        },
        "vector_type":{
            "type":"string",
            "enum":[
                "dense"
            ]
        },
        "vector_table_type":{
            "type":"string",
            "enum":[
                "BYOV",
                "MODEL"
            ],
            "description":"Creation mode of the table."
        },
        "embed_params":{
            "description":"Embedding model configuration for MODEL tables.",
            "type":"object",
            "nullable":true,
            "properties":{
                "model":{
                    "type":"string"
                },
                "embed_metadata_jsonpath":{
                    "type":"string"
                }
            },
            "additionalProperties":true
        },
        "index_params":{
            "$ref":"#/components/schemas/VectorIndexParams"
        },
        "owner":{
            "type":"string"
        },
        "indexes":{
            "type":"object",
            "description":"Vector and metadata index details.",
            "nullable":true,
            "properties":{
                "dense_idx_name":{
                    "type":"string",
                    "nullable":true
                },
                "indexed_metadata_json_paths":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "additionalProperties":true
        },
        "status":{
            "type":"string",
            "description":"Population status of the vector table."
        },
        "stats":{
            "type":"object",
            "description":"Statistics of the vector table.",
            "nullable":true,
            "additionalProperties":true
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Creation timestamp of the vector table."
        },
        "updated":{
            "type":"string",
            "format":"date-time",
            "description":"Update timestamp of the vector table.",
            "nullable":true
        }
    }
}

Nested Schema : VecDBTableNoLinks-allOf[1]

Type: object

Show Source

• table_params: object table_params
  Additional Properties Allowed: true

  Table creation controls.

{
    "type":"object",
    "properties":{
        "table_params":{
            "type":"object",
            "description":"Table creation controls.",
            "nullable":true,
            "properties":{
                "auto_generate_id":{
                    "type":"integer",
                    "description":"1 if ID defaults to SYS_GUID(), otherwise 0."
                }
            },
            "additionalProperties":true
        }
    }
}

Nested Schema : annotations

Type: object

Additional Properties Allowed: true

User metadata attached to the table.

Nested Schema : embed_params

Type: object

Additional Properties Allowed: true

Embedding model configuration for MODEL tables.

Show Source

• embed_metadata_jsonpath: string
• model: string

{
    "description":"Embedding model configuration for MODEL tables.",
    "type":"object",
    "nullable":true,
    "properties":{
        "model":{
            "type":"string"
        },
        "embed_metadata_jsonpath":{
            "type":"string"
        }
    },
    "additionalProperties":true
}

Nested Schema : VectorIndexParams

Type: object

Additional Properties Allowed: true

Nested index configuration for vector and metadata indexes.

Show Source

• index_type: string
  Allowed Values: [ "vector", "metadata", "all" ]

  Action scope for rebuild and drop operations.
• metadata_index_params: object metadata_index_params
  Additional Properties Allowed: true

  Metadata multi-value index settings and path selectors.
• parallel_creation: integer
  Minimum Value: 1

  Parallel DDL degree for vector and metadata index operations.
• vector_index_params: object vector_index_params
  Additional Properties Allowed: true

  Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.

{
    "description":"Nested index configuration for vector and metadata indexes.",
    "type":"object",
    "properties":{
        "vector_index_params":{
            "type":"object",
            "description":"Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.",
            "properties":{
                "auto_index":{
                    "type":"boolean",
                    "description":"Enables vector index creation or management."
                },
                "organization":{
                    "type":"string",
                    "enum":[
                        "PARTITIONS",
                        "INMEMORY GRAPH"
                    ]
                },
                "distance_metric":{
                    "type":"string",
                    "enum":[
                        "COSINE",
                        "MANHATTAN",
                        "HAMMING",
                        "JACCARD",
                        "DOT",
                        "EUCLIDEAN",
                        "L2_SQUARED",
                        "EUCLIDEAN_SQUARED"
                    ]
                },
                "accuracy":{
                    "type":"integer",
                    "minimum":0,
                    "maximum":100
                },
                "online_build":{
                    "type":"boolean"
                },
                "quantization_type":{
                    "type":"string",
                    "nullable":true,
                    "enum":[
                        "NONE",
                        "SCALAR"
                    ]
                },
                "compression_ratio":{
                    "type":"number",
                    "nullable":true,
                    "enum":[
                        2,
                        4,
                        8
                    ]
                },
                "distribute_params":{
                    "type":"object",
                    "nullable":true,
                    "properties":{
                        "distribute_method":{
                            "type":"string",
                            "enum":[
                                "ROWID RANGE",
                                "SIMILARITY",
                                "PARTITION",
                                "SUBPARTITION",
                                "DISTRIBUTE",
                                "AUTO"
                            ]
                        }
                    }
                },
                "advanced_params":{
                    "type":"object",
                    "description":"Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm."
                }
            },
            "additionalProperties":true
        },
        "metadata_index_params":{
            "type":"object",
            "description":"Metadata multi-value index settings and path selectors.",
            "properties":{
                "auto_index":{
                    "type":"boolean"
                },
                "include_paths":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "exclude_paths":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "additionalProperties":true
        },
        "parallel_creation":{
            "type":"integer",
            "nullable":true,
            "minimum":1,
            "description":"Parallel DDL degree for vector and metadata index operations."
        },
        "index_type":{
            "type":"string",
            "enum":[
                "vector",
                "metadata",
                "all"
            ],
            "description":"Action scope for rebuild and drop operations."
        }
    },
    "additionalProperties":true,
    "example":{
        "vector_index_params":{
            "auto_index":true,
            "organization":"INMEMORY GRAPH",
            "distance_metric":"COSINE",
            "quantization_type":"SCALAR",
            "compression_ratio":4,
            "distribute_params":{
                "distribute_method":"AUTO"
            },
            "advanced_params":{
                "neighbors":32,
                "efConstruction":128,
                "rescore_factor":10,
                "algorithm":"uniform_quantization"
            }
        },
        "metadata_index_params":{
            "auto_index":true,
            "include_paths":[
                "tenant",
                "category"
            ],
            "exclude_paths":[
                "body"
            ]
        },
        "parallel_creation":4
    }
}

Example:

{
    "vector_index_params":{
        "auto_index":true,
        "organization":"INMEMORY GRAPH",
        "distance_metric":"COSINE",
        "quantization_type":"SCALAR",
        "compression_ratio":4,
        "distribute_params":{
            "distribute_method":"AUTO"
        },
        "advanced_params":{
            "neighbors":32,
            "efConstruction":128,
            "rescore_factor":10,
            "algorithm":"uniform_quantization"
        }
    },
    "metadata_index_params":{
        "auto_index":true,
        "include_paths":[
            "tenant",
            "category"
        ],
        "exclude_paths":[
            "body"
        ]
    },
    "parallel_creation":4
}

Nested Schema : indexes

Type: object

Additional Properties Allowed: true

Vector and metadata index details.

Show Source

• dense_idx_name: string
• indexed_metadata_json_paths: array indexed_metadata_json_paths

{
    "type":"object",
    "description":"Vector and metadata index details.",
    "nullable":true,
    "properties":{
        "dense_idx_name":{
            "type":"string",
            "nullable":true
        },
        "indexed_metadata_json_paths":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":true
}

Nested Schema : stats

Type: object

Additional Properties Allowed: true

Statistics of the vector table.

Nested Schema : metadata_index_params

Type: object

Additional Properties Allowed: true

Metadata multi-value index settings and path selectors.

Show Source

• auto_index: boolean
• exclude_paths: array exclude_paths
• include_paths: array include_paths

{
    "type":"object",
    "description":"Metadata multi-value index settings and path selectors.",
    "properties":{
        "auto_index":{
            "type":"boolean"
        },
        "include_paths":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "exclude_paths":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":true
}

Nested Schema : vector_index_params

Type: object

Additional Properties Allowed: true

Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.

Show Source

• accuracy: integer
  Minimum Value: 0

  Maximum Value: 100
• advanced_params: object advanced_params
  Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm.
• auto_index: boolean
  Enables vector index creation or management.
• compression_ratio: number
  Allowed Values: [ 2, 4, 8 ]
• distance_metric: string
  Allowed Values: [ "COSINE", "MANHATTAN", "HAMMING", "JACCARD", "DOT", "EUCLIDEAN", "L2_SQUARED", "EUCLIDEAN_SQUARED" ]
• distribute_params: object distribute_params
• online_build: boolean
• organization: string
  Allowed Values: [ "PARTITIONS", "INMEMORY GRAPH" ]
• quantization_type: string
  Allowed Values: [ "NONE", "SCALAR" ]

{
    "type":"object",
    "description":"Vector index settings such as organization, distance metric, distributed HNSW, scalar quantization, and advanced parameters.",
    "properties":{
        "auto_index":{
            "type":"boolean",
            "description":"Enables vector index creation or management."
        },
        "organization":{
            "type":"string",
            "enum":[
                "PARTITIONS",
                "INMEMORY GRAPH"
            ]
        },
        "distance_metric":{
            "type":"string",
            "enum":[
                "COSINE",
                "MANHATTAN",
                "HAMMING",
                "JACCARD",
                "DOT",
                "EUCLIDEAN",
                "L2_SQUARED",
                "EUCLIDEAN_SQUARED"
            ]
        },
        "accuracy":{
            "type":"integer",
            "minimum":0,
            "maximum":100
        },
        "online_build":{
            "type":"boolean"
        },
        "quantization_type":{
            "type":"string",
            "nullable":true,
            "enum":[
                "NONE",
                "SCALAR"
            ]
        },
        "compression_ratio":{
            "type":"number",
            "nullable":true,
            "enum":[
                2,
                4,
                8
            ]
        },
        "distribute_params":{
            "type":"object",
            "nullable":true,
            "properties":{
                "distribute_method":{
                    "type":"string",
                    "enum":[
                        "ROWID RANGE",
                        "SIMILARITY",
                        "PARTITION",
                        "SUBPARTITION",
                        "DISTRIBUTE",
                        "AUTO"
                    ]
                }
            }
        },
        "advanced_params":{
            "type":"object",
            "description":"Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm."
        }
    },
    "additionalProperties":true
}

Nested Schema : exclude_paths

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : include_paths

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : advanced_params

Type: object

Index-family-specific options such as partitions, neighbors, efConstruction, rescore_factor, or algorithm.

Nested Schema : distribute_params

Type: object

Show Source

• distribute_method: string
  Allowed Values: [ "ROWID RANGE", "SIMILARITY", "PARTITION", "SUBPARTITION", "DISTRIBUTE", "AUTO" ]

{
    "type":"object",
    "nullable":true,
    "properties":{
        "distribute_method":{
            "type":"string",
            "enum":[
                "ROWID RANGE",
                "SIMILARITY",
                "PARTITION",
                "SUBPARTITION",
                "DISTRIBUTE",
                "AUTO"
            ]
        }
    }
}

Nested Schema : indexed_metadata_json_paths

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : table_params

Type: object

Additional Properties Allowed: true

Table creation controls.

Show Source

• auto_generate_id: integer
  1 if ID defaults to SYS_GUID(), otherwise 0.

{
    "type":"object",
    "description":"Table creation controls.",
    "nullable":true,
    "properties":{
        "auto_generate_id":{
            "type":"integer",
            "description":"1 if ID defaults to SYS_GUID(), otherwise 0."
        }
    },
    "additionalProperties":true
}

404 Response

Not found or precondition failed.

Body ()

Root Schema : ORDSErrorResponse

Type: object

Show Source

• code(required): string
• diagnosticTrace: string
• instance(required): string
• message(required): string
• stackTrace: string
• type(required): string

{
    "type":"object",
    "required":[
        "code",
        "message",
        "type",
        "instance"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "instance":{
            "type":"string"
        },
        "diagnosticTrace":{
            "type":"string"
        },
        "stackTrace":{
            "type":"string"
        }
    }
}

Back to Top