Table of Contents

Class AstraDatabasesAdmin

Namespace
DataStax.AstraDB.DataApi.Admin
Assembly
DataStax.AstraDB.DataApi.dll

Provides administrative operations for Astra databases.

public class AstraDatabasesAdmin
Inheritance
AstraDatabasesAdmin
Inherited Members

Examples

var admin = new AstraDatabasesAdmin(client, adminOptions);

Methods

CreateDatabase(CreateDatabaseOptions)

Synchronous version of CreateDatabaseAsync(CreateDatabaseOptions)

public DatabaseAdminAstra CreateDatabase(CreateDatabaseOptions options)

Parameters

options CreateDatabaseOptions

Options for database creation, such as its name, and other settings such as: whether to wait for the DB to become active, timeout settings.

Returns

DatabaseAdminAstra

A DatabaseAdminAstra instance for the created database.

Examples

var adminDb = await admin.CreateDatabaseAsync(new (){Name = "MyDB", CloudProvider = CloudProviderType.AWS, Region = "us-east-2", waitForCompletion = true});
var adminDb = admin.CreateDatabase(new (){Name = "MyDB", CloudProvider = CloudProviderType.AWS, Region = "us-east-2", waitForCompletion = true});

Remarks

This method, by default, will wait for the operation to complete on the server side. Use the options' waitForCompletion attribute to control this behaviour.

CreateDatabaseAsync(CreateDatabaseOptions)

Creates a new database according to the provided options.

public Task<DatabaseAdminAstra> CreateDatabaseAsync(CreateDatabaseOptions options)

Parameters

options CreateDatabaseOptions

Options for database creation, such as its name, and other settings such as: whether to wait for the DB to become active, timeout settings.

Returns

Task<DatabaseAdminAstra>

A DatabaseAdminAstra instance for the created database.

Examples

var adminDb = await admin.CreateDatabaseAsync(new (){Name = "MyDB", CloudProvider = CloudProviderType.AWS, Region = "us-east-2", waitForCompletion = true});

Remarks

This method, by default, will wait for the operation to complete on the server side. Use the options' waitForCompletion attribute to control this behaviour.

DropDatabase(string, DropDatabaseOptions)

Synchronous version of DropDatabaseAsync(string, DropDatabaseOptions).

public void DropDatabase(string dbGuid, DropDatabaseOptions options = null)

Parameters

dbGuid string

The ID of the database to drop.

options DropDatabaseOptions

The command options to use, including the waitForCompletion flag.

Examples

await admin.DropDatabaseAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890", options);
admin.DropDatabase("a1b2c3d4-e5f6-7890-abcd-ef1234567890", options);

Remarks

This method, by default, will wait for the operation to complete on the server side. Use the options' waitForCompletion attribute to control this behaviour.

DropDatabaseAsync(string, DropDatabaseOptions)

Drops the database with the specified ID.

public Task DropDatabaseAsync(string dbGuid, DropDatabaseOptions options = null)

Parameters

dbGuid string

The ID of the database to drop.

options DropDatabaseOptions

The command options to use, including the waitForCompletion flag.

Returns

Task

Examples

await admin.DropDatabaseAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890", options);

Remarks

This method, by default, will wait for the operation to complete on the server side. Use the options' waitForCompletion attribute to control this behaviour.

FindAvailableRegions(FindAvailableRegionsOptions)

Synchronous version of FindAvailableRegionsAsync(FindAvailableRegionsOptions)

public List<RegionInfo> FindAvailableRegions(FindAvailableRegionsOptions options = null)

Parameters

options FindAvailableRegionsOptions

Additional options to the DevOps API query, such as region filters and general request execution parameters.

Returns

List<RegionInfo>

A list of region information matching the provided filters

FindAvailableRegionsAsync(FindAvailableRegionsOptions)

Gets a list of available regions for database creation.

public Task<List<RegionInfo>> FindAvailableRegionsAsync(FindAvailableRegionsOptions options = null)

Parameters

options FindAvailableRegionsOptions

Additional options to the DevOps API query, such as region filters and general request execution parameters.

Returns

Task<List<RegionInfo>>

A list of region information matching the provided filters

GetDatabaseAdmin(string, GetDatabaseAdminOptions)

