List table metadata (Java)
Gets information about the tables 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 an unordered list of TableDescriptor objects that describe each table.
Parameters
Use the listTables method, which belongs to the com.datastax.astra.client.databases.Database class.
Method signature
List<TableDescriptor> listTables()List<TableDescriptor> listTables(ListTablesOptions listTableOptions)| 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 list table metadata.
List table metadata
import com.datastax.astra.client.DataAPIClients;
import com.datastax.astra.client.databases.Database;
import com.datastax.astra.client.tables.definition.TableDescriptor;
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 table metadata
List<TableDescriptor> result = database.listTables();
System.out.println(result);
}
}Client reference
For more information, see the client reference.
