Example usage:
*
* {@code
@@ -85,7 +93,17 @@ public interface DatabaseAdmin {
* @return
* list of available providers
*/
- FindEmbeddingProvidersResult findEmbeddingProviders();
+ FindEmbeddingProvidersResult findEmbeddingProviders(FindEmbeddingProvidersOptions options);
+
+ /**
+ * Backward compatible method to retrieve the list of embedding providers available in the current database.
+ *
+ * @return
+ * list of available providers with default options
+ */
+ default FindEmbeddingProvidersResult findEmbeddingProviders() {
+ return findEmbeddingProviders(null);
+ }
/**
* Retrieve the list of reranking providers available in the current database. Reranking providers are services
@@ -103,7 +121,17 @@ public interface DatabaseAdmin {
* @return
* list of available providers
*/
- FindRerankingProvidersResult findRerankingProviders();
+ FindRerankingProvidersResult findRerankingProviders(FindRerankingProvidersOptions options);
+
+ /**
+ * Backward compatible method to retrieve the list of reranking providers available in the current database.
+ *
+ * @return
+ * list of available providers with default options
+ */
+ default FindRerankingProvidersResult findRerankingProviders() {
+ return findRerankingProviders(null);
+ }
/**
* Asynchronously retrieves a stream of keyspaces names available in the current database. This method facilitates
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/admin/commands/AstraAvailableRegionInfo.java b/astra-db-java/src/main/java/com/datastax/astra/client/admin/commands/AstraAvailableRegionInfo.java
new file mode 100644
index 00000000..281493e5
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/admin/commands/AstraAvailableRegionInfo.java
@@ -0,0 +1,79 @@
+package com.datastax.astra.client.admin.commands;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 - 2025 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.dtsx.astra.sdk.db.domain.DatabaseRegionServerless;
+import lombok.Data;
+
+/**
+ * Information about an available region for Astra DB.
+ *
+ * This class encapsulates details about a specific region where Astra DB can be deployed,
+ * including the region name, cloud provider, display name, zone, classification, and whether
+ * the region is enabled or reserved for qualified users.
+ *
+ */
+@Data
+public class AstraAvailableRegionInfo {
+
+ /** Region Name. */
+ private String name;
+
+ /** Cloud provider. */
+ private String cloudProvider;
+
+ /** Name of the region picked. */
+ private String displayName;
+
+ /** Zone. */
+ private String zone;
+
+ /** Classification. */
+ private String classification;
+
+ /** working region. */
+ private boolean enabled;
+
+ /** limited ? */
+ private boolean reservedForQualifiedUsers;
+
+ /**
+ * Default Constructor.
+ */
+ public AstraAvailableRegionInfo() {
+ }
+
+ /**
+ * Constructor from DatabaseRegionServerless.
+ *
+ * @param dbRegionServerless
+ * the database region serverless object
+ */
+ public AstraAvailableRegionInfo(DatabaseRegionServerless dbRegionServerless) {
+ this.classification = dbRegionServerless.getClassification();
+ this.cloudProvider = dbRegionServerless.getCloudProvider();
+ this.displayName = dbRegionServerless.getDisplayName();
+ this.enabled = dbRegionServerless.isEnabled();
+ this.name = dbRegionServerless.getName();
+ this.reservedForQualifiedUsers = dbRegionServerless.isReservedForQualifiedUsers();
+ this.zone = dbRegionServerless.getZone();
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/admin/AdminOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/admin/options/AdminOptions.java
similarity index 98%
rename from astra-db-java/src/main/java/com/datastax/astra/client/admin/AdminOptions.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/admin/options/AdminOptions.java
index be5a75ed..0866d8c1 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/admin/AdminOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/admin/options/AdminOptions.java
@@ -1,4 +1,4 @@
-package com.datastax.astra.client.admin;
+package com.datastax.astra.client.admin.options;
/*-
* #%L
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/admin/options/AstraFindAvailableRegionsOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/admin/options/AstraFindAvailableRegionsOptions.java
new file mode 100644
index 00000000..710146de
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/admin/options/AstraFindAvailableRegionsOptions.java
@@ -0,0 +1,50 @@
+package com.datastax.astra.client.admin.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 - 2025 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import lombok.Data;
+
+/**
+ * Options for finding available regions in Astra.
+ * This class allows users to specify whether to filter regions
+ * based on organization enabled status.
+ */
+@Data
+public class AstraFindAvailableRegionsOptions {
+
+ /**
+ * Flag to indicate whether to return only regions enabled for the organization.
+ * Default is true, meaning only organization enabled regions will be returned.
+ */
+ private boolean onlyOrgEnabledRegions = true;
+
+ /**
+ * Constructs an instance of AstraFindAvailableRegionsOptions with default settings.
+ *
+ * @param onlyOrgEnabledRegions
+ * If true, only regions enabled for the organization will be returned.
+ */
+ public AstraFindAvailableRegionsOptions onlyOrgEnabledRegions(boolean onlyOrgEnabledRegions) {
+ this.onlyOrgEnabledRegions = onlyOrgEnabledRegions;
+ return this;
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java
index 4cacb473..c30c8465 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindAndRerankCursor.java
@@ -208,7 +208,7 @@ public CollectionFindAndRerankCursor includeSortVector() {
/**
* {PageState is always null, all is returned here }
*/
- public void fetchNextBatch() {
+ public void fetchNextPage() {
// Only the first time
if (currentPage == null) {
currentPage = dataSource.findAndRerankPage(filter, options, newRowType);
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java
index cee96530..146a740d 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/cursor/CollectionFindCursor.java
@@ -214,7 +214,7 @@ public CollectionFindCursor includeSortVector() {
* Fetches the next batch of documents into the buffer.
* This method handles paging, using the page state from the previous batch to fetch the next one.
*/
- public void fetchNextBatch() {
+ public void fetchNextPage() {
if (currentPage == null) {
// Searching First Page
currentPage = dataSource.findPage(filter, collectionFindOptions, getRecordType());
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/ListCollectionOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/ListCollectionOptions.java
index 635f06f4..c93871c7 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/ListCollectionOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/commands/options/ListCollectionOptions.java
@@ -21,19 +21,38 @@
*/
import com.datastax.astra.client.core.options.BaseOptions;
+import com.datastax.astra.client.core.options.DataAPIClientOptions;
import com.datastax.astra.internal.serdes.collections.DocumentSerializer;
+import lombok.Setter;
+import lombok.experimental.Accessors;
import static com.datastax.astra.client.core.commands.CommandType.COLLECTION_ADMIN;
/**
* Options for the listCollection operation.
*/
+@Setter
+@Accessors(fluent = true, chain = true)
public class ListCollectionOptions extends BaseOptions {
+ /**
+ * The keyspace to use for the database.
+ */
+ String keyspace = DataAPIClientOptions.DEFAULT_KEYSPACE;
+
/**
* Default constructor.
*/
public ListCollectionOptions() {
super(null, COLLECTION_ADMIN, new DocumentSerializer(), null);
}
+
+ /**
+ * Gets keyspace
+ *
+ * @return value of keyspace
+ */
+ public String getKeyspace() {
+ return keyspace;
+ }
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/TimeUUID.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/TimeUUID.java
new file mode 100644
index 00000000..70c3749a
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/TimeUUID.java
@@ -0,0 +1,128 @@
+package com.datastax.astra.client.collections.definition.documents.types;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 - 2025 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.internal.serdes.collections.TimeUUIDSerializer;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import com.fasterxml.uuid.Generators;
+import com.fasterxml.uuid.impl.UUIDUtil;
+
+import java.time.Instant;
+import java.util.UUID;
+
+/**
+ * Represents a time-based UUID (Version 1).
+ *
+ * This class encapsulates a UUID that is generated based on the current time,
+ * allowing for the extraction of the timestamp embedded within the UUID.
+ *
+ *
+ * Example usage:
+ *
+ * {@code
+ * TimeUUID timeUUID = new TimeUUID();
+ * Instant timestamp = timeUUID.readInstant();
+ * }
+ *
+ */
+@JsonSerialize(using = TimeUUIDSerializer.class)
+public class TimeUUID {
+
+ /**
+ * UUID.
+ */
+ private final UUID uuid;
+
+ /**
+ * Default constructor.
+ */
+ public TimeUUID() {
+ // Create a time-based (Version-1) UUID generator
+ this(Generators.timeBasedGenerator().generate());
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param uuid
+ * uuid
+ */
+ public TimeUUID(UUID uuid) {
+ this.uuid = uuid;
+ }
+
+ /**
+ * Constructor.
+ *
+ * @param strUUID
+ * uuid
+ */
+ public TimeUUID(String strUUID) {
+ this(UUID.fromString(strUUID));
+ }
+
+ /**
+ * Return the Java Utils UUID.
+ *
+ * @return
+ * uuid value
+ */
+ public UUID toUUID() {
+ return uuid;
+ }
+
+ /**
+ * Extract the hidden timestamp (100-nanosecond units since UUID epoch).
+ *
+ * @return the raw 60-bit timestamp value embedded in this UUIDv6
+ */
+ public long readTimeStamp() {
+ return UUIDUtil.extractTimestamp(uuid);
+ }
+
+ /**
+ * Get the timestamp as an {@link Instant}.
+ *
+ * @return
+ * the timestamp as an Instant
+ */
+ public Instant readInstant() {
+ return Instant.ofEpochMilli(readTimeStamp());
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public String toString() {
+ return toUUID().toString();
+ }
+
+ /**
+ * Generate from a string.
+ *
+ * @param strUUID
+ * uuid as a String
+ * @return
+ * an instance of UUIDv6
+ */
+ public static UUIDv6 fromString(String strUUID) {
+ return new UUIDv6(strUUID);
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv6.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv6.java
index 8d58e7c2..53550f5b 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv6.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv6.java
@@ -20,13 +20,18 @@
* #L%
*/
+import com.datastax.astra.internal.serdes.collections.UUID6Serializer;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.uuid.Generators;
+import com.fasterxml.uuid.impl.UUIDUtil;
+import java.time.Instant;
import java.util.UUID;
/**
* Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.
*/
+@JsonSerialize(using = UUID6Serializer.class)
public class UUIDv6 {
/**
@@ -51,6 +56,16 @@ public UUIDv6(UUID uuid) {
this.uuid = uuid;
}
+ /**
+ * Constructor.
+ *
+ * @param strUUID
+ * uuid
+ */
+ public UUIDv6(String strUUID) {
+ this(UUID.fromString(strUUID));
+ }
+
/**
* Return the Java Utils UUID.
*
@@ -61,6 +76,25 @@ public UUID toUUID() {
return uuid;
}
+ /**
+ * Extract the hidden timestamp (100-nanosecond units since UUID epoch).
+ *
+ * @return the raw 60-bit timestamp value embedded in this UUIDv6
+ */
+ public long readTimeStamp() {
+ return UUIDUtil.extractTimestamp(uuid);
+ }
+
+ /**
+ * Get the timestamp as an {@link Instant}.
+ *
+ * @return
+ * the timestamp as an Instant
+ */
+ public Instant readInstant() {
+ return Instant.ofEpochMilli(readTimeStamp());
+ }
+
/** {@inheritDoc} */
@Override
public String toString() {
@@ -76,7 +110,7 @@ public String toString() {
* an instance of UUIDv6
*/
public static UUIDv6 fromString(String strUUID) {
- return new UUIDv6(UUID.fromString(strUUID));
+ return new UUIDv6(strUUID);
}
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv7.java b/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv7.java
index 5255161a..60f61672 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv7.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/collections/definition/documents/types/UUIDv7.java
@@ -21,6 +21,7 @@
*/
import com.fasterxml.uuid.Generators;
+import com.fasterxml.uuid.impl.UUIDUtil;
import java.security.SecureRandom;
import java.util.UUID;
@@ -62,6 +63,15 @@ public UUID toUUID() {
return uuid;
}
+ /**
+ * Extract the hidden timestamp (100-nanosecond units since UUID epoch).
+ *
+ * @return the raw 60-bit timestamp value embedded in this UUIDv6
+ */
+ public long getTimeStamp() {
+ return UUIDUtil.extractTimestamp(uuid);
+ }
+
/** {@inheritDoc} */
@Override
public String toString() {
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/core/rerank/RerankProvider.java b/astra-db-java/src/main/java/com/datastax/astra/client/core/rerank/RerankProvider.java
index 30cf2b8b..e9f6cf25 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/core/rerank/RerankProvider.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/core/rerank/RerankProvider.java
@@ -21,6 +21,7 @@
*/
import com.datastax.astra.client.collections.definition.documents.Document;
+import com.datastax.astra.client.core.vectorize.SupportModelStatus;
import lombok.Data;
import java.util.List;
@@ -106,6 +107,9 @@ public static class Model {
private Boolean isDefault;
+ /** Supported model or not */
+ private Map apiModelSupport;
+
/** Parameters for the model. */
private List parameters;
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/core/vectorize/EmbeddingProvider.java b/astra-db-java/src/main/java/com/datastax/astra/client/core/vectorize/EmbeddingProvider.java
index 7066f44a..7dae4985 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/core/vectorize/EmbeddingProvider.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/core/vectorize/EmbeddingProvider.java
@@ -91,6 +91,9 @@ public static class Model {
/** Model name */
private String name;
+ /** Supported model or not */
+ private Map apiModelSupport;
+
/** Model dimension. */
private Integer vectorDimension;
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/core/vectorize/SupportModelStatus.java b/astra-db-java/src/main/java/com/datastax/astra/client/core/vectorize/SupportModelStatus.java
new file mode 100644
index 00000000..77e487bc
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/core/vectorize/SupportModelStatus.java
@@ -0,0 +1,46 @@
+package com.datastax.astra.client.core.vectorize;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 - 2025 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+/**
+ * Enum representing the status of an embedding provider.
+ *
+ * - SUPPORTED: The provider is currently supported and available for use.
+ * - DEPRECATED: The provider is deprecated and may be removed in future versions.
+ * - END_OF_LIFE: The provider has reached its end of life and is no longer supported.
+ */
+public enum SupportModelStatus {
+
+ /**
+ * The provider is currently supported and available for use.
+ */
+ SUPPORTED,
+
+ /**
+ * The provider is deprecated and may be removed in future versions.
+ */
+ DEPRECATED,
+
+ /**
+ * The provider has reached its end of life and is no longer supported.
+ */
+ END_OF_LIFE
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/Database.java b/astra-db-java/src/main/java/com/datastax/astra/client/databases/Database.java
index 2f1054f9..025a3b93 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/databases/Database.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/databases/Database.java
@@ -20,11 +20,11 @@
* #L%
*/
-import com.datastax.astra.client.admin.AdminOptions;
import com.datastax.astra.client.admin.AstraDBAdmin;
import com.datastax.astra.client.admin.AstraDBDatabaseAdmin;
import com.datastax.astra.client.admin.DataAPIDatabaseAdmin;
import com.datastax.astra.client.admin.DatabaseAdmin;
+import com.datastax.astra.client.admin.options.AdminOptions;
import com.datastax.astra.client.collections.Collection;
import com.datastax.astra.client.collections.CollectionOptions;
import com.datastax.astra.client.collections.commands.options.CreateCollectionOptions;
@@ -35,20 +35,26 @@
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.commands.Command;
import com.datastax.astra.client.core.options.DataAPIClientOptions;
-import com.datastax.astra.client.core.vector.SimilarityMetric;
import com.datastax.astra.client.databases.definition.DatabaseInfo;
import com.datastax.astra.client.exceptions.InvalidConfigurationException;
import com.datastax.astra.client.tables.Table;
import com.datastax.astra.client.tables.TableOptions;
+import com.datastax.astra.client.tables.commands.AlterTypeOperation;
+import com.datastax.astra.client.tables.commands.options.AlterTypeOptions;
import com.datastax.astra.client.tables.commands.options.CreateTableOptions;
+import com.datastax.astra.client.tables.commands.options.CreateTypeOptions;
import com.datastax.astra.client.tables.commands.options.CreateVectorIndexOptions;
import com.datastax.astra.client.tables.commands.options.DropTableIndexOptions;
import com.datastax.astra.client.tables.commands.options.DropTableOptions;
+import com.datastax.astra.client.tables.commands.options.DropTypeOptions;
import com.datastax.astra.client.tables.commands.options.ListTablesOptions;
+import com.datastax.astra.client.tables.commands.options.ListTypesOptions;
import com.datastax.astra.client.tables.definition.TableDefinition;
import com.datastax.astra.client.tables.definition.TableDescriptor;
-import com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition;
import com.datastax.astra.client.tables.definition.rows.Row;
+import com.datastax.astra.client.tables.definition.types.TableUserDefinedType;
+import com.datastax.astra.client.tables.definition.types.TableUserDefinedTypeDefinition;
+import com.datastax.astra.client.tables.definition.types.TableUserDefinedTypeDescriptor;
import com.datastax.astra.client.tables.mapping.EntityTable;
import com.datastax.astra.internal.api.AstraApiEndpoint;
import com.datastax.astra.internal.command.AbstractCommandRunner;
@@ -462,6 +468,15 @@ public List listCollectionNames() {
* according to the provided options.
*/
public List listCollectionNames(ListCollectionOptions listCollectionOptions) {
+ // Keyspace is part of the database, a new temporary database object is required.
+ if (listCollectionOptions != null && Utils.hasLength(listCollectionOptions.getKeyspace())) {
+ String otherKeyspace = listCollectionOptions.getKeyspace();
+ listCollectionOptions.keyspace(null);
+ return new Database(
+ this.rootEndpoint,
+ this.options.clone().keyspace(otherKeyspace))
+ .listCollectionNames(listCollectionOptions);
+ }
return runCommand(Command.create("findCollections"), listCollectionOptions)
.getStatusKeyAsStringStream("collections")
.toList();
@@ -523,6 +538,15 @@ public List listCollections() {
* @return A {@link List} of {@link CollectionDescriptor} objects representing the collections that match the criteria.
*/
public List listCollections(ListCollectionOptions listCollectionOptions) {
+ // Keyspace is part of the database, a new temporary database object is required.
+ if (listCollectionOptions != null && Utils.hasLength(listCollectionOptions.getKeyspace())) {
+ String otherKeyspace = listCollectionOptions.getKeyspace();
+ listCollectionOptions.keyspace(null);
+ return new Database(
+ this.rootEndpoint,
+ this.options.clone().keyspace(otherKeyspace))
+ .listCollections(listCollectionOptions);
+ }
Command findCollections = Command.create("findCollections")
.withOptions(new Document().append("explain", true));
return runCommand(findCollections, listCollectionOptions)
@@ -1177,6 +1201,248 @@ public Table getTable(Class rowClass) {
return getTable(ann.value(), rowClass);
}
+ // -------------------------------------
+ // ---- Type and Object Mapping ---
+ // -------------------------------------
+
+ public TableUserDefinedTypeDefinition getType(Class rowClass) {
+ TableUserDefinedType ann = rowClass.getAnnotation(TableUserDefinedType.class);
+ if (ann == null) {
+ InvalidConfigurationException.throwErrorMissingAnnotation(
+ TableUserDefinedType.class.getSimpleName(),
+ rowClass.getName(),
+ "getType(rowClass)");
+ }
+
+ //FIX Es
+ return null;
+ }
+
+ /**
+ * Creates a table using default options and runtime configurations.
+ *
+ * @param the type of the row objects that the table will hold
+ * @param rowClass the class representing the row type; must not be null
+ * @return the created table object
+ */
+ public String getTypeName(Class rowClass) {
+ notNull(rowClass, "typeClass");
+ TableUserDefinedType ann = rowClass.getAnnotation(TableUserDefinedType.class);
+ if (ann == null) {
+ throw new IllegalArgumentException("Class " + rowClass.getName() +
+ " is not annotated with @" + TableUserDefinedType.class.getName());
+ }
+ if (!Utils.hasLength(ann.value())) {
+ throw new IllegalArgumentException("Annotation @Udt on class " + rowClass.getName() + " has no name");
+ }
+ return ann.value();
+ }
+
+ // -------------------------------------
+ // ---- List Types ----
+ // -------------------------------------
+
+ /**
+ * Retrieves the details of all tables in the database with default options.
+ *
+ * @return A list of {@link TableUserDefinedTypeDescriptor} objects representing all tables in the database.
+ *
+ * Example usage:
+ *
+ * {@code
+ * List types = listTypes();
+ * }
+ *
+ */
+ public List listTypes() {
+ return listTypes(null);
+ }
+
+ /**
+ * Retrieves the details of all types in the database.
+ *
+ * @param listTypesOptions Options for filtering or configuring the types listing operation.
+ * @return A list of {@link TableUserDefinedTypeDescriptor} objects representing all tables in the database.
+ */
+ public List listTypes(ListTypesOptions listTypesOptions) {
+ // Keyspace is part of the database, a new temporary database object is required.
+ if (listTypesOptions != null && Utils.hasLength(listTypesOptions.getKeyspace())) {
+ String otherKeyspace = listTypesOptions.getKeyspace();
+ listTypesOptions.keyspace(null);
+ return new Database(
+ this.rootEndpoint,
+ this.options.clone().keyspace(otherKeyspace))
+ .listTypes(listTypesOptions);
+ }
+ Command listTypes = Command
+ .create("listTypes")
+ .withOptions(new Document().append("explain", true));
+ return runCommand(listTypes, listTypesOptions)
+ .getStatusKeyAsList("types", TableUserDefinedTypeDescriptor.class);
+ }
+
+ // -------------------------------------
+ // ---- Create Type ----
+ // -------------------------------------
+
+ /**
+ * Creates a user defined type in the system with the specified parameters.
+ *
+ * @param typeName the name of the type to be created; must not be null or empty
+ * @param typeDefinition the schema definition of the type; must not be null
+ * @param createTypeOptions additional options for creating the type; optional, can be null
+ * @throws IllegalArgumentException if any mandatory argument is null or invalid
+ *
+ * Example usage:
+ *
+ * {@code
+ * TypeDefinition typeDefinition = new TypeDefinition()
+ * .addField("field1", FieldTypes.TEXT)
+ * .addField("field2", FieldTypes.INT);
+ *
+ * db.createType("MyType", typeDefinition, new CreateTypeOptions());
+ * }
+ *
+ */
+ public void createType(String typeName, TableUserDefinedTypeDefinition typeDefinition, CreateTypeOptions createTypeOptions) {
+ hasLength(typeName, "typeName");
+ notNull(typeDefinition, "typeDefinition");
+
+ // We are on a different keyspace, create the table on that keyspace
+ if (createTypeOptions != null && Utils.hasLength(createTypeOptions.getKeyspace())) {
+ String otherKeyspace = createTypeOptions.getKeyspace();
+ createTypeOptions.keyspace(null);
+ new Database(
+ this.rootEndpoint,
+ this.options.clone().keyspace(otherKeyspace))
+ .createType(typeName, typeDefinition, createTypeOptions);
+ }
+
+ Command createType = Command
+ .create("createType")
+ .append("name", typeName)
+ .append("definition", typeDefinition);
+ if (createTypeOptions != null) {
+ createType.append("options", createTypeOptions);
+ }
+ runCommand(createType, createTypeOptions);
+
+ }
+
+ /**
+ * Creates a table with a default row type of {@code Row}.
+ *
+ * @param typeName the name of the table to be created; must not be null or empty
+ * @param tableUserDefinedTypeDefinition the schema definition of the type; must not be null
+ *
+ */
+ public void createType(String typeName, TableUserDefinedTypeDefinition tableUserDefinedTypeDefinition) {
+ createType(typeName, tableUserDefinedTypeDefinition, new CreateTypeOptions().ifNotExists(true));
+ }
+
+ public void createType(Class UdtBean, CreateTypeOptions createTypeOptions) {
+ notNull(UdtBean, "udtDefinition");
+ TableUserDefinedType ann = UdtBean.getAnnotation(TableUserDefinedType.class);
+ Command createTypeCmd = new Command("createType", EntityBeanDefinition.createTypeCommand(UdtBean));
+ if (createTypeOptions != null) {
+ createTypeCmd.append("options", createTypeOptions);
+ }
+ runCommand(createTypeCmd);
+ }
+
+ // -------------------------------------
+ // ---- Drop Type ----
+ // -------------------------------------
+
+ /**
+ * Deletes a type from the database.
+ * This method delegates to {@link #dropType(String, DropTypeOptions)}
+ * with default options.
+ *
+ * @param udtName
+ * the name of the type to be deleted; must not be null or empty.
+ * @throws IllegalArgumentException
+ * if {@code udtName} is null or empty.
+ *
+ * Example usage:
+ *
+ * {@code
+ * database.dropType("exampleUdt");
+ * }
+ *
+ */
+ public void dropType(String udtName) {
+ dropType(udtName, null);
+ }
+
+ /**
+ * Deletes a type (UDT) from the database with specific options.
+ *
+ * @param udtName
+ * the name of the user defined type to be deleted; must not be null or empty.
+ * @param dropTypeOptions
+ * the options to configure the type deletion operation; can be null.
+ * @throws IllegalArgumentException
+ * if {@code udtName} is null or empty.
+ *
+ * Example usage:
+ *
+ * {@code
+ * DropTypeOptions options = new DropTypeOptions();
+ * database.dropType("exampleUdt", options);
+ * }
+ *
+ */
+ public void dropType(String udtName, DropTypeOptions dropTypeOptions) {
+ hasLength(udtName, "udtName");
+
+ // We are on a different keyspace, drop the table on a different keyspace
+ if (dropTypeOptions != null && Utils.hasLength(dropTypeOptions.getKeyspace())) {
+ String otherKeyspace = dropTypeOptions.getKeyspace();
+ dropTypeOptions.keyspace(null);
+ new Database(
+ this.rootEndpoint,
+ this.options.clone().keyspace(otherKeyspace))
+ .dropType(udtName, dropTypeOptions);
+ } else {
+ // Command on current keyspace
+ Command dropTypeCmd = Command
+ .create("dropType")
+ .append("name", udtName);
+ if (dropTypeOptions != null) {
+ dropTypeCmd.withOptions(dropTypeOptions);
+ }
+ runCommand(dropTypeCmd, dropTypeOptions);
+ }
+ }
+
+ // -------------------------------------
+ // ---- Alter Type ----
+ // -------------------------------------
+
+ /**
+ * Performs an alteration operation on the table with default options.
+ *
+ * This method delegates to {@link #alterType(String, AlterTypeOperation, AlterTypeOptions)}
+ * with {@code options} set to {@code null}.
+ *
+ * @param udtName
+ * name of the user defined type to be altered; must not be null or empty.
+ * @param operation
+ * the alteration operation to be performed; must not be {@code null}.
+ */
+ public final void alterType(String udtName, AlterTypeOperation operation) {
+ alterType(udtName, operation, null);
+ }
+
+ public final void alterType(String udtName, AlterTypeOperation operation, AlterTypeOptions alterTypeOptions) {
+ notNull(operation, "operation");
+ Command alterType = Command.create("alterType")
+ .append("name", udtName)
+ .append(operation.getOperationName(), Map.of("fields", operation.getFields()));
+ runCommand(alterType, alterTypeOptions);
+ }
+
// -------------------------------------
// ---- Create Table ----
// -------------------------------------
@@ -1397,7 +1663,7 @@ public String getTableName(Class rowClass) {
notNull(rowClass, "rowClass");
EntityTable ann = rowClass.getAnnotation(EntityTable.class);
if (ann == null) {
- throw new IllegalArgumentException("Class " + rowClass.getName() + " is not annotated with @Table");
+ throw new IllegalArgumentException("Class " + rowClass.getName() + " is not annotated with "+ EntityTable.class.getName());
}
if (!Utils.hasLength(ann.value())) {
throw new IllegalArgumentException("Annotation @Table on class " + rowClass.getName() + " has no name");
@@ -1434,7 +1700,7 @@ private CollectionOptions defaultCollectionOptions() {
// -------------------------------------
/**
- * Deletes a collection (table) from the database.
+ * Deletes a table from the database.
* This method delegates to {@link #dropTable(String, DropTableOptions)}
* with default options.
*
@@ -1494,6 +1760,7 @@ public void dropTable(String tableName, DropTableOptions dropTableOptions) {
runCommand(dropTableCmd, dropTableOptions);
}
}
+
// ------------------------------------------
// ---- Drop Indexes ---
// ------------------------------------------
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/CreateKeyspaceOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/CreateKeyspaceOptions.java
index 2b78b536..cbac887f 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/CreateKeyspaceOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/CreateKeyspaceOptions.java
@@ -20,16 +20,12 @@
* #L%
*/
-import com.datastax.astra.client.admin.AdminOptions;
+import com.datastax.astra.client.admin.options.AdminOptions;
import com.datastax.astra.client.core.commands.CommandType;
import com.datastax.astra.client.core.options.BaseOptions;
-import com.datastax.astra.client.core.options.DataAPIClientOptions;
-import lombok.Getter;
import lombok.Setter;
import lombok.experimental.Accessors;
-import static com.datastax.astra.client.tables.Table.DEFAULT_TABLE_SERIALIZER;
-
/**
* Set of options used when creating a table
*/
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/DropKeyspaceOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/DropKeyspaceOptions.java
index d93fe2b2..dea41370 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/DropKeyspaceOptions.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/DropKeyspaceOptions.java
@@ -20,14 +20,12 @@
* #L%
*/
-import com.datastax.astra.client.admin.AdminOptions;
+import com.datastax.astra.client.admin.options.AdminOptions;
import com.datastax.astra.client.core.commands.CommandType;
import com.datastax.astra.client.core.options.BaseOptions;
import lombok.Setter;
import lombok.experimental.Accessors;
-import static com.datastax.astra.client.tables.Table.DEFAULT_TABLE_SERIALIZER;
-
/**
* Set of options used when creating a table
*/
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/FindEmbeddingProvidersOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/FindEmbeddingProvidersOptions.java
new file mode 100644
index 00000000..bec34db8
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/FindEmbeddingProvidersOptions.java
@@ -0,0 +1,56 @@
+package com.datastax.astra.client.databases.commands.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 - 2025 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.admin.options.AdminOptions;
+import com.datastax.astra.client.core.commands.CommandType;
+import com.datastax.astra.client.core.options.BaseOptions;
+import com.datastax.astra.client.core.vectorize.SupportModelStatus;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+@Setter
+@Accessors(fluent = true, chain = true)
+public class FindEmbeddingProvidersOptions extends BaseOptions {
+
+ /**
+ * Condition to upsert the table.
+ */
+ SupportModelStatus filterModelStatus = null;
+
+ /**
+ * Default constructor
+ */
+ public FindEmbeddingProvidersOptions() {
+ super(null, CommandType.DATABASE_ADMIN, AdminOptions.DEFAULT_SERIALIZER, null);
+ }
+
+ /**
+ * Accessor for serialization.
+ *
+ * @return
+ * accessor for serialization
+ */
+ public SupportModelStatus getFilterModelStatus() {
+ return this.filterModelStatus;
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/FindRerankingProvidersOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/FindRerankingProvidersOptions.java
new file mode 100644
index 00000000..05fb805d
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/databases/commands/options/FindRerankingProvidersOptions.java
@@ -0,0 +1,56 @@
+package com.datastax.astra.client.databases.commands.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 - 2025 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.admin.options.AdminOptions;
+import com.datastax.astra.client.core.commands.CommandType;
+import com.datastax.astra.client.core.options.BaseOptions;
+import com.datastax.astra.client.core.vectorize.SupportModelStatus;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+@Setter
+@Accessors(fluent = true, chain = true)
+public class FindRerankingProvidersOptions extends BaseOptions {
+
+ /**
+ * Condition to upsert the table.
+ */
+ SupportModelStatus filterModelStatus = null;
+
+ /**
+ * Default constructor
+ */
+ public FindRerankingProvidersOptions() {
+ super(null, CommandType.DATABASE_ADMIN, AdminOptions.DEFAULT_SERIALIZER, null);
+ }
+
+ /**
+ * Accessor for serialization.
+ *
+ * @return
+ * accessor for serialization
+ */
+ public SupportModelStatus getFilterModelStatus() {
+ return this.filterModelStatus;
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/Table.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/Table.java
index c8801114..df384ae9 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/Table.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/Table.java
@@ -54,6 +54,7 @@
import com.datastax.astra.client.tables.definition.TableDefinition;
import com.datastax.astra.client.tables.definition.TableDescriptor;
import com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor;
+import com.datastax.astra.client.tables.definition.indexes.TableIndexMapTypes;
import com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition;
import com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition;
import com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition;
@@ -322,6 +323,20 @@ public void createIndex(String idxName, String columnName) {
createIndex(idxName, new TableRegularIndexDefinition().column(columnName), null);
}
+ /**
+ * Create a simple index on the given column with no special options
+ *
+ * @param idxName
+ * name of the index
+ * @param columnName
+ * column on which is the index
+ * @param type
+ * column type for the index, used for Map columns
+ */
+ public void createIndex(String idxName, String columnName, TableIndexMapTypes type) {
+ createIndex(idxName, new TableRegularIndexDefinition().column(columnName, type), null);
+ }
+
/**
* Create a simple index on the given column with no special options
*
@@ -336,6 +351,20 @@ public void createIndex(String idxName, String columnName, CreateIndexOptions id
createIndex(idxName, new TableRegularIndexDefinition().column(columnName), idxOptions);
}
+ /**
+ * Create a simple index on the given column with no special options
+ *
+ * @param idxName
+ * name of the index
+ * @param columnName
+ * column on which is the index
+ * @param type
+ * column type for the index, used for Map columns
+ */
+ public void createIndex(String idxName, String columnName, TableIndexMapTypes type, CreateIndexOptions idxOptions) {
+ createIndex(idxName, new TableRegularIndexDefinition().column(columnName, type), idxOptions);
+ }
+
/**
* Create a new index with the given description.
*
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTableAddColumns.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTableAddColumns.java
index 648c89fe..c3e8b5e0 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTableAddColumns.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTableAddColumns.java
@@ -20,20 +20,17 @@
* #L%
*/
-import com.datastax.astra.client.core.commands.CommandType;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinition;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionList;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionMap;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionSet;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionVector;
-import com.datastax.astra.client.tables.definition.columns.ColumnTypes;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionList;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionMap;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionSet;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionVector;
+import com.datastax.astra.client.tables.definition.columns.TableColumnTypes;
import lombok.Getter;
import lombok.Setter;
import java.util.LinkedHashMap;
-import static com.datastax.astra.client.tables.Table.DEFAULT_TABLE_SERIALIZER;
-
/**
* Represents an operation to add columns to an existing table in a database schema.
* This class implements the {@link AlterTableOperation} interface, providing functionality
@@ -64,7 +61,7 @@ public final class AlterTableAddColumns implements AlterTableOperation {
* A map of column names to their definitions.
* The map preserves the order of added columns.
*/
- LinkedHashMap columns = new LinkedHashMap<>();
+ LinkedHashMap columns = new LinkedHashMap<>();
/**
* Constructs a new {@code AlterTableAddColumns} instance.
@@ -90,19 +87,19 @@ public String getOperationName() {
* @param type the type of the column.
* @return the current instance for chaining.
*/
- public AlterTableAddColumns addColumn(String name, ColumnTypes type) {
- columns.put(name, new ColumnDefinition(type));
+ public AlterTableAddColumns addColumn(String name, TableColumnTypes type) {
+ columns.put(name, new TableColumnDefinition(type));
return this;
}
/**
- * Adds a column defined by a {@link ColumnDefinitionVector}.
+ * Adds a column defined by a {@link TableColumnDefinitionVector}.
*
* @param name the name of the column.
* @param cdv the column definition vector.
* @return the current instance for chaining.
*/
- public AlterTableAddColumns addColumnVector(String name, ColumnDefinitionVector cdv) {
+ public AlterTableAddColumns addColumnVector(String name, TableColumnDefinitionVector cdv) {
columns.put(name, cdv);
return this;
}
@@ -114,7 +111,7 @@ public AlterTableAddColumns addColumnVector(String name, ColumnDefinitionVector
* @return the current instance for chaining.
*/
public AlterTableAddColumns addColumnText(String name) {
- return addColumn(name, ColumnTypes.TEXT);
+ return addColumn(name, TableColumnTypes.TEXT);
}
/**
@@ -124,7 +121,7 @@ public AlterTableAddColumns addColumnText(String name) {
* @return the current instance for chaining.
*/
public AlterTableAddColumns addColumnInt(String name) {
- return addColumn(name, ColumnTypes.INT);
+ return addColumn(name, TableColumnTypes.INT);
}
/**
@@ -134,7 +131,7 @@ public AlterTableAddColumns addColumnInt(String name) {
* @return the current instance for chaining.
*/
public AlterTableAddColumns addColumnBoolean(String name) {
- return addColumn(name, ColumnTypes.BOOLEAN);
+ return addColumn(name, TableColumnTypes.BOOLEAN);
}
/**
@@ -144,8 +141,8 @@ public AlterTableAddColumns addColumnBoolean(String name) {
* @param valueType the type of the values in the list.
* @return the current instance for chaining.
*/
- public AlterTableAddColumns addColumnList(String name, ColumnTypes valueType) {
- columns.put(name, new ColumnDefinitionList(valueType));
+ public AlterTableAddColumns addColumnList(String name, TableColumnTypes valueType) {
+ columns.put(name, new TableColumnDefinitionList(valueType));
return this;
}
@@ -156,8 +153,8 @@ public AlterTableAddColumns addColumnList(String name, ColumnTypes valueType) {
* @param valueType the type of the values in the set.
* @return the current instance for chaining.
*/
- public AlterTableAddColumns addColumnSet(String name, ColumnTypes valueType) {
- columns.put(name, new ColumnDefinitionSet(valueType));
+ public AlterTableAddColumns addColumnSet(String name, TableColumnTypes valueType) {
+ columns.put(name, new TableColumnDefinitionSet(valueType));
return this;
}
@@ -169,8 +166,8 @@ public AlterTableAddColumns addColumnSet(String name, ColumnTypes valueType) {
* @param valueType the type of the values in the map.
* @return the current instance for chaining.
*/
- public AlterTableAddColumns addColumnMap(String name, ColumnTypes keyType, ColumnTypes valueType) {
- columns.put(name, new ColumnDefinitionMap(keyType, valueType));
+ public AlterTableAddColumns addColumnMap(String name, TableColumnTypes keyType, TableColumnTypes valueType) {
+ columns.put(name, new TableColumnDefinitionMap(keyType, valueType));
return this;
}
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeAddFields.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeAddFields.java
new file mode 100644
index 00000000..d19be1c3
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeAddFields.java
@@ -0,0 +1,58 @@
+package com.datastax.astra.client.tables.commands;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.tables.definition.types.TableUserDefinedTypeFieldDefinition;
+import com.datastax.astra.client.tables.definition.types.TableUserDefinedTypeFieldTypes;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * Represents an operation to add columns to an existing table in a database schema.
+ * This class implements the {@link AlterTableOperation} interface, providing functionality
+ * to define new columns and their types for the "alter table add" operation.
+ *
+ * Example usage:
+ *
+ * {@code
+ * AlterTypeAddFields operation = new AlterTypeAddFields()
+ * .addField("name", ColumnTypes.TEXT)
+ * .addFieldInt("age");
+ * }
+ *
+ *
+ * Key Features:
+ *
+ * - Supports adding fields with various data types
+ * - Chainable methods for building operations fluently.
+ *
+ */
+@Setter @Getter
+public final class AlterTypeAddFields extends AlterTypeOperation {
+
+ /**
+ * Constructs a new {@code AlterTableAddColumns} instance.
+ */
+ public AlterTypeAddFields() {
+ super("add");
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeOperation.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeOperation.java
new file mode 100644
index 00000000..1bed352a
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeOperation.java
@@ -0,0 +1,87 @@
+package com.datastax.astra.client.tables.commands;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.internal.serdes.tables.AlterTypeOperationSerializer;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+import lombok.Getter;
+
+import java.util.LinkedHashMap;
+
+/**
+ * Represents a generic operation to alter a type schema.
+ * This interface provides a contract for implementing specific schema alteration operations.
+ *
+ * Implementations of this interface must define the name of the operation.
+ *
+ *
+ * Example usage:
+ *
+ * {@code
+ * AlterTypeOperation operation = new AlterTypeOperation();
+ * String operationName = operation.getOperationName();
+ * }
+ *
+ *
+ * @param
+ * the type of the fields in the operation.
+ * @param
+ * the type of the operation itself, used for method chaining.
+ */
+@Getter
+@JsonSerialize(using = AlterTypeOperationSerializer.class)
+public abstract class AlterTypeOperation> {
+
+ /**
+ * The Operation name.
+ */
+ final String operationName;
+
+ /**
+ * A map of column names to their definitions.
+ * The map preserves the order of added columns.
+ */
+ LinkedHashMap fields = new LinkedHashMap<>();
+
+ /**
+ * Gets the name of the operation.
+ *
+ * @param operationName
+ * the name of the operation.
+ */
+ public AlterTypeOperation(String operationName) {
+ this.operationName = operationName;
+ }
+
+ /**
+ * Adds a column with the specified name and type to the table.
+ *
+ * @param name the name of the column.
+ * @param type the type of the column.
+ * @return the current instance for chaining.
+ */
+ @SuppressWarnings("unchecked")
+ public T addField(String name, FIELD_TYPE type) {
+ fields.put(name, type);
+ return (T) this;
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeRenameFields.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeRenameFields.java
new file mode 100644
index 00000000..740ebd27
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/AlterTypeRenameFields.java
@@ -0,0 +1,44 @@
+package com.datastax.astra.client.tables.commands;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.tables.definition.types.TableUserDefinedTypeFieldDefinition;
+
+import java.util.LinkedHashMap;
+
+/**
+ * Represents an operation to rename columns in a database table.
+ * This class implements the {@link AlterTableOperation} interface,
+ * providing the functionality to return the operation name as "rename".
+ *
+ * This operation is typically used to rename one or more columns in a table
+ * during schema alterations.
+ */
+public class AlterTypeRenameFields extends AlterTypeOperation {
+
+ /**
+ * Constructs a new {@code AlterTableAddColumns} instance.
+ */
+ public AlterTypeRenameFields() {
+ super("rename");
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/AlterTypeOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/AlterTypeOptions.java
new file mode 100644
index 00000000..d558cef3
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/AlterTypeOptions.java
@@ -0,0 +1,56 @@
+package com.datastax.astra.client.tables.commands.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.core.commands.CommandType;
+import com.datastax.astra.client.core.options.BaseOptions;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+import static com.datastax.astra.client.tables.Table.DEFAULT_TABLE_SERIALIZER;
+
+/**
+ * Represents options for altering a type in a database schema.
+ * Extends {@link BaseOptions} to provide additional functionality for type alteration commands.
+ *
+ * This class supports a fluent, chainable API using the {@link Accessors} annotation.
+ *
+ *
+ * Example usage:
+ *
+ * {@code
+ * AlterTypeOptions options = new AlterTypeOptions();
+ * }
+ *
+ */
+@Setter
+@Accessors(fluent = true, chain = true)
+public class AlterTypeOptions extends BaseOptions {
+
+ /**
+ * Constructs a new {@code AlterTypeOptions} instance with default settings.
+ * Initializes the options with {@link CommandType#TABLE_ADMIN} and the default table serializer.
+ */
+ public AlterTypeOptions() {
+ super(null, CommandType.TABLE_ADMIN, DEFAULT_TABLE_SERIALIZER, null);
+ }
+}
+
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/CreateTypeOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/CreateTypeOptions.java
new file mode 100644
index 00000000..1bb5193e
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/CreateTypeOptions.java
@@ -0,0 +1,77 @@
+package com.datastax.astra.client.tables.commands.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.core.commands.CommandType;
+import com.datastax.astra.client.core.options.BaseOptions;
+import com.datastax.astra.client.core.options.DataAPIClientOptions;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+import static com.datastax.astra.client.tables.Table.DEFAULT_TABLE_SERIALIZER;
+
+/**
+ * Set of options used when creating a table
+ */
+@Setter
+@Accessors(fluent = true, chain = true)
+public class CreateTypeOptions extends BaseOptions {
+
+ /** Improve syntax. */
+ public static final CreateTypeOptions IF_NOT_EXISTS = new CreateTypeOptions().ifNotExists(true);
+
+ /**
+ * The keyspace to use for the database.
+ */
+ String keyspace = DataAPIClientOptions.DEFAULT_KEYSPACE;
+
+ /**
+ * Condition to upsert the table.
+ */
+ boolean ifNotExists = true;
+
+ /**
+ * Default constructor
+ */
+ public CreateTypeOptions() {
+ super(null, CommandType.TABLE_ADMIN, DEFAULT_TABLE_SERIALIZER, null);
+ }
+
+ /**
+ * Accessor for serialization.
+ *
+ * @return
+ * accessor for serialization
+ */
+ public boolean isIfNotExists() {
+ return ifNotExists;
+ }
+
+ /**
+ * Gets keyspace
+ *
+ * @return value of keyspace
+ */
+ public String getKeyspace() {
+ return keyspace;
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/DropTypeOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/DropTypeOptions.java
new file mode 100644
index 00000000..43eeee11
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/DropTypeOptions.java
@@ -0,0 +1,74 @@
+package com.datastax.astra.client.tables.commands.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.core.options.BaseOptions;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+import static com.datastax.astra.client.core.commands.CommandType.TABLE_ADMIN;
+import static com.datastax.astra.client.tables.Table.DEFAULT_TABLE_SERIALIZER;
+
+/**
+ * Options for dropping a table.
+ */
+@Setter
+@Accessors(fluent = true, chain = true)
+public class DropTypeOptions extends BaseOptions {
+
+ /** Improve syntax. */
+ public static final DropTypeOptions IF_EXISTS = new DropTypeOptions().ifExists(true);
+
+ private String keyspace;
+
+ /**
+ * Condition to upsert the table.
+ */
+ boolean ifExists = true;
+
+ /**
+ * Default constructor
+ */
+ public DropTypeOptions() {
+ super(null, TABLE_ADMIN, DEFAULT_TABLE_SERIALIZER, null);
+ }
+
+ /**
+ * Accessor for serialization.
+ *
+ * @return
+ * accessor for serialization
+ */
+ public boolean isIfExists() {
+ return ifExists;
+ }
+
+ /**
+ * Gets keyspace
+ *
+ * @return value of keyspace
+ */
+ @JsonIgnore
+ public String getKeyspace() {
+ return keyspace;
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/ListTypesOptions.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/ListTypesOptions.java
new file mode 100644
index 00000000..ac0059b5
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/options/ListTypesOptions.java
@@ -0,0 +1,58 @@
+package com.datastax.astra.client.tables.commands.options;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.core.options.BaseOptions;
+import com.datastax.astra.client.core.options.DataAPIClientOptions;
+import com.datastax.astra.internal.serdes.tables.RowSerializer;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+
+import static com.datastax.astra.client.core.commands.CommandType.TABLE_ADMIN;
+
+/**
+ * Options for listing tables.
+ */
+@Setter
+@Accessors(fluent = true, chain = true)
+public class ListTypesOptions extends BaseOptions {
+
+ /**
+ * The keyspace to use for the database.
+ */
+ String keyspace = DataAPIClientOptions.DEFAULT_KEYSPACE;
+
+ /**
+ * Default constructor
+ */
+ public ListTypesOptions() {
+ super(null, TABLE_ADMIN, new RowSerializer(), null);
+ }
+
+ /**
+ * Gets keyspace
+ *
+ * @return value of keyspace
+ */
+ public String getKeyspace() {
+ return keyspace;
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertManyResult.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertManyResult.java
index 6812be36..7245a14e 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertManyResult.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertManyResult.java
@@ -22,7 +22,7 @@
import com.datastax.astra.client.collections.definition.documents.Document;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;
@@ -43,7 +43,7 @@ public class TableInsertManyResult {
ArrayList> insertedIds;
/** Schema on the response. */
- LinkedHashMap primaryKeySchema;
+ LinkedHashMap primaryKeySchema;
/** Document Response with flag is there. */
List documentResponses;
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertOneResult.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertOneResult.java
index a913f966..1c705340 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertOneResult.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/commands/results/TableInsertOneResult.java
@@ -20,7 +20,7 @@
* #L%
*/
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
import com.datastax.astra.client.tables.definition.rows.Row;
import lombok.AllArgsConstructor;
import lombok.Data;
@@ -46,9 +46,9 @@ public class TableInsertOneResult {
/**
* The schema of the primary key as a map, where keys are column names and values are
- * {@link ColumnDefinition} objects describing the column details.
+ * {@link TableColumnDefinition} objects describing the column details.
*/
- private LinkedHashMap primaryKeySchema;
+ private LinkedHashMap primaryKeySchema;
/**
* No-argument constructor that initializes {@code insertedId} to an empty {@link ArrayList}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/cursor/TableFindCursor.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/cursor/TableFindCursor.java
index 560f7bbd..fef98191 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/cursor/TableFindCursor.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/cursor/TableFindCursor.java
@@ -206,7 +206,7 @@ public TableFindCursor includeSortVector() {
* Fetches the next batch of documents into the buffer.
* This method handles paging, using the page state from the previous batch to fetch the next one.
*/
- public void fetchNextBatch() {
+ public void fetchNextPage() {
if (currentPage == null) {
// Searching First Page
currentPage = dataSource.findPage(filter, tableFindOptions, getRecordType());
@@ -216,6 +216,8 @@ public void fetchNextBatch() {
tableFindOptions.pageState(currentPage.getPageState().get());
currentPage = dataSource.findPage(filter, tableFindOptions, getRecordType());
buffer.addAll(currentPage.getResults());
+ } else {
+ // Error ?
}
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/TableDefinition.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/TableDefinition.java
index 3a7663fe..a5842410 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/TableDefinition.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/TableDefinition.java
@@ -21,12 +21,12 @@
*/
import com.datastax.astra.client.core.query.Sort;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinition;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionList;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionMap;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionSet;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinitionVector;
-import com.datastax.astra.client.tables.definition.columns.ColumnTypes;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionList;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionMap;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionSet;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionVector;
+import com.datastax.astra.client.tables.definition.columns.TableColumnTypes;
import com.datastax.astra.internal.serdes.tables.RowSerializer;
import com.datastax.astra.internal.utils.Assert;
import lombok.Data;
@@ -43,7 +43,7 @@ public class TableDefinition {
/**
* The columns of the table.
*/
- private LinkedHashMap columns = new LinkedHashMap<>();
+ private LinkedHashMap columns = new LinkedHashMap<>();
/**
* The primary key of the table.
@@ -64,7 +64,7 @@ public TableDefinition() {
* @return the updated {@link TableDefinition} instance
* @throws IllegalArgumentException if {@code columnName} is null
*/
- public TableDefinition addColumn(String columnName, ColumnDefinition columnDefinition) {
+ public TableDefinition addColumn(String columnName, TableColumnDefinition columnDefinition) {
Assert.notNull(columnName, "Column columnName");
columns.put(columnName, columnDefinition);
return this;
@@ -77,11 +77,21 @@ public TableDefinition addColumn(String columnName, ColumnDefinition columnDefin
* @param type the type of the column
* @return the updated {@link TableDefinition} instance
*/
- public TableDefinition addColumn(String name, ColumnTypes type) {
- columns.put(name, new ColumnDefinition(type));
+ public TableDefinition addColumn(String name, TableColumnTypes type) {
+ columns.put(name, new TableColumnDefinition(type));
return this;
}
+ /**
+ * Adds a UUID column to the table.
+ *
+ * @param name the name of the column
+ * @return the updated {@link TableDefinition} instance
+ */
+ public TableDefinition addColumnUuid(String name) {
+ return addColumn(name, TableColumnTypes.UUID);
+ }
+
/**
* Adds a text column to the table.
*
@@ -89,7 +99,7 @@ public TableDefinition addColumn(String name, ColumnTypes type) {
* @return the updated {@link TableDefinition} instance
*/
public TableDefinition addColumnText(String name) {
- return addColumn(name, ColumnTypes.TEXT);
+ return addColumn(name, TableColumnTypes.TEXT);
}
/**
@@ -99,7 +109,7 @@ public TableDefinition addColumnText(String name) {
* @return the updated {@link TableDefinition} instance
*/
public TableDefinition addColumnAscii(String name) {
- return addColumn(name, ColumnTypes.ASCII);
+ return addColumn(name, TableColumnTypes.ASCII);
}
/**
@@ -109,7 +119,7 @@ public TableDefinition addColumnAscii(String name) {
* @return the updated {@link TableDefinition} instance
*/
public TableDefinition addColumnInt(String name) {
- return addColumn(name, ColumnTypes.INT);
+ return addColumn(name, TableColumnTypes.INT);
}
/**
@@ -119,7 +129,7 @@ public TableDefinition addColumnInt(String name) {
* @return the updated {@link TableDefinition} instance
*/
public TableDefinition addColumnTimestamp(String name) {
- return addColumn(name, ColumnTypes.TIMESTAMP);
+ return addColumn(name, TableColumnTypes.TIMESTAMP);
}
/**
@@ -129,7 +139,7 @@ public TableDefinition addColumnTimestamp(String name) {
* @return the updated {@link TableDefinition} instance
*/
public TableDefinition addColumnBoolean(String name) {
- return addColumn(name, ColumnTypes.BOOLEAN);
+ return addColumn(name, TableColumnTypes.BOOLEAN);
}
/**
@@ -139,7 +149,7 @@ public TableDefinition addColumnBoolean(String name) {
* @return the updated {@link TableDefinition} instance
*/
public TableDefinition addColumnBigInt(String name) {
- return addColumn(name, ColumnTypes.BIGINT);
+ return addColumn(name, TableColumnTypes.BIGINT);
}
/**
@@ -149,7 +159,7 @@ public TableDefinition addColumnBigInt(String name) {
* @return the updated {@link TableDefinition} instance
*/
public TableDefinition addColumnBlob(String name) {
- return addColumn(name, ColumnTypes.BLOB);
+ return addColumn(name, TableColumnTypes.BLOB);
}
/**
@@ -159,8 +169,8 @@ public TableDefinition addColumnBlob(String name) {
* @param valueType the type of the elements in the list
* @return the updated {@link TableDefinition} instance
*/
- public TableDefinition addColumnList(String name, ColumnTypes valueType) {
- columns.put(name, new ColumnDefinitionList(valueType));
+ public TableDefinition addColumnList(String name, TableColumnTypes valueType) {
+ columns.put(name, new TableColumnDefinitionList(valueType));
return this;
}
@@ -171,8 +181,8 @@ public TableDefinition addColumnList(String name, ColumnTypes valueType) {
* @param valueType the type of the elements in the set
* @return the updated {@link TableDefinition} instance
*/
- public TableDefinition addColumnSet(String name, ColumnTypes valueType) {
- columns.put(name, new ColumnDefinitionSet(valueType));
+ public TableDefinition addColumnSet(String name, TableColumnTypes valueType) {
+ columns.put(name, new TableColumnDefinitionSet(valueType));
return this;
}
@@ -184,8 +194,8 @@ public TableDefinition addColumnSet(String name, ColumnTypes valueType) {
* @param valueType the type of the values in the map
* @return the updated {@link TableDefinition} instance
*/
- public TableDefinition addColumnMap(String name, ColumnTypes keyType, ColumnTypes valueType) {
- columns.put(name, new ColumnDefinitionMap(keyType, valueType));
+ public TableDefinition addColumnMap(String name, TableColumnTypes keyType, TableColumnTypes valueType) {
+ columns.put(name, new TableColumnDefinitionMap(keyType, valueType));
return this;
}
@@ -196,7 +206,7 @@ public TableDefinition addColumnMap(String name, ColumnTypes keyType, ColumnType
* @param colDefVector the definition of the vector column
* @return the updated {@link TableDefinition} instance
*/
- public TableDefinition addColumnVector(String name, ColumnDefinitionVector colDefVector) {
+ public TableDefinition addColumnVector(String name, TableColumnDefinitionVector colDefVector) {
columns.put(name, colDefVector);
return this;
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinition.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinition.java
similarity index 82%
rename from astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinition.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinition.java
index d660ebdc..26717090 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinition.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinition.java
@@ -22,9 +22,6 @@
import com.datastax.astra.internal.serdes.tables.RowSerializer;
import lombok.Data;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
-import lombok.Setter;
/**
* Represents a column definition in a database schema.
@@ -39,8 +36,8 @@
*
* Fields:
*
- * - {@code type} - Specifies the type of the column, represented by {@link ColumnTypes}.
- * - {@code apiSupport} - Provides API support details for the column, defined by {@link ColumnDefinitionApiSupport}.
+ * - {@code type} - Specifies the type of the column, represented by {@link TableColumnTypes}.
+ * - {@code apiSupport} - Provides API support details for the column, defined by {@link TableColumnDefinitionApiSupport}.
*
*
* Constructors:
@@ -64,16 +61,22 @@
*
*/
@Data
-public class ColumnDefinition {
+public class TableColumnDefinition {
- private ColumnTypes type;
+ /**
+ * The type of the column.
+ */
+ private TableColumnTypes type;
- private ColumnDefinitionApiSupport apiSupport;
+ /**
+ * API support details for the column when not fully supported by the Data API.
+ */
+ private TableColumnDefinitionApiSupport apiSupport;
/**
* Default constructor.
*/
- public ColumnDefinition() {
+ public TableColumnDefinition() {
}
/**
@@ -81,7 +84,7 @@ public ColumnDefinition() {
*
* @param type the column type
*/
- public ColumnDefinition(ColumnTypes type) {
+ public TableColumnDefinition(TableColumnTypes type) {
this.type = type;
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionApiSupport.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionApiSupport.java
similarity index 95%
rename from astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionApiSupport.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionApiSupport.java
index 18831a25..8bdcec28 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionApiSupport.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionApiSupport.java
@@ -22,7 +22,6 @@
import com.datastax.astra.internal.serdes.tables.RowSerializer;
import lombok.Data;
-import lombok.NoArgsConstructor;
/**
* Represents the API support configuration for a column definition.
@@ -58,7 +57,7 @@
*
*/
@Data
-public class ColumnDefinitionApiSupport {
+public class TableColumnDefinitionApiSupport {
/**
* Specifies whether the column is included in table creation.
@@ -83,7 +82,7 @@ public class ColumnDefinitionApiSupport {
/**
* Default constructor.
*/
- public ColumnDefinitionApiSupport() {
+ public TableColumnDefinitionApiSupport() {
}
/**
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionList.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionList.java
similarity index 73%
rename from astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionList.java
rename to astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionList.java
index 2dc5c8a1..5f09197a 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionList.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionList.java
@@ -25,9 +25,9 @@
/**
* Represents a column definition for a list type in a database schema.
- * Extends {@link ColumnDefinition} to include details about the type of elements stored in the list.
+ * Extends {@link TableColumnDefinition} to include details about the type of elements stored in the list.
* - * This class is used to configure columns of type {@link ColumnTypes#LIST}, allowing the specification + * This class is used to configure columns of type {@link TableColumnTypes#LIST}, allowing the specification * of the data type for the values stored in the list. *
* @@ -41,18 +41,18 @@ */ @Getter @Setter -public class ColumnDefinitionList extends ColumnDefinition { +public class TableColumnDefinitionList extends TableColumnDefinition { /** * The data type of the values stored in the list. */ - private ColumnTypes valueType; + private TableColumnTypes valueType; /** - * Constructs a new {@code ColumnDefinitionList} instance with the column type set to {@link ColumnTypes#LIST}. + * Constructs a new {@code ColumnDefinitionList} instance with the column type set to {@link TableColumnTypes#LIST}. */ - public ColumnDefinitionList() { - super(ColumnTypes.LIST); + public TableColumnDefinitionList() { + super(TableColumnTypes.LIST); } /** @@ -60,7 +60,7 @@ public ColumnDefinitionList() { * * @param valueType the data type of the values in the list */ - public ColumnDefinitionList(ColumnTypes valueType) { + public TableColumnDefinitionList(TableColumnTypes valueType) { this(); this.valueType = valueType; } diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionMap.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionMap.java similarity index 79% rename from astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionMap.java rename to astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionMap.java index 27ccd639..a461ad48 100644 --- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionMap.java +++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionMap.java @@ -25,7 +25,7 @@ /** * Represents a column definition for a map type in a database schema. - * Extends {@link ColumnDefinition} to include specific details about the key and value types + * Extends {@link TableColumnDefinition} to include specific details about the key and value types * for map columns. ** This class facilitates the configuration of map columns, allowing specification of @@ -43,23 +43,23 @@ */ @Getter @Setter -public class ColumnDefinitionMap extends ColumnDefinition { +public class TableColumnDefinitionMap extends TableColumnDefinition { /** * The data type of the keys in the map. */ - private ColumnTypes keyType; + private TableColumnTypes keyType; /** * The data type of the values in the map. */ - private ColumnTypes valueType; + private TableColumnTypes valueType; /** - * Constructs a new {@code ColumnDefinitionMap} instance with the column type set to {@link ColumnTypes#MAP}. + * Constructs a new {@code ColumnDefinitionMap} instance with the column type set to {@link TableColumnTypes#MAP}. */ - public ColumnDefinitionMap() { - super(ColumnTypes.MAP); + public TableColumnDefinitionMap() { + super(TableColumnTypes.MAP); } /** @@ -68,7 +68,7 @@ public ColumnDefinitionMap() { * @param keyType the data type of the keys in the map * @param valueType the data type of the values in the map */ - public ColumnDefinitionMap(ColumnTypes keyType, ColumnTypes valueType) { + public TableColumnDefinitionMap(TableColumnTypes keyType, TableColumnTypes valueType) { this(); this.keyType = keyType; this.valueType = valueType; diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionSet.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionSet.java similarity index 74% rename from astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionSet.java rename to astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionSet.java index 2445ffa5..59819285 100644 --- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionSet.java +++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionSet.java @@ -25,9 +25,9 @@ /** * Represents a column definition for a set type in a database schema. - * Extends {@link ColumnDefinition} to include details about the type of elements stored in the set. + * Extends {@link TableColumnDefinition} to include details about the type of elements stored in the set. *
- * This class is used to configure columns of type {@link ColumnTypes#SET}, allowing the specification + * This class is used to configure columns of type {@link TableColumnTypes#SET}, allowing the specification * of the data type for the values stored in the set. *
* @@ -40,18 +40,18 @@ * */ @Getter @Setter -public class ColumnDefinitionSet extends ColumnDefinition { +public class TableColumnDefinitionSet extends TableColumnDefinition { /** * The data type of the values stored in the set. */ - private ColumnTypes valueType; + private TableColumnTypes valueType; /** - * Constructs a new {@code ColumnDefinitionSet} instance with the column type set to {@link ColumnTypes#SET}. + * Constructs a new {@code ColumnDefinitionSet} instance with the column type set to {@link TableColumnTypes#SET}. */ - public ColumnDefinitionSet() { - super(ColumnTypes.SET); + public TableColumnDefinitionSet() { + super(TableColumnTypes.SET); } /** @@ -59,7 +59,7 @@ public ColumnDefinitionSet() { * * @param valueType the data type of the values in the set */ - public ColumnDefinitionSet(ColumnTypes valueType) { + public TableColumnDefinitionSet(TableColumnTypes valueType) { this(); this.valueType = valueType; } diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionUserDefined.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionUserDefined.java new file mode 100644 index 00000000..6405e57e --- /dev/null +++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionUserDefined.java @@ -0,0 +1,59 @@ +package com.datastax.astra.client.tables.definition.columns; + +/*- + * #%L + * Data API Java Client + * -- + * Copyright (C) 2024 DataStax + * -- + * Licensed under the Apache License, Version 2.0 + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * #L% + */ + +import lombok.Getter; +import lombok.Setter; + +/** + * Represents a column definition for a user Defined Type (UDT) in a database schema. + * Extends {@link TableColumnDefinition} to include details about the type of elements stored in the list. + *+ * This class is used to configure columns of type {@link TableColumnTypes#USER_DEFINED}, allowing the specification + * of the data type for user defined values stored in the column. + *
+ */ +@Getter +@Setter +public class TableColumnDefinitionUserDefined extends TableColumnDefinition { + + /** + * The data type of the values stored in the list. + */ + private String udtName; + + /** + * Constructs a new {@code ColumnDefinitionList} instance with the column type set to {@link TableColumnTypes#LIST}. + */ + public TableColumnDefinitionUserDefined() { + super(TableColumnTypes.USER_DEFINED); + } + + /** + * Constructs a new {@code TableColumnDefinitionUserDefined} instance with the specified value type. + * + * @param udtName the name of the user defined type (UDT) + */ + public TableColumnDefinitionUserDefined(String udtName) { + this(); + this.udtName = udtName; + } +} diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionVector.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionVector.java similarity index 84% rename from astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionVector.java rename to astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionVector.java index 3c64672b..3c5119b8 100644 --- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnDefinitionVector.java +++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnDefinitionVector.java @@ -27,7 +27,7 @@ /** * Represents a column definition for vector-based data. - * Extends {@link ColumnDefinition} to include properties and methods + * Extends {@link TableColumnDefinition} to include properties and methods * specific to vector data such as dimension, similarity metric, and vectorization service. ** This class facilitates the configuration of vector columns in a data schema. @@ -44,7 +44,7 @@ */ @Getter @Setter -public class ColumnDefinitionVector extends ColumnDefinition { +public class TableColumnDefinitionVector extends TableColumnDefinition { /** * The dimension of the vector. @@ -66,10 +66,10 @@ public class ColumnDefinitionVector extends ColumnDefinition { /** * Constructs a new {@code ColumnDefinitionVector} instance - * with the column type set to {@link ColumnTypes#VECTOR}. + * with the column type set to {@link TableColumnTypes#VECTOR}. */ - public ColumnDefinitionVector() { - super(ColumnTypes.VECTOR); + public TableColumnDefinitionVector() { + super(TableColumnTypes.VECTOR); } /** @@ -78,7 +78,7 @@ public ColumnDefinitionVector() { * @param dimension the dimension of the vector * @return this {@code ColumnDefinitionVector} instance */ - public ColumnDefinitionVector dimension(int dimension) { + public TableColumnDefinitionVector dimension(int dimension) { this.dimension = dimension; return this; } @@ -89,7 +89,7 @@ public ColumnDefinitionVector dimension(int dimension) { * @param m the similarity metric * @return this {@code ColumnDefinitionVector} instance */ - public ColumnDefinitionVector metric(SimilarityMetric m) { + public TableColumnDefinitionVector metric(SimilarityMetric m) { this.metric = m; return this; } @@ -100,7 +100,7 @@ public ColumnDefinitionVector metric(SimilarityMetric m) { * @param service the vectorization service options * @return this {@code ColumnDefinitionVector} instance */ - public ColumnDefinitionVector service(VectorServiceOptions service) { + public TableColumnDefinitionVector service(VectorServiceOptions service) { this.service = service; return this; } diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnTypeMapper.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnTypeMapper.java similarity index 53% rename from astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnTypeMapper.java rename to astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnTypeMapper.java index 467989b5..7cd57bf8 100644 --- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/ColumnTypeMapper.java +++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/columns/TableColumnTypeMapper.java @@ -21,6 +21,7 @@ */ import com.datastax.astra.client.core.vector.DataAPIVector; +import com.datastax.astra.client.tables.definition.types.TableDataAPIUserDefinedType; import java.math.BigDecimal; import java.math.BigInteger; @@ -58,68 +59,71 @@ *
The {@code Column} annotation provides flexibility for mapping fields to database columns, + * with options to customize column name, type, and other attributes.
+ */ +@Target({ElementType.FIELD}) +@Retention(RetentionPolicy.RUNTIME) +public @interface TableUserDefinedTypeField { + + /** + * Specifies the name of the column. If not provided, the field's name will be used. + * + * @return the custom column name or an empty string if not set + */ + String name(); + + /** + * Specifies the type of the column. If not provided, the field's type will be used. + * + * @return the column type or {@link TableColumnTypes#UNDEFINED} if not set + */ + TableUserDefinedTypeFieldTypes type() default TableUserDefinedTypeFieldTypes.UNDEFINED; + + /** + * Specifies the value type of the column, typically used for complex data structures. + * If not provided, defaults to {@link TableColumnTypes#UNDEFINED}. + * + * @return the value type or {@link TableColumnTypes#UNDEFINED} if not set + */ + TableUserDefinedTypeFieldTypes valueType() default TableUserDefinedTypeFieldTypes.UNDEFINED; + + /** + * Specifies the key type of the column, typically used for mapping keys in key-value pairs. + * If not provided, defaults to {@link TableColumnTypes#UNDEFINED}. + * + * @return the key type or {@link TableColumnTypes#UNDEFINED} if not set + */ + TableUserDefinedTypeFieldTypes keyType() default TableUserDefinedTypeFieldTypes.UNDEFINED; + +} diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinition.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinition.java new file mode 100644 index 00000000..afb68dd0 --- /dev/null +++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinition.java @@ -0,0 +1,99 @@ +package com.datastax.astra.client.tables.definition.types; + +/*- + * #%L + * Data API Java Client + * -- + * Copyright (C) 2024 DataStax + * -- + * Licensed under the Apache License, Version 2.0 + * You may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * #L% + */ + +import com.datastax.astra.client.tables.definition.columns.TableColumnDefinitionApiSupport; +import com.datastax.astra.client.tables.definition.columns.TableColumnTypes; +import com.datastax.astra.internal.serdes.tables.RowSerializer; +import lombok.Data; + +/** + * Represents a column definition in a database schema. + *+ * This class encapsulates the type of the column and its associated API support + * configurations, providing a structure for managing column-specific details. + *
+ *+ * The class uses Lombok annotations to automatically generate getter, setter, and + * no-argument constructor methods. + *
+ * + *Fields:
+ *Constructors:
+ *Example usage:
+ *
+ * {@code
+ * ColumnTypes columnType = ColumnTypes.STRING;
+ * ColumnDefinition columnDefinition = new ColumnDefinition(columnType);
+ *
+ * columnDefinition.setApiSupport(new ColumnDefinitionApiSupport());
+ * columnDefinition.getApiSupport().setCreateTable(true);
+ * columnDefinition.getApiSupport().setInsert(false);
+ *
+ * System.out.println(columnDefinition);
+ * }
+ *
+ */
+@Data
+public class TableUserDefinedTypeFieldDefinition {
+
+ /**
+ * The type of the column.
+ */
+ private TableUserDefinedTypeFieldTypes type;
+
+ /**
+ * API support details for the column when not fully supported by the Data API.
+ */
+ private TableColumnDefinitionApiSupport apiSupport;
+
+ /**
+ * Default constructor.
+ */
+ public TableUserDefinedTypeFieldDefinition() {
+ }
+
+ /**
+ * Constructor with type.
+ *
+ * @param type the column type
+ */
+ public TableUserDefinedTypeFieldDefinition(TableUserDefinedTypeFieldTypes type) {
+ this.type = type;
+ }
+
+ /** {@inheritDoc} */
+ @Override
+ public String toString() {
+ return new RowSerializer().marshall(this);
+ }
+
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionList.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionList.java
new file mode 100644
index 00000000..57a29463
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionList.java
@@ -0,0 +1,69 @@
+package com.datastax.astra.client.tables.definition.types;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnTypes;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * Represents a column definition for a list type in a database schema.
+ * Extends {@link TableColumnDefinition} to include details about the type of elements stored in the list.
+ * + * This class is used to configure columns of type {@link TableColumnTypes#LIST}, allowing the specification + * of the data type for the values stored in the list. + *
+ * + *Example usage:
+ *
+ * {@code
+ * ColumnDefinitionList listColumn = new ColumnDefinitionList(ColumnTypes.TEXT);
+ * ColumnTypes valueType = listColumn.getValueType();
+ * }
+ *
+ */
+@Getter
+@Setter
+public class TableUserDefinedTypeFieldDefinitionList extends TableUserDefinedTypeFieldDefinition {
+
+ /**
+ * The data type of the values stored in the list.
+ */
+ private TableUserDefinedTypeFieldTypes valueType;
+
+ /**
+ * Constructs a new {@code ColumnDefinitionList} instance with the column type set to {@link TableColumnTypes#LIST}.
+ */
+ public TableUserDefinedTypeFieldDefinitionList() {
+ super(TableUserDefinedTypeFieldTypes.UNSUPPORTED);
+ }
+
+ /**
+ * Constructs a new {@code ColumnDefinitionList} instance with the specified value type.
+ *
+ * @param valueType the data type of the values in the list
+ */
+ public TableUserDefinedTypeFieldDefinitionList(TableUserDefinedTypeFieldTypes valueType) {
+ this();
+ this.valueType = valueType;
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionMap.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionMap.java
new file mode 100644
index 00000000..f556a6b6
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionMap.java
@@ -0,0 +1,78 @@
+package com.datastax.astra.client.tables.definition.types;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnTypes;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * Represents a column definition for a map type in a database schema.
+ * Extends {@link TableColumnDefinition} to include specific details about the key and value types
+ * for map columns.
+ * + * This class facilitates the configuration of map columns, allowing specification of + * the types of keys and values stored in the map. + *
+ * + *Example usage:
+ *
+ * {@code
+ * ColumnDefinitionMap mapColumn = new ColumnDefinitionMap(ColumnTypes.TEXT, ColumnTypes.INT);
+ * ColumnTypes keyType = mapColumn.getKeyType();
+ * ColumnTypes valueType = mapColumn.getValueType();
+ * }
+ *
+ */
+@Getter
+@Setter
+public class TableUserDefinedTypeFieldDefinitionMap extends TableUserDefinedTypeFieldDefinition {
+
+ /**
+ * The data type of the keys in the map.
+ */
+ private TableUserDefinedTypeFieldTypes keyType;
+
+ /**
+ * The data type of the values in the map.
+ */
+ private TableUserDefinedTypeFieldTypes valueType;
+
+ /**
+ * Constructs a new {@code ColumnDefinitionMap} instance with the column type set to {@link TableColumnTypes#MAP}.
+ */
+ public TableUserDefinedTypeFieldDefinitionMap() {
+ super(TableUserDefinedTypeFieldTypes.UNSUPPORTED);
+ }
+
+ /**
+ * Constructs a new {@code ColumnDefinitionMap} instance with the specified key and value types.
+ *
+ * @param keyType the data type of the keys in the map
+ * @param valueType the data type of the values in the map
+ */
+ public TableUserDefinedTypeFieldDefinitionMap(TableUserDefinedTypeFieldTypes keyType, TableUserDefinedTypeFieldTypes valueType) {
+ this();
+ this.keyType = keyType;
+ this.valueType = valueType;
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionSet.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionSet.java
new file mode 100644
index 00000000..7003b826
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldDefinitionSet.java
@@ -0,0 +1,68 @@
+package com.datastax.astra.client.tables.definition.types;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnTypes;
+import lombok.Getter;
+import lombok.Setter;
+
+/**
+ * Represents a column definition for a set type in a database schema.
+ * Extends {@link TableColumnDefinition} to include details about the type of elements stored in the set.
+ * + * This class is used to configure columns of type {@link TableColumnTypes#SET}, allowing the specification + * of the data type for the values stored in the set. + *
+ * + *Example usage:
+ *
+ * {@code
+ * ColumnDefinitionSet setColumn = new ColumnDefinitionSet(ColumnTypes.TEXT);
+ * ColumnTypes valueType = setColumn.getValueType();
+ * }
+ *
+ */
+@Getter @Setter
+public class TableUserDefinedTypeFieldDefinitionSet extends TableUserDefinedTypeFieldDefinition {
+
+ /**
+ * The data type of the values stored in the set.
+ */
+ private TableUserDefinedTypeFieldTypes valueType;
+
+ /**
+ * Constructs a new {@code ColumnDefinitionSet} instance with the column type set to {@link TableColumnTypes#SET}.
+ */
+ public TableUserDefinedTypeFieldDefinitionSet() {
+ super(TableUserDefinedTypeFieldTypes.UNSUPPORTED);
+ }
+
+ /**
+ * Constructs a new {@code ColumnDefinitionSet} instance with the specified value type.
+ *
+ * @param valueType the data type of the values in the set
+ */
+ public TableUserDefinedTypeFieldDefinitionSet(TableUserDefinedTypeFieldTypes valueType) {
+ this();
+ this.valueType = valueType;
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldTypeMapper.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldTypeMapper.java
new file mode 100644
index 00000000..2fb569e9
--- /dev/null
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/definition/types/TableUserDefinedTypeFieldTypeMapper.java
@@ -0,0 +1,122 @@
+package com.datastax.astra.client.tables.definition.types;
+
+/*-
+ * #%L
+ * Data API Java Client
+ * --
+ * Copyright (C) 2024 DataStax
+ * --
+ * Licensed under the Apache License, Version 2.0
+ * You may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * #L%
+ */
+
+import com.datastax.astra.client.tables.definition.columns.TableColumnTypes;
+
+import java.math.BigDecimal;
+import java.math.BigInteger;
+import java.net.InetAddress;
+import java.time.Instant;
+import java.time.LocalDate;
+import java.time.LocalTime;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
+
+/**
+ * Maps Java types to corresponding Cassandra column types.
+ * + * The {@code ColumnTypeMapper} provides a utility method to determine the appropriate + * Cassandra column type for a given Java class. Commonly used Java types, such as + * primitives, wrapper types, collections, and date/time classes, are mapped to their + * respective Cassandra types. + *
+ * + *Example usage:
+ *{@code
+ * ColumnTypes columnType = ColumnTypeMapper.getColumnType(String.class);
+ * System.out.println(columnType); // Outputs: TEXT
+ * }
+ *
+ * Supported mappings include:
+ *+ * This enum includes common types like {@code TEXT}, {@code INT}, and {@code UUID}, + * as well as specialized types such as {@code VECTOR} and {@code UNSUPPORTED}. + *
+ * + *Example usage:
+ *
+ * {@code
+ * ColumnTypes columnType = ColumnTypes.TEXT;
+ * String columnValue = columnType.getValue();
+ * }
+ *
+ */
+@Getter
+@JsonSerialize(using = UdtFieldTypeSerializer.class)
+@JsonDeserialize(using = UdtFieldTypeDeserializer.class)
+public enum TableUserDefinedTypeFieldTypes {
+
+ /**
+ * ASCII string type.
+ */
+ ASCII("ascii"),
+
+ /**
+ * 64-bit signed integer.
+ */
+ BIGINT("bigint"),
+
+ /**
+ * Binary large object (BLOB) type.
+ */
+ BLOB("blob"),
+
+ /**
+ * Boolean type, representing true or false values.
+ */
+ BOOLEAN("boolean"),
+
+ /**
+ * Date type, storing only the date part without a time zone.
+ */
+ DATE("date"),
+
+ /**
+ * Arbitrary precision decimal number.
+ */
+ DECIMAL("decimal"),
+
+ /**
+ * Double-precision floating-point number.
+ */
+ DOUBLE("double"),
+
+ /**
+ * Time duration type.
+ */
+ DURATION("duration"),
+
+ /**
+ * Single-precision floating-point number.
+ */
+ FLOAT("float"),
+
+ /**
+ * IP address type.
+ */
+ INET("inet"),
+
+ /**
+ * 32-bit signed integer.
+ */
+ INT("int"),
+
+// /**
+// * List collection type.
+// */
+// LIST("list"),
+//
+// /**
+// * Map collection type, storing key-value pairs.
+// */
+// MAP("map"),
+//
+// /**
+// * Set collection type, storing unique elements.
+// */
+// SET("set"),
+
+ /**
+ * 16-bit signed integer.
+ */
+ SMALLINT("smallint"),
+
+ /**
+ * Text or string type.
+ */
+ TEXT("text"),
+
+ /**
+ * Time type, storing only the time part.
+ */
+ TIME("time"),
+
+ /**
+ * Timestamp type, representing a specific date and time.
+ */
+ TIMESTAMP("timestamp"),
+
+ /**
+ * TimeUUID.
+ */
+ TIMEUUID("timeuuid"),
+
+ /**
+ * 8-bit signed integer.
+ */
+ TINYINT("tinyint"),
+
+ /**
+ * Arbitrary precision integer type.
+ */
+ VARINT("varint"),
+
+ /**
+ * Universally Unique Identifier (UUID) type.
+ */
+ UUID("uuid"),
+
+ /**
+ * Represents unsupported column types.
+ */
+ UNSUPPORTED("UNSUPPORTED"),
+
+ /**
+ * Represents an undefined column type.
+ */
+ UNDEFINED("undefined");
+
+ /**
+ * The string representation of the column type.
+ */
+ private final String value;
+
+ /**
+ * Constructs a {@code ColumnTypes} enum constant with the specified string value.
+ *
+ * @param value the string representation of the column type
+ */
+ TableUserDefinedTypeFieldTypes(String value) {
+ this.value = value;
+ }
+}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/Column.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/Column.java
index 0ac10e99..be496261 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/Column.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/Column.java
@@ -20,15 +20,12 @@
* #L%
*/
-import com.datastax.astra.client.core.vector.SimilarityMetric;
-import com.datastax.astra.client.tables.definition.columns.ColumnTypes;
+import com.datastax.astra.client.tables.definition.columns.TableColumnTypes;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
-import java.util.HashMap;
-import java.util.Map;
/**
* Annotation to define properties for a database column. This annotation can be used on fields
@@ -51,24 +48,24 @@
/**
* Specifies the type of the column. If not provided, the field's type will be used.
*
- * @return the column type or {@link ColumnTypes#UNDEFINED} if not set
+ * @return the column type or {@link TableColumnTypes#UNDEFINED} if not set
*/
- ColumnTypes type() default ColumnTypes.UNDEFINED;
+ TableColumnTypes type() default TableColumnTypes.UNDEFINED;
/**
* Specifies the value type of the column, typically used for complex data structures.
- * If not provided, defaults to {@link ColumnTypes#UNDEFINED}.
+ * If not provided, defaults to {@link TableColumnTypes#UNDEFINED}.
*
- * @return the value type or {@link ColumnTypes#UNDEFINED} if not set
+ * @return the value type or {@link TableColumnTypes#UNDEFINED} if not set
*/
- ColumnTypes valueType() default ColumnTypes.UNDEFINED;
+ TableColumnTypes valueType() default TableColumnTypes.UNDEFINED;
/**
* Specifies the key type of the column, typically used for mapping keys in key-value pairs.
- * If not provided, defaults to {@link ColumnTypes#UNDEFINED}.
+ * If not provided, defaults to {@link TableColumnTypes#UNDEFINED}.
*
- * @return the key type or {@link ColumnTypes#UNDEFINED} if not set
+ * @return the key type or {@link TableColumnTypes#UNDEFINED} if not set
*/
- ColumnTypes keyType() default ColumnTypes.UNDEFINED;
+ TableColumnTypes keyType() default TableColumnTypes.UNDEFINED;
}
diff --git a/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/ColumnVector.java b/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/ColumnVector.java
index f1b38d5c..4230ec18 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/ColumnVector.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/client/tables/mapping/ColumnVector.java
@@ -21,7 +21,6 @@
*/
import com.datastax.astra.client.core.vector.SimilarityMetric;
-import com.datastax.astra.client.tables.definition.columns.ColumnTypes;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
diff --git a/astra-db-java/src/main/java/com/datastax/astra/internal/api/DataAPIStatus.java b/astra-db-java/src/main/java/com/datastax/astra/internal/api/DataAPIStatus.java
index 868ad1a8..1f8ff0be 100644
--- a/astra-db-java/src/main/java/com/datastax/astra/internal/api/DataAPIStatus.java
+++ b/astra-db-java/src/main/java/com/datastax/astra/internal/api/DataAPIStatus.java
@@ -23,7 +23,7 @@
import com.datastax.astra.client.collections.definition.documents.Document;
import com.datastax.astra.client.core.vector.DataAPIVector;
import com.datastax.astra.client.exceptions.DataAPIErrorDescriptor;
-import com.datastax.astra.client.tables.definition.columns.ColumnDefinition;
+import com.datastax.astra.client.tables.definition.columns.TableColumnDefinition;
import com.datastax.astra.internal.serdes.DataAPISerializer;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
@@ -70,12 +70,12 @@ public class DataAPIStatus {
/**
* PrimaryKey Schema returned
*/
- private LinkedHashMap+ * This class is responsible for serializing an {@link AlterTypeOperation} instance into JSON format. + *
+ * + *Example usage:
+ *
+ * {@code
+ * AlterTypeOperation operation = new AlterTypeOperation();
+ * String json = new ObjectMapper().writeValueAsString(operation);
+ * }
+ *
+ */
+public class AlterTypeOperationSerializer extends StdSerializer