Get a database admin (C#)
The Data API clients use the Database Admin class to perform administrative operations, like managing keyspaces, within a specific database.
The Database Admin class name varies by client.
The C# client uses IDatabaseAdmin.
Result
Returns an IDatabaseAdmin object that can perform administrative actions on the specified database.
Parameters
Use the GetAdmin method from the Database class.
Method signature
public IDatabaseAdmin GetAdmin(GetAdminOptions options = null);public TAdmin GetAdmin<TAdmin>(
GetAdminOptions options = null
) where TAdmin : IDatabaseAdmin;| Name | Type | Summary |
|---|---|---|
|
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 get a database admin object.
Get a database admin from a database
using DataStax.AstraDB.DataApi;
using DataStax.AstraDB.DataApi.Core;
namespace Examples;
public class Program
{
static void Main()
{
// Get an existing database
var client = new DataAPIClient(
new CommandOptions() { Destination = DataAPIDestination.HCD }
);
var database = client.GetDatabase(
"API_ENDPOINT",
DataAPIClient.UsernamePasswordTokenProvider(
"USERNAME",
"PASSWORD"
)
);
var databaseAdmin = database.GetAdmin();
}
}Client reference
For more information, see the client reference.
