Java Client Library for Data API 2.0.0-PREVIEW API

Overview

This client library provides a simplified way to interact with Data API with DataStax AstraDB or local deployments ( Stargate + Cassandra).

More resources can be found:

• In Datastax Astra Client documentation page
• In the github repository with an examples section.

Installation

For Maven, add the following dependency to your pom.xml:

<dependency>
  <groupId>com.datastax.astra</groupId>
  <artifactId>astra-db-java</artifactId>
  <version>2.0.0-PREVIEW</version>
</dependency>

QuickStart

import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.paging.FindIterable;
import java.util.List;
import static com.datastax.astra.client.model.Filters.eq;
import static com.datastax.astra.client.model.SimilarityMetric.cosine;

public class GettingStarted {
 public static void main(String[] args) {
  // Initializing client with a token
  DataAPIClient client = new DataAPIClient("my_token");

  // Accessing the Database through the HTTP endpoint
  Database db = client.getDatabase("http://db-region.apps.astra.datastax.com");

  // Create collection with vector support
  Collection<Document> col = db.createCollection("demo", 2, cosine);

  // Insert documents with embeddings
  col.insertMany(List.of(
   new Document("doc1").vector(new float[]{.1f, 0.2f}).append("key", "value1"),
   new Document().id("doc2").vector(new float[]{.2f, 0.4f}).append("hello", "world"),
   new Document("doc3").vector(new float[]{.5f, 0.6f}).append("key", "value1"))
  );

  // Semantic Search with metadata filtering
  FindIterable<Document> docs = col.find(
    eq("key", "value1"), // metadata filter
    new float[] {.5f, .5f},              //vector
    10);                                 // maxRecord

  // Iterate over and print your results
  for (Document doc : docs) System.out.println(doc);
 }
}

Packages

Package	Description
com.datastax.astra.client	Entrypoint and core classes for the client.
com.datastax.astra.client.admin	Administration classes to manage Databases and Namespaces.
com.datastax.astra.client.collections	Top package to interact with Collections
com.datastax.astra.client.collections.commands	Command Definitions for operating on Collections.
com.datastax.astra.client.collections.commands.cursor	Objects representing cursors working with find collections commands.
com.datastax.astra.client.collections.commands.options	Options and Inputs for Collections commands.
com.datastax.astra.client.collections.commands.results	Outputs and DTO for Collections Commands.
com.datastax.astra.client.collections.definition	Objects describing the structure of a collection.
com.datastax.astra.client.collections.definition.documents	Objects describing the structure of a Document.
com.datastax.astra.client.collections.definition.documents.types	Object representing the type Id for collections.
com.datastax.astra.client.collections.exceptions	Specializations of the exceptions to work with Collections.
com.datastax.astra.client.core	Core classes to interact both with Tables and Collections.
com.datastax.astra.client.core.auth	Internal technical classes to authenticate against API endpoint.
com.datastax.astra.client.core.commands	Utility classes for commands and operations.
com.datastax.astra.client.core.http	Classes to specialize the HTTP Client.
com.datastax.astra.client.core.options	Classes for options of the core commands.
com.datastax.astra.client.core.paging	Informations for cursor-based paging.
com.datastax.astra.client.core.query	Classes uses to build queries with Sort and Projection.
com.datastax.astra.client.core.vector	Objects representing Vector options (vector)
com.datastax.astra.client.core.vectorize	Objects representing Vector Services options (vectorize)
com.datastax.astra.client.databases	Top package to interact with Databases and Keyspaces.
com.datastax.astra.client.databases.commands	Objects representing commands against databases and keyspaces.
com.datastax.astra.client.databases.commands.results	Object representing keyspace level returns objects.
com.datastax.astra.client.databases.definition	Objects the informations of databases
com.datastax.astra.client.databases.definition.keyspaces	Object representing the keyspaces.
com.datastax.astra.client.exceptions	Exceptions specialized checked and unchecked thrown by the client.
com.datastax.astra.client.tables	Top package to interact with Tables.
com.datastax.astra.client.tables.commands	Command Definitions for operating on Tables.
com.datastax.astra.client.tables.commands.options	Options and Inputs for Tables commands.
com.datastax.astra.client.tables.commands.results	Outputs and DTO for Tables Commands.
com.datastax.astra.client.tables.cursor	Objects representing cursors working with find tables commands.
com.datastax.astra.client.tables.definition	Objects describing the structure of a Table.
com.datastax.astra.client.tables.definition.columns	Objects representing Table Columns
com.datastax.astra.client.tables.definition.indexes	Objects representing Table Indexes.
com.datastax.astra.client.tables.definition.rows	Objects representing Table Rows, like primary key.
com.datastax.astra.client.tables.exceptions	Specializations of the exceptions to work with Tables.
com.datastax.astra.client.tables.mapping	Annotations Set to map objects as Row Entities.
com.datastax.astra.internal	Internal technical classes
com.datastax.astra.internal.api	Internal technical classes to marshall API responses
com.datastax.astra.internal.command	Internal technical classes to run commands against the API.
com.datastax.astra.internal.http	Internal technical classes to execute HTTP requests.
com.datastax.astra.internal.reflection	Utilities for reflection at runtime
com.datastax.astra.internal.serdes	Utilities classes for Serialization and Deserialization
com.datastax.astra.internal.serdes.collections	Custom Serializers to work with Collections.
com.datastax.astra.internal.serdes.shared	Custom Serializers applied for both tables and collections.
com.datastax.astra.internal.serdes.tables	Custom Serializers to work with Tables
com.datastax.astra.internal.utils	Internal technical classes for low-level utilities