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.
To perform administrative actions outside of a specific database, see Get an Astra DB admin (C#) instead.
The Database Admin class name varies by client.
The C# client uses IDatabaseAdmin.
|
You need an application token with permission to interact with the target database, such as the Database Administrator role. For more information, see Get endpoint and token. |
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;
namespace Examples;
public class Program
{
static void Main()
{
// Get an existing database
var client = new DataAPIClient();
var database = client.GetDatabase(
"API_ENDPOINT",
"APPLICATION_TOKEN"
);
var databaseAdmin = database.GetAdmin();
}
}Get a database admin from an admin
The C# client doesn’t support this method of getting a database admin object.
Client reference
For more information, see the client reference.
