Package com.datastax.astra.client.admin
Class AstraDBDatabaseAdmin
java.lang.Object
com.datastax.astra.client.admin.AstraDBDatabaseAdmin
- All Implemented Interfaces:
DatabaseAdmin
Implementation of the DatabaseAdmin interface for Astra. To create the namespace the devops APi is leverage. To use this class a higher token permission is required.
-
Constructor Summary
ConstructorDescriptionAstraDBDatabaseAdmin
(String token, UUID databaseId, com.dtsx.astra.sdk.utils.AstraEnvironment env, DataAPIOptions options) Initialize a database admin from token and database id. -
Method Summary
Modifier and TypeMethodDescriptionvoid
createNamespace
(String namespace) Create a Namespace providing a name.void
dropNamespace
(String namespace) Drops (deletes) the specified namespace from the database.Retrieve the list of embedding providers available in the current database.getDatabase
(String namespaceName) Access teh database with the default token.getDatabase
(String namespaceName, String tokenUser) Access teh database with the specialized token.com.dtsx.astra.sdk.db.domain.Database
Find a database from its id.Retrieves a stream of namespace names available in the current database.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface com.datastax.astra.client.admin.DatabaseAdmin
createNamespaceAsync, dropNamespaceAsync, getDatabase, listNamespaceNamesAsync, namespaceExists
-
Constructor Details
-
AstraDBDatabaseAdmin
public AstraDBDatabaseAdmin(String token, UUID databaseId, com.dtsx.astra.sdk.utils.AstraEnvironment env, DataAPIOptions options) Initialize a database admin from token and database id.- Parameters:
token
- token valuedatabaseId
- database identifierenv
- working environmentoptions
- options used to initialize the http client
-
-
Method Details
-
getDatabaseInformations
public com.dtsx.astra.sdk.db.domain.Database getDatabaseInformations()Find a database from its id.- Returns:
- list of db matching the criteria
-
getDatabase
Access teh database with the default token.- Specified by:
getDatabase
in interfaceDatabaseAdmin
- Parameters:
namespaceName
- The name of the namespace (or keyspace) to retrieve. This parameter should match the exact name of the namespace as it exists in the database.- Returns:
- client to interact with database DML.
-
getDatabase
Access teh database with the specialized token.- Specified by:
getDatabase
in interfaceDatabaseAdmin
- Parameters:
namespaceName
- The name of the namespace (or keyspace) to retrieve. This parameter should match the exact name of the namespace as it exists in the database.tokenUser
- token with reduce privileges compared to admin token in order to do dml options (CRUD).- Returns:
- client to interact with database DML.
-
listNamespaceNames
Retrieves a stream of namespace names available in the current database. This method is essential for applications that need to enumerate all namespaces to perform operations such as displaying available namespaces to users, managing namespaces programmatically, or executing specific tasks within each namespace. The returned Stream facilitates efficient processing of namespace names, enabling operations like filtering, sorting, and mapping without the need for preloading all names into memory.Example usage:
// Assuming 'client' is an instance of DataApiClient Stream<String> namespaceNames = client.listNamespaceNames()); // Display names in the console namespaceNames.forEach(System.out::println);
- Specified by:
listNamespaceNames
in interfaceDatabaseAdmin
- Returns:
- A
Set
containing the names of all namespaces within the current database. The stream provides a flexible and efficient means to process the namespace names according to the application's needs.
-
findEmbeddingProviders
Retrieve the list of embedding providers available in the current database. Embedding providers are services that provide embeddings for text, images, or other data types. This method returns a map of provider names toEmbeddingProvider
instances, allowing applications to access and utilize the embedding services.Example usage:
// Assuming 'client' is an instance of DataApiClient Map<String, EmbeddingProvider> providers = client.findEmbeddingProvidersAsMap());
- Specified by:
findEmbeddingProviders
in interfaceDatabaseAdmin
- Returns:
- list of available providers
-
createNamespace
Create a Namespace providing a name.- Specified by:
createNamespace
in interfaceDatabaseAdmin
- Parameters:
namespace
- current namespace.
-
dropNamespace
Drops (deletes) the specified namespace from the database. This operation is idempotent; it will not produce an error if the namespace does not exist. This method is useful for cleaning up data or removing entire keyspaces as part of database maintenance or restructuring. Caution should be exercised when using this method, as dropping a namespace will remove all the data, collections, or tables contained within it, and this action cannot be undone.Example usage:
// Assume 'client' is an instance of your data API client String namespace = "targetNamespace"; // Drop the namespace client.dropNamespace(namespace); // The namespace 'targetNamespace' is now deleted, along with all its contained data
- Specified by:
dropNamespace
in interfaceDatabaseAdmin
- Parameters:
namespace
- The name of the namespace to be dropped. This parameter specifies the target namespace that should be deleted. The operation will proceed silently and without error even if the namespace does not exist, ensuring consistent behavior.
-