Welcome to the new DOCS.vastdata.com. We've added new menus and a version selector, plus new persona and resource pages to help customers get started. Looking for a previous article? Use the docs search.

Choose a client

Prev Next

Applies to VAST Cluster 5.5.

Which clients work with which service, and the page that shows each one. A blank cell means no page in these docs covers that client with that service; it doesn't mean the combination can't work.

Clients and services

Client VAST DataBase Vector Search Event Broker DataEngine DataStore Catalog
VAST DataBase Python SDK (vastdb) Quickstart, Python SDK Python SDK Read topics with the SDK From a function Quickstart, find files
VAST Query Engine over ADBC VAST Query Engine (ADBC) ADBC, quickstart Query topics
LangChain (langchain-vastdb) LangChain
Trino Trino Not for search (limits) Query topics Trino
Apache Spark Spark Not for search (limits) Query topics, Spark Structured Streaming Spark and Hadoop (S3A) Spark
boto3, AWS CLI, s3fs, PyArrow Stage files for import Import Parquet files Configure a bucket notification Upload an object Quickstart, Python clients, AWS CLI and tools
NFS mounts NFS file triggers NFS for applications, multiprotocol access
Kafka clients Quickstart, producing, consuming, Kafka tools Dead-letter topic
DataEngine CLI (vastde) Quickstart, pipelines as code

Notes on the matrix:

  • Vector search goes through the VAST Query Engine. The Python SDK's vector_search() runs its search through the Query Engine too. The Trino and Spark connectors don't support vector index-based search (VAST Vector Search overview).
  • Event Broker topics are tables. Every client in the VAST DataBase column can read a topic, but topic tables are read-only through the VAST DataBase API: you write events with a Kafka producer (VAST Event Broker overview).
  • Kafka clients: supported clients include the Confluent Kafka clients (Python 2.4 to 2.8, Java, .NET, C and Rust), Sarama and franz-go; these docs use confluent-kafka for Python. Other Kafka tools, such as Kafka Connect, MirrorMaker 2 and Flink, have their own status (Kafka compatibility, integrations).
  • Catalog and audit log are system tables in VAST DataBase, reached with the same SDK, Trino and Spark clients as your own tables (VAST Catalog overview).
  • Client versions for the SDK, Trino, Spark and the ADBC driver are on version compatibility.

Automation tools

To create views, policies, users, keys, tables, topics or DataEngine pipelines from code or CI, use the automation tools: the VMS REST API, vastpy, the VAST Terraform provider and the VAST admin MCP server. Automation tools compares what each one covers, how it authenticates and which API version it calls. Each service has its own CI/CD and automation page with examples: