Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.dtsx.astra.sdk.AstraDB Maven / Gradle / Ivy
package com.dtsx.astra.sdk;
import com.dtsx.astra.sdk.db.AstraDBOpsClient;
import com.dtsx.astra.sdk.db.domain.Database;
import com.dtsx.astra.sdk.db.exception.DatabaseNotFoundException;
import com.dtsx.astra.sdk.utils.ApiLocator;
import com.dtsx.astra.sdk.utils.AstraEnvironment;
import io.stargate.sdk.ServiceDeployment;
import io.stargate.sdk.api.SimpleTokenProvider;
import io.stargate.sdk.http.ServiceHttp;
import io.stargate.sdk.json.ApiClient;
import io.stargate.sdk.json.NamespaceClient;
import io.stargate.sdk.json.domain.CollectionDefinition;
import io.stargate.sdk.json.domain.SimilarityMetric;
import lombok.Getter;
import lombok.NonNull;
import lombok.extern.slf4j.Slf4j;
import java.util.Optional;
import java.util.UUID;
import java.util.stream.Stream;
/**
* Hiding top level Json Api and skip interaction with namespaces
*/
@Slf4j @Getter
public class AstraDB {
/**
* Hold a reference to target Astra Environment.
*/
protected final AstraEnvironment env;
/**
* Top level resource for json api.
*/
private final ApiClient apiClient;
/**
* Namespace client
*/
private final NamespaceClient nsClient;
/**
* Url to access the API
*/
private final String apiEndpoint;
/**
* Initialization with endpoint and apikey.
*
* @param token
* api token
* @param apiEndpoint
* api endpoint
*/
public AstraDB(String token, String apiEndpoint) {
this(token, apiEndpoint, AstraDBAdmin.DEFAULT_KEYSPACE);
}
/**
* Initialization with endpoint and apikey.
*
* @param token
* api token
* @param apiEndpoint
* api endpoint
* @param keyspace
* keyspace
*/
public AstraDB(@NonNull String token, @NonNull String apiEndpoint, @NonNull String keyspace) {
// Support for apiEndpoint with or without /api/json
if (apiEndpoint.endsWith("com")) {
apiEndpoint = apiEndpoint + "/api/json";
}
this.apiEndpoint = apiEndpoint;
// Finding Environment based on apiEndpoint (looping to devops)
if (apiEndpoint.contains(AstraEnvironment.PROD.getAppsSuffix())) {
this.env = AstraEnvironment.PROD;
} else if (apiEndpoint.contains(AstraEnvironment.TEST.getAppsSuffix())) {
this.env = AstraEnvironment.TEST;
} else if (apiEndpoint.contains(AstraEnvironment.DEV.getAppsSuffix())) {
this.env = AstraEnvironment.DEV;
} else {
throw new IllegalArgumentException("Unable to detect environment from endpoint");
}
// deploy on a single url with a static token (token provider)
ServiceDeployment jsonDeploy = new ServiceDeployment<>();
jsonDeploy.addDatacenterTokenProvider("default", new SimpleTokenProvider(token));
jsonDeploy.addDatacenterServices("default", new ServiceHttp("json", apiEndpoint, apiEndpoint));
this.apiClient = new ApiClient(jsonDeploy);
this.nsClient = apiClient.namespace(keyspace);
}
/**
* Full constructor.
*
* @param token
* token
* @param databaseId
* database identifier
*/
public AstraDB(@NonNull String token, @NonNull UUID databaseId) {
this(token, databaseId, null, AstraEnvironment.PROD, AstraDBAdmin.DEFAULT_KEYSPACE);
}
/**
* Full constructor.
*
* @param token
* token
* @param databaseId
* database identifier
* @param keyspace
* database keyspace
*/
public AstraDB(@NonNull String token, @NonNull UUID databaseId, @NonNull String keyspace) {
this(token, databaseId, null, AstraEnvironment.PROD, keyspace);
}
/**
* Full constructor.
*
* @param token
* token
* @param databaseId
* database identifier
* @param region
* database region
* @param keyspace
* keyspace
*/
public AstraDB(@NonNull String token, @NonNull UUID databaseId, @NonNull String region, @NonNull String keyspace) {
this(token, databaseId, region, AstraEnvironment.PROD, keyspace);
}
/**
* Accessing the database with id an region.
*
* @param token
* astra token
* @param databaseId
* databsae id
* @param region
* database region
* @param env
* environment
*/
public AstraDB(@NonNull String token, @NonNull UUID databaseId, String region, @NonNull AstraEnvironment env, String keyspace) {
this.env = env;
Database db = new AstraDBOpsClient(token, env)
.findById(databaseId.toString())
.orElseThrow(() -> new DatabaseNotFoundException(databaseId.toString()));
if (region == null) region = db.getInfo().getRegion();
ServiceDeployment jsonDeploy = new ServiceDeployment<>();
jsonDeploy.addDatacenterTokenProvider("default", new SimpleTokenProvider(token));
this.apiEndpoint = ApiLocator.getApiJsonEndpoint(env, databaseId.toString(), region);
jsonDeploy.addDatacenterServices("default", new ServiceHttp("json", apiEndpoint, apiEndpoint));
final String defaultRegion = region;
db.getInfo()
.getDatacenters().stream()
.filter(dc->!dc.getRegion().equals(defaultRegion))
.forEach(dc -> {
String dcApiEndpoint = ApiLocator.getApiJsonEndpoint(env, databaseId.toString(), dc.getRegion());
jsonDeploy.addDatacenterServices(dc.getName(), new ServiceHttp("json", dcApiEndpoint, dcApiEndpoint));
});
this.apiClient = new ApiClient(jsonDeploy);
if (keyspace == null) {
keyspace = db.getInfo().getKeyspace();
}
this.nsClient = apiClient.namespace(keyspace);
}
// --------------------------
// --- Find, FindAll ----
// --------------------------
/**
* Check if a store exists.
*
* @param store
* collection name
* @return
* of the store already exist
*/
public boolean isCollectionExists(@NonNull String store) {
return nsClient.isCollectionExists(store);
}
/**
* List all vector Stores for this environment.
*
* @return
* name of all vector store.
*/
public Stream findAllCollections() {
return nsClient.findCollections();
}
/**
* Return the collection definition if its exists.
*
* @param name
* collection name
*/
public Optional findCollection(String name) {
return nsClient.findCollectionByName(name);
}
// --------------------------
// --- Delete ----
// --------------------------
/**
* Delete a store if it exists.
*
* @param name
* store name
*/
public void deleteCollection(String name) {
nsClient.deleteCollection(name);
}
// --------------------------
// --- Create ----
// --------------------------
/**
* Create the minimal store.
*
* @param name
* store name
* @return
* json vector store
*/
public AstraDBCollection createCollection(String name) {
return new AstraDBCollection(nsClient.createCollection(name));
}
/**
* Create the minimal store.
*
* @param name
* store name
* @param clazz
* bean type
* @param
* type of document in used
* @return
* json vector store
*/
public AstraDBRepository createCollection(String name, Class clazz) {
return new AstraDBRepository(nsClient.createCollection(name, clazz));
}
/**
* Create the minimal store.
*
* @param name
* store name
* @param vectorDimension
* dimension
* @return
* json vector store
*/
public AstraDBCollection createCollection(String name, int vectorDimension) {
return new AstraDBCollection(nsClient.createCollection(name, vectorDimension));
}
/**
* Create the minimal store.
*
* @param name
* store name
* @param vectorDimension
* dimension
* @return
* json vector store
*/
public AstraDBCollection createCollection(String name, int vectorDimension, SimilarityMetric metric) {
return new AstraDBCollection(nsClient.createCollection(CollectionDefinition
.builder()
.name(name)
.vector(vectorDimension, metric)
.build()));
}
/**
* Create the minimal store.
*
* @param name
* store name
* @param vectorDimension
* dimension
* @param bean
* class of pojo
* @return
* vector store instance
* @param
* object type
*/
public AstraDBRepository createCollection(String name, int vectorDimension, Class bean) {
return new AstraDBRepository(nsClient.createCollection(CollectionDefinition.builder()
.name(name)
.vector(vectorDimension, SimilarityMetric.cosine)
.build(), bean));
}
/**
* Create the minimal store.
*
* @param def
* collection definition
* @return
* json vector store
*/
public AstraDBCollection createCollection(CollectionDefinition def) {
return new AstraDBCollection(nsClient.createCollection(def));
}
/**
* Create the minimal store.
*
* @param def
* collection definition
* @param clazz
* bean type
* @param
* type of document in used
* @return
* json vector store
*/
public AstraDBRepository createCollection(CollectionDefinition def, Class clazz) {
return new AstraDBRepository(nsClient.createCollection(def, clazz));
}
// --------------------
// == Sub resources ==
// --------------------
/**
* Access the database functions.
*
* @param storeName
* store identifier
* @return
* storeName client
*/
public AstraDBCollection collection(@NonNull String storeName) {
return new AstraDBCollection(nsClient.collection(storeName));
}
/**
* Access the database functions.
*
* @param storeName
* store identifier
* @param clazz
* type of object used
* @return
* storeName client
* @param
* type of the bean in use
*/
public AstraDBRepository collectionRepository(@NonNull String storeName, Class clazz) {
return new AstraDBRepository(nsClient.collectionRepository(storeName, clazz));
}
/**
* Access the low level Stargate Namespace resource operation.
*
* @return
* raw namespace client
*/
public NamespaceClient getRawNamespaceClient() {
return nsClient;
}
}
