Toggle Databases State Operation
(Enable / Disable)

Enable database:

// Define the toggle state operation
// specify the database name & pass 'false' to enable
$enableDatabaseOp = new ToggleDatabasesStateOperation("Northwind", false);

// To enable multiple databases use:
// $enableDatabaseOp = new ToggleDatabasesStateOperation([ "DB1", "DB2", ... ], false);

// Execute the operation by passing it to Maintenance.Server.Send
/** @var DisableDatabaseToggleResult $toggleResult */
$toggleResult = $documentStore->maintenance()->server()->send($enableDatabaseOp);

Disable database:

// Define the toggle state operation
// specify the database name(s) & pass 'true' to disable
$disableDatabaseOp = new ToggleDatabasesStateOperation("Northwind", true);

// To disable multiple databases use:
// $disableDatabaseOp = new ToggleDatabasesStateOperation([ "DB1", "DB2", ... ], true);

// Execute the operation by passing it to Maintenance.Server.Send
/** @var DisableDatabaseToggleResult $toggleResult */
$toggleResult = $documentStore->maintenance()->server()->send($disableDatabaseOp);

Syntax:

class ToggleDatabasesStateOperation(ServerOperation[DisableDatabaseToggleResult]):
    def __init__(self, database_name: str, disable: bool): ...
    @classmethod
    def from_multiple_names(cls, database_names: List[str], disable: bool): ...

class DisableDatabaseToggleResult:
    def __init__(
        self, disabled: bool = None, name: str = None, success: bool = None, reason: str = None
    ) -> None:
        self.disabled = disabled  # Is database disabled
        self.name = name  # Name of the database
        self.success = success  # Has request succeeded
        self.reason = reason  # Reason for success or failure

It may sometimes be useful to disable a database manually, through the file system.

• To manually disable a database:

  • Place a file named disable.marker in the database directory.
  • The disable.marker file can be empty,
    and can be created by any available method, e.g. using the File Explorer, a terminal, or code.

• Attempting to use a manually disabled database will generate the following exception:

   Unable to open database: '{DatabaseName}', 
   it has been manually disabled via the file: '{disableMarkerPath}'. 
   To re-enable, remove the disable.marker and reload the database.
  

• To enable a manually disabled database:

  • First, remove the disable.marker file from the database directory.
  • Then, reload the database.