Toggle Databases State Operation
(Enable / Disable)
-
Use
ToggleDatabasesStateOperationto enable/disable a single database or multiple databases. -
The database will be enabled/disabled on all nodes in the database-group.
-
In this page:
Enable database
// Define the toggle state operation
// specify the database name & pass 'false' to enable
var enableDatabaseOp = new ToggleDatabasesStateOperation("Northwind", disable: false);
// To enable multiple databases use:
// var enableDatabaseOp =
// new ToggleDatabasesStateOperation(new [] { "DB1", "DB2", ... }, disable: false);
// Execute the operation by passing it to Maintenance.Server.Send
var toggleResult = documentStore.Maintenance.Server.Send(enableDatabaseOp);// Define the toggle state operation
// specify the database name(s) & pass 'false' to enable
var enableDatabaseOp = new ToggleDatabasesStateOperation(new [] { "Foo", "Bar" }, disable: false);
// Execute the operation by passing it to Maintenance.Server.SendAsync
var toggleResult = await documentStore.Maintenance.Server.SendAsync(enableDatabaseOp);
Disable database
// Define the toggle state operation
// specify the database name(s) & pass 'true' to disable
var disableDatabaseOp = new ToggleDatabasesStateOperation("Northwind", disable: true);
// To disable multiple databases use:
// var disableDatabaseOp =
// new ToggleDatabasesStateOperation(new [] { "DB1", "DB2", ... }, disable: true);
// Execute the operation by passing it to Maintenance.Server.Send
var toggleResult = documentStore.Maintenance.Server.Send(disableDatabaseOp);// Define the toggle state operation
// specify the database name(s) & pass 'true' to disable
var disableDatabaseOp = new ToggleDatabasesStateOperation("Northwind", disable: true);
// Execute the operation by passing it to Maintenance.Server.SendAsync
var toggleResult = await documentStore.Maintenance.Server.SendAsync(disableDatabaseOp);
Syntax
// Available overloads:
public ToggleDatabasesStateOperation(string databaseName, bool disable)
public ToggleDatabasesStateOperation(string[] databaseNames, bool disable)| Parameter | Type | Description |
|---|---|---|
| databaseName | string | Name of database for which to toggle state |
| databaseNames | string[] | List of database names for which to toggle state |
| disable | bool | true - request to disable the database(s)false- request to enable the database(s) |
// Executing the operation returns the following object:
public class DisableDatabaseToggleResult
{
public bool Disabled; // Is database disabled
public string Name; // Name of the database
public bool Success; // Has request succeeded
public string Reason; // Reason for success or failure
}
Related Articles