PROUTIL DBRESTRICT qualifier

Enables or disables write access to the database for processes other than the specified utility.

Syntax

proutil dbname -C dbrestrict restrict-type restrict-action [ disconnTimeout timeout-value ]

Parameters

db-name
Specifies the database where you are controlling access.
restrict-type

Specifies the operation to allow (restricting other access). Accepted values are:

  • dbadmin—restrict all users except database utilities
  • datamove—restrict all operations except PROUTIL DATAMOVE
  • partitioncopy—restrict all operations except PROUTIL PARTITIONMANAGE COPY
  • rollforward—restrict all operations except RFUTIL ROLL FORWARD
restrict-action

Specifies starting, ending, or querying the status of the restriction. Accepted values are:

  • enable—start the restriction
  • disable—end the restriction
  • status—query the restriction, returning a message indicating if the restriction is enabled or disabled
disconntimeout timeout-value

Specifies a long timeout, in seconds, for connected clients to disconnect from the database. The default is 600 (10 minutes). After the timeout period is exceeded, the utility prompts you to wait for another timeout, cancel the operation, or proceed with immediate disconnection.

Use DBRESTRICT to protect your database from modification by other processes during the execution of the identified utility. When enabled, access is allowed as follows:

  • For DBADMIN, the following is allowed:
    • Database utilities
    • Database brokers
    • PROMON
    • PROSHUT
    • PROUTIL DBRESTRICT (to modify or disable the restriction)
  • For DATAMOVE, the following is allowed:
    • PROUTIL DATAMOVE
    • Database brokers
    • PROMON
    • PROSHUT
    • PROUTIL DBRESTRICT (to modify or disable the restriction)
  • For PARTITIONCOPY, the following is allowed:
    • PROUTIL PARTITIONMANAGE COPY
    • PROUTIL PARTITIONMANAGE VIEW
    • Database brokers
    • PROMON
    • PROSHUT
    • PROUTIL DBRESTRICT (to modify or disable the restriction)
  • For ROLL FORWARD, the following is allowed:
    • RFUTIL ROLL FORWARD
    • PROSTRCT ADD
    • PROSTRCT LIST
    • PROUTIL IDXCHECK
    • PROUTIL IDXANALYS
    • PROUTIL TABANALYS
    • PROUTIL DBANALYS
    • PROUTIL DBRESTRICT (to modify or disable the restriction)

Example

  • Datamove restriction

    The DATAMOVE utility requires restricted access to the database. The following example shows how to enable restricted access on a database named mydb:

    proutil mydb -C dbrestrict datamove enable

    Once you have completed the data move, remove the access restriction as shown:

    proutil mydb -C dbrestrict datamove disable
  • Migrating a restriction from rollforward to datamove

    If you first restrict access to your database for roll forward, you can migrate the restriction to data move without first disabling the roll forward restriction.

    1. Verify that the database is in rollforward restricted mode, as shown:

    proutil mydb -C dbrestrict rollforward status

    2. The following status is returned:

    Restricted Access Mode is enabled for RollForward (17073)

    3. Migrate the restriction:

    proutil mydb -C dbrestrict datamove enable

    4. The following status is returned:

    Database Restricted Access mode has been disabled for RollFoward (17039)
Database Restrict Access has been enabled for DataMove (17037)

Notes

  • Your database restriction status is shown in the PROMON Database Status displays.
  • In the read-only VST (virtual system table) _dbStatus, the field _DbStatus-RestrictMode shows the status of a restricted mode. The field is labelled "Restricted Access Mode", and the valid field values are DataMove, Rollforward, and disabled. Apart from these values, _DbStatus-RestrictMode also includes dbadmin as one of the field values. But since no end users, such as ABL, can access the database if dbadmin is enabled, you never see the result as _DbStatus-RestrictMode = dbadmin. Further, if dbadmin is disabled, you see a value of _DbStatus-RestrictMode = disabled.
  • You can enable or disable DBRESTRICT DBADMIN while the database is online. Other restricted modes must be enabled and finally disabled when the database is offline. For example, the source database must be in restricted mode for DATAMOVE to execute, which is enabled offline. Then, you can start both the source and target databases in multi-user mode to execute multiple data moves, and you can turn off the restriction offline.
  • When your database is enabled for restricted access in dbadmin mode, the Replication server starts with the database broker. For other restriction modes, when you run DBRESTRICT on a Replication source database, you must supply all your replication parameters to start a broker, but the replication server will not start until you have disabled the restriction.

  • You cannot run DBRESTRICT ROLLFORWARD, DBRESTRICT PARTITIONCOPY, or DBRESTRICT DATAMOVE when DBRESTRICT DBADMIN is enabled. If you do, the operation fails with a 17072 message.