Package com.datastax.astra.client.admin
Class DataAPIDatabaseAdmin
java.lang.Object
com.datastax.astra.internal.command.AbstractCommandRunner
com.datastax.astra.client.admin.DataAPIDatabaseAdmin
- All Implemented Interfaces:
DatabaseAdmin
,CommandRunner
Implementation of Client.
-
Field Summary
Modifier and TypeFieldDescriptionprotected final String
Version of the API.protected final DataAPIOptions
Version of the API.protected final String
Version of the API.Fields inherited from class com.datastax.astra.internal.command.AbstractCommandRunner
commandOptions, httpClient
-
Constructor Summary
ConstructorDescriptionDataAPIDatabaseAdmin
(String apiEndpoint, String token, 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
createNamespace
(String namespace, NamespaceOptions options) Allow to create a namespace with full-fledged definitionvoid
dropNamespace
(String namespace) Drops (deletes) the specified namespace from the database.Retrieve the list of embedding providers available in the current database.protected String
The subclass should provide the endpoint, url to post request.getDatabase
(String namespaceName) Retrieves aDatabase
instance that represents a specific database (or namespace) based on the provided namespace name.getDatabase
(String namespaceName, String userToken) Access the Database associated with this admin class.Retrieves a stream of namespace names available in the current database.void
registerListener
(String logger, CommandObserver commandObserver) Register a listener to execute commands on the collection.Methods inherited from class com.datastax.astra.internal.command.AbstractCommandRunner
mapAsDocument, runCommand, runCommand
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.model.CommandRunner
runCommand, runCommand
Methods inherited from interface com.datastax.astra.client.admin.DatabaseAdmin
createNamespaceAsync, dropNamespaceAsync, getDatabase, listNamespaceNamesAsync, namespaceExists
-
Field Details
-
options
Version of the API. -
apiEndPoint
Version of the API. -
token
Version of the API.
-
-
Constructor Details
-
DataAPIDatabaseAdmin
Initialize a database admin from token and database id.- Parameters:
apiEndpoint
- api endpoint.token
- token valueoptions
- list of options for the admin
-
-
Method Details
-
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
-
getDatabase
Retrieves aDatabase
instance that represents a specific database (or namespace) based on the provided namespace name.Example usage:
// Assume 'client' is an instance of your data API client String namespaceName = "exampleNamespace"; // Retrieve the namespace instance DataApiNamespace namespace = client.getNamespace(namespaceName); // Now, 'namespace' can be used to perform operations within 'exampleNamespace'
DataApiNamespace
instance for a specified namespace name, which then enables the execution of various database operations within that namespace. It highlights the method's role in facilitating direct interaction with different parts of the database.- 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:
- A
DataApiNamespace
instance that encapsulates the operations and information specific to the given namespace.
-
getDatabase
Access the Database associated with this admin class.- Specified by:
getDatabase
in interfaceDatabaseAdmin
- Parameters:
namespaceName
- the destination namespace for this databaseuserToken
- the user token with DML access if different from admin.- Returns:
- instance of the database
-
createNamespace
Create a Namespace providing a name.- Specified by:
createNamespace
in interfaceDatabaseAdmin
- Parameters:
namespace
- current namespace.
-
createNamespace
Allow to create a namespace with full-fledged definition- Parameters:
namespace
- namespace nameoptions
- options to create a 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.
-
getApiEndpoint
The subclass should provide the endpoint, url to post request.- Specified by:
getApiEndpoint
in classAbstractCommandRunner
- Returns:
- url on which to post the request
-
registerListener
Register a listener to execute commands on the collection. Please now useCommandOptions
.- Parameters:
logger
- name for the loggercommandObserver
- class for the logger
-