Reservation Mode

Reservation Mode is an administrative feature that restricts access to a running OLAP database.

Enabling Reservation Mode restricts database access to administrators by terminating all non-administrative sessions and blocking new connections from non-administrator users.

Use Reservation Mode to isolate the database from regular user activity during maintenance, data migrations, or other critical operations.

Permissions and access control

Only these users can manage Reservation Mode:

  • Users with the Administer OLAP Database permission in the database's application. This permission is evaluated through the repository security model.
  • System tenant users with the Administer Farm permission.
Non-administrator users cannot change the Reservation Mode state.
Note: When Reservation Mode is enabled, only administrators can connect to the database.

Persistence and visibility

The Reservation Mode state is stored in the database configuration and remains enabled across restarts. If the database is restarted when Reservation Mode is enabled, the lock is automatically re-applied during startup. The database remains locked until you disable Reservation Mode.

The current state of Reservation Mode is displayed in the database properties, and you can retrieve it through an API. The current state is reported as a Boolean value.

How Reservation Mode works

Reservation Mode controls access to an OLAP database by applying or removing an administrative lock that restricts the connections for non-administrator users.

Reservation Mode enabled for a running database

When Reservation Mode is enabled for a running database, these scenarios occur:

  • The lock state is stored in the database configuration.
  • The lock is applied immediately to the OLAP database.
  • All currently connected non-administrator users are disconnected.
  • Any subsequent connection attempt by a non-administrator user is rejected with a locked by admin error.

Reservation Mode disabled for a running database

When Reservation Mode is disabled for a running database, these scenarios occur:

  • The lock configuration is cleared.
  • The database lock is released.
  • All users can connect to the database as usual.

Reservation Mode state changed for a stopped database

When the Reservation Mode state is changed for a stopped database, these scenarios occur:

  • The lock state is updated in the database configuration.
  • The configured lock state is applied when the database is started.

Auditing

Each Reservation Mode enablement or disablement operation generates an audit entry with these details:

  • Event name: Enable Reservation Mode
  • Event ID: 5002
  • Category: Administration

An audit entry includes the database name, cluster node, operation type (enabled or disabled), and result status.

Scenario-based behavior

This table shows the Reservation Mode behavior by scenario:

Scenario Behavior
Non-administrator user tries to connect. The connection is rejected with the 201 error: Locked for administrative purposes.
Administrator connects to a locked database. The connection is allowed.
Internal or system user connects to a locked database. The connection is allowed.
Database restarts when locked. The lock is re-applied during startup.
Reservation Mode is enabled in a stopped database. The database configuration is saved. The lock is applied at the next startup.
Reservation Mode is enabled in a running database. The lock is applied immediately, and non-administrator users are disconnected.

Common use cases

Reservation Mode is commonly used for these purposes:

  • Maintenance windows: Performing structural changes, rule updates, and data connections.
  • Data migration: Preventing concurrent changes during import or restoring operations.
  • Troubleshooting: Isolating the database during issue investigation.