List collection metadata (Java)
Gets information about the collections in a keyspace.
|
Ready to write code? See the examples for this method to get started. If you are new to the Data API, check out the quickstart. |
Result
Returns a List<CollectionDescriptor>, where each CollectionDescriptor object describes a collection.
Parameters
Use the listCollections method, which belongs to the com.datastax.astra.client.Database class.
Method signature
List<CollectionDescriptor> listCollections()List<CollectionDescriptor> listCollections(ListCollectionOptions options)| Name | Type | Summary |
|---|---|---|
|
Optional.
The options for this operation, including the keyspace and timeouts.
Keyspace is required unless you specified a working keyspace when instantiating the |
Examples
The following examples demonstrate how to get collection metadata.
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.collections.definition.CollectionDescriptor;
import com.datastax.astra.client.databases.Database;
import java.util.List;
public class Example {
public static void main(String[] args) {
// Get a database
Database database =
DataAPIClients.clientHCD("USERNAME", "PASSWORD")
.getDatabase("API_ENDPOINT", "KEYSPACE_NAME");
// List collections
List<CollectionDescriptor> collectionMetadata = database.listCollections();
collectionMetadata.stream().map(CollectionDescriptor::getOptions).forEach(System.out::println);
}
}Client reference
For more information, see the client reference.
