Find a database (C#)
Gets information about a database.
|
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 DatabaseInfo object that you can use to perform CRUD operations on your database
Parameters
Use the GetDatabaseInfoAsync method, which belongs to the AstraDatabasesAdmin class.
You can also use GetDatabaseInfo, which is the synchronous version of the method.
Method signature
public Task<DatabaseInfo> GetDatabaseInfoAsync(
string dbGuid, GetDatabaseInfoOptions options = null
);
Parameters:
| Name | Type | Summary |
|---|---|---|
|
|
The ID of the target database. |
|
General API options for this operation, including the timeout. For more information and examples, see Customize API interaction. |
Examples
The following examples demonstrate how to find a database.
using DataStax.AstraDB.DataApi;
namespace Examples;
public class Program
{
static async Task Main()
{
var client = new DataAPIClient("APPLICATION_TOKEN");
var admin = client.GetAstraDatabasesAdmin();
var info = await admin.GetDatabaseInfoAsync("DATABASE_ID");
}
}
Client reference
For more information, see the client reference.