Find all databases (C#)
Lists all databases.
|
You need an application token with permission to create and configure databases, such as the Organization Administrator role. For more information, see Get endpoint and token. |
Result
Returns a list of DatabaseInfo objects that each describe a database.
Parameters
Use the ListDatabasesAsync method, which belongs to the AstraDatabasesAdmin class.
You can also use ListDatabases, which is the synchronous version of the method.
Method signature
public Task<List<DatabaseInfo>> ListDatabasesAsync(
ListDatabaseOptions options = null
);| Name | Type | Summary |
|---|---|---|
|
Optional.
General API options for this operation, including the timeout.
For more information and examples, see Customize API interaction.
For options specific to this method, see Method-specific properties of the |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Filters the returned databases by status. Some of the status are short-lived or do not apply to Astra DB Serverless databases. Default: |
|
|
Optional. Filters the returned databases by cloud provider. Default: |
|
|
Optional. The number of results per page. The client manages pagination for you and returns the full list. Maximum: 100 Default: 50 |
|
|
Optional. Pass the database ID of the last item on the previous page to get the next page. |
Examples
The following examples demonstrate how to list databases.
using DataStax.AstraDB.DataApi;
namespace Examples;
public class Program
{
static async Task Main()
{
var client = new DataAPIClient("APPLICATION_TOKEN");
var admin = client.GetAstraDatabasesAdmin();
var databases = await admin.ListDatabasesAsync();
}
}Client reference
For more information, see the client reference.