Returns a DatabaseAdminAstra instance for the database at the specified URL.

public DatabaseAdminAstra GetDatabaseAdmin(string apiEndpoint, GetDatabaseAdminOptions options = null)

Parameters

apiEndpoint string

The API Endpoint for the database, e.g. "https://01234567-89ab-cdef-0123-456789abcdef-us-east1.apps.astra.datastax.com".

options GetDatabaseAdminOptions

Options for the database admin instance.

Returns

DatabaseAdminAstra

GetDatabaseInfo(string, GetDatabaseInfoOptions)

Synchronous version of GetDatabaseInfoAsync(string, GetDatabaseInfoOptions).

public DatabaseInfo GetDatabaseInfo(string dbGuid, GetDatabaseInfoOptions options = null)

Parameters

dbGuid string

The ID of the database.

options GetDatabaseInfoOptions

The command options to use.

Returns

DatabaseInfo

A DatabaseInfo object.

Examples

var info = await admin.GetDatabaseInfoAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890", options);
var info = admin.GetDatabaseInfo("a1b2c3d4-e5f6-7890-abcd-ef1234567890", options);

GetDatabaseInfoAsync(string, GetDatabaseInfoOptions)

Retrieves database information for the specified ID

public Task<DatabaseInfo> GetDatabaseInfoAsync(string dbGuid, GetDatabaseInfoOptions options = null)

Parameters

dbGuid string

The ID of the database.

options GetDatabaseInfoOptions

The command options to use.

Returns

Task<DatabaseInfo>

A DatabaseInfo object.

Examples

var info = await admin.GetDatabaseInfoAsync("a1b2c3d4-e5f6-7890-abcd-ef1234567890", options);

GetDatabaseStatus(string, GetDatabaseStatusOptions)

Synchronous version of GetDatabaseStatusAsync(string, GetDatabaseStatusOptions).

public AstraDatabaseStatus GetDatabaseStatus(string dbGuid, GetDatabaseStatusOptions options = null)

Parameters

dbGuid string

The ID of the target database.

options GetDatabaseStatusOptions

The command options to use.

Returns

AstraDatabaseStatus

A AstraDatabaseStatus value.

GetDatabaseStatusAsync(string, GetDatabaseStatusOptions)

Get the status of the database from the DevOps API.

public Task<AstraDatabaseStatus> GetDatabaseStatusAsync(string dbGuid, GetDatabaseStatusOptions options = null)

Parameters

dbGuid string

The ID of the target database.

options GetDatabaseStatusOptions

The command options to use.

Returns

Task<AstraDatabaseStatus>

A AstraDatabaseStatus value.

ListDatabaseNames(ListDatabaseNamesOptions)

Synchronous version of ListDatabaseNamesAsync(ListDatabaseNamesOptions).

public List<string> ListDatabaseNames(ListDatabaseNamesOptions options = null)

Parameters

options ListDatabaseNamesOptions

Options to run the query for databases, including filters.

Returns

List<string>

A list of the database names.

Examples

var names = await admin.ListDatabaseNamesAsync(options);

ListDatabaseNamesAsync(ListDatabaseNamesOptions)

Returns a list of database names.

public Task<List<string>> ListDatabaseNamesAsync(ListDatabaseNamesOptions options = null)

Parameters

options ListDatabaseNamesOptions

Options to run the query for databases, including filters.

Returns

Task<List<string>>

A list of the database names.

Examples

var names = await admin.ListDatabaseNamesAsync(options);

ListDatabases(ListDatabaseOptions)

Synchronous version of ListDatabasesAsync(ListDatabaseOptions)

public List<DatabaseInfo> ListDatabases(ListDatabaseOptions options = null)

Parameters

options ListDatabaseOptions

Options to run the query for databases, including filters.

Returns

List<DatabaseInfo>

ListDatabasesAsync(ListDatabaseOptions)

Returns a list of database info objects according to the provided query options.

public Task<List<DatabaseInfo>> ListDatabasesAsync(ListDatabaseOptions options = null)

Parameters

options ListDatabaseOptions

Options to run the query for databases, including filters.

Returns

Task<List<DatabaseInfo>>
Edit this page