Module cuvs_sql 

Relation-aware cuVS SQL planning and execution contracts.

The adapter owns SQL recognition, static validation, logical/physical planning, and stable registry projections. Typed vector IR and device execution remain DataFusion-independent in query-engine.

Structs

CuvsExtensionPlanner

DataFusion physical extension planner for validated cuVS logical nodes.

CuvsLogicalNode

DataFusion logical extension for a statically validated cuVS relation call.

CuvsOperationDescriptor

One operation entry drives SQL names, relation shape, option metadata, and output-schema selection. Keep operation-specific facts in this registry.

CuvsRelationPlanner

DataFusion SQL relation planner that binds named cuVS function arguments.

CuvsValidatedOptions

Options of one cuVS call, validated and parsed once. The canonical JSON is the call’s identity and serialized form; validation and lowering read the typed parameters.

CuvsVectorRelationBinding

Validated columns bound to one named relation role in a cuVS SQL call.

GpuOptionDefinition

One declared option of a GPU table function: its JSON key, whether a call may omit it, and the value contract that validation and schema generation share.

GpuOptionValidationError

Rejection of a GPU function’s option object. code is a stable error identifier read by the adapter’s error mapping; message names the function family and is for people.

Enums

CuvsOperation

Operation identity used by native IR and the SQL adapter.

CuvsOutputContract

Stable relational output contract selected by an operation descriptor.

CuvsRelationRole

SQL relation argument roles in the canonical operation registry.

DenseVectorBinding

Binding from one native relation to a dense vector matrix.

GpuOptionKind

Canonical scalar option metadata used by JSON schema generation and value validation in the DataFusion adapter.

RelationIdType

Scalar ID types accepted by dense relational operations.

VectorAlgorithmParams

Algorithm-specific vector parameter payload.

VectorElementType

Vector element types for dense relation descriptors.

Constants

CUVS_BRUTE_FORCE_KNN_FUNCTION

Public SQL names for the query-local cuVS operations.

CUVS_CAGRA_FUNCTION

Canonical SQL function name for CAGRA nearest-neighbor search.

CUVS_IVF_FLAT_FUNCTION

Canonical SQL function name for IVF-Flat nearest-neighbor search.

CUVS_IVF_PQ_FUNCTION

Canonical SQL function name for IVF-PQ nearest-neighbor search.

CUVS_KMEANS_FUNCTION

Canonical SQL function name for KMeans fit and assignment.

CUVS_OPERATION_REGISTRY

Supported cuVS operations in their canonical catalog order.

CUVS_PAIRWISE_DISTANCE_FUNCTION

Canonical SQL function name for pairwise dense-vector distances.

CUVS_PCA_FUNCTION

Canonical SQL function name for PCA fit-transform.

CUVS_TOP_K_FUNCTION

Canonical SQL function name for selection of values within each vector.

RELATION_ID_TYPES

Stable order used in generated descriptions and validation diagnostics.

Functions

canonicalize_cuvs_options

Validate and canonicalize the scalar portion of an options JSON object. Relation binding field names/types are checked by the SQL adapter against its child schema, but presence and object shape are enforced here.

cuvs_options_json_schema

Generate the frozen options schema from the canonical operation descriptor.

cuvs_relation_planner

Creates a shared cuVS relation planner for installation on a session builder.

Type Aliases

CuvsAlgoExec

Physical execution wrapper for one cuVS call with validated input relations.