HELPLIB.HLB  —  RMU72  Set  After Journal, Command Qualifiers

1  –  Add

    Add=(keyword, ...)

    Adds an .aij file to the after-image journal file configuration.
    You can add an .aij file while users are attached to the
    database. If you specify the Suppress, Drop, or Alter qualifiers
    in the same RMU Set After_Journal command, they are processed
    before the Add qualifier. The Add qualifier can appear several
    times in the same command.

    Specify an .aij file to add by using the following keywords:

    o  Name=name

       Specifies a unique name for the after-image journal object
       to be added. An after-image journal object is the .aij file
       specification plus all of its attributes, such as allocation,
       extent, and backup file name.

       This keyword is required.

    o  File=file

       Specifies the file for the journal to be added. This keyword
       is required. If you do not provide a full file specification,
       and only the file name, the file is placed in your current
       directory. If more than one journal resides in the same
       directory, each journal must have a unique file name. However,
       each fixed-size journal file should be located on a separate
       device. This minimizes risks associated with journal loss or
       unavailability should a device fail or be brought off line.
       For example, if two or more journal files reside on the same
       failed device, the loss of information or its unavailability
       is far greater than that of a single journal file.

    o  Backup_File=file

       Specifies the file to be used for automatic backup operations.
       This keyword is optional. If you specify a file name, but
       not a file extension, the .aij file extension is used by
       default. If you supply only a file name (not a complete file
       specification), the backed up .aij file is placed in the
       database root file directory.

    o  Edit_Filename=(option)

       Specifies an edit string to apply to the backup file
       when an .aij is backed up automatically. This keyword is
       optional. However, if it is specified, the Backup_File=file
       keyword must be specified also. When you specify the Edit_
       Filename=(options) keyword, the .aij backup file name is
       modified by appending the options you specify.

       See the description of the Edit_Filename keyword for the
       Backups qualifier for a list of the available keyword options.

       This keyword and the options you specify affect the backup
       file name of the .aij file specified with the associated Name
       keyword only. If you want the same edit string applied to all
       backed up .aij files, you might find it more efficient to use
       the Backups qualifier with the Edit_Filename keyword instead
       of the Add qualifier with the Edit_Filename keyword.

       If you use a combination of the Edit_Filename keyword with the
       Add qualifier and the Edit_Filename keyword with the Backups
       qualifier, the Add qualifier keyword takes precedence over the
       Backups qualifier keyword for the named .aij file. In other
       words, the options you specify with Edit_Filename keyword
       to the Backups qualifier are applied to all backed up .aij
       files except those for which you explicitly specify the Edit_
       Filename keyword with the Add qualifier. See Example 6.

       This keyword is useful for creating meaningful file names for
       your backup files and makes file management easier.

    o  Allocation=number-blocks

       Sets the initial size, in disk blocks, of the .aij file. If
       this keyword is omitted, the default allocation is used.
       The minimum valid value is 512, the maximum value is eight
       million. The default is 512.

       See the Oracle Rdb Guide to Database Maintenance for guidance
       on setting the allocation size.

    o  Extent=number-blocks

       Specifies the maximum size to extend an .aij file if it is,
       or becomes, an extensible .aij file (in blocks). (If the
       number of available after-image journal files falls to one,
       extensible journaling is employed.)

       If there is insufficient free space on the .aij file device,
       the journal is extended using a smaller extension value than
       specified. However, the minimum, and default, extension size
       is 512 blocks.

       See the Oracle Rdb Guide to Database Maintenance for guidance
       on setting the extent size.

2  –  AIJ Options

    AIJ_Options=OptionsFile

    Specifies an options file name. The default extension is .opt.
    The OptionsFile is the same as that generated by an RMU Show
    After_Journal command and is also used by the RMU Copy_Database,
    Move_Area, Restore, and Restore Only_Root commands. The AIJ_
    Options qualifier may be used alone or in combination with other
    RMU Set After_Journal command qualifiers.

3  –  Allocation

    Allocation=number-blocks

    Sets the default .aij file allocation. You can change the
    allocation while users are attached to the database. If the
    Allocation qualifier is omitted, the default allocation is
    unchanged.

    The minimum value you can specify is 512. The default is also
    512.

    See the Oracle Rdb Guide to Database Maintenance for guidance on
    setting the allocation size.

4  –  Alter

    Alter=(keyword,...)

    Specifies that an after-image journal object be altered.

    You can alter an after-image journal object while users are
    attached to the database. The Alter qualifier can be used
    several times within the same RMU Set After_Journal command.
    If you specify a previously suppressed .aij file with the
    Alter qualifier, that named .aij file is unsuppressed. Oracle
    RMU performs this unsuppress action as soon as the command is
    processed.

    The changes specified by the Alter qualifier are stored in the
    database root file (and thus are visible in the dump file if you
    issue an RMU Dump command), but the changes are not applied to
    the .aij file until it is re-created (or backed up, in the case
    of the Backup_File= file keyword). A new extensible .aij file is
    re-created, for example, when the following are true:

    o  Fast commit is enabled.

    o  Extensible after-image journaling is being used.

    o  Users are actively updating the database.

    o  You issue an RMU Backup After_Journal command with the
       Noquiet_Point qualifier.

    Backing up an extensible .aij file does not ensure that a new
    .aij file will be created. In most cases, the existing .aij file
    is truncated and reused.

    Specify an after-image journal object to alter by using the
    following keywords:

    o  Name=name

       Specifies the name of the after-image journal object. This
       is a required keyword that must match the name of an existing
       after-image journal object.

    o  File=file

       This option only takes effect if a journal is, or becomes,
       an extensible .aij file and only when that journal is re-
       created. This option allows you to supply a new .aij file
       specification to be used for the extensible .aij file if and
       when it is re-created. This can be used to move the re-created
       .aij file to a new location. If you do not provide a full file
       specification, and only the file name, the file is placed in
       your current directory. See the general description of the
       Alter qualifier for an example of when an extensible .aij file
       is re-created.

       This option cannot be used to move a fixed-size .aij file. To
       move a fixed-size .aij file, you must first create a new .aij
       file and then drop the existing .aij file.

       This keyword is optional.

    o  Backup_File=file

       Specifies a new file to be used for automatic backup
       operations.

       This keyword is optional.

    o  Edit_Filename=(options)

       Specifies a new edit string to apply to the backup file
       name of the named .aij file when the .aij is backed up
       automatically. This keyword is optional. See the description
       of the Edit_Filename keyword for the Backups qualifier for a
       list of the available keyword options.

    o  Allocation=number-blocks

       Specifies the initial size of the .aij file that is re-created
       if that file is, or becomes, a fixed-size .aij file.

    o  Extent=number-blocks

       Specifies the extent size of the .aij file that is re-created
       if it is, or becomes, extensible.

       See the Oracle Rdb Guide to Database Maintenance for guidance
       on setting the extent size.

5  –  Backups

    Backups=(keyword_list)

    Specifies options to control the AIJ backup server. You can
    select one or more of the following keywords:

    o  Automatic

       Specifies that the AIJ backup server will run automatically,
       as required. You cannot specify both the Automatic and Manual
       keywords. If neither the Automatic nor the Manual keyword is
       specified, the backup server state is unchanged.

    o  Manual

       Specifies that the RMU Backup After_Journal command will be
       used to back up the .aij files. The AIJ backup server will
       not run automatically. You cannot specify both Automatic
       and Manual keywords. If neither the Automatic nor the Manual
       keyword is specified, the backup server state is unchanged.

    o  Backup_File=file

       Specifies a default file specification for the AIJ backup
       server to use as the backup file name if no backup file name
       is associated with the .aij file to be backed up.

    o  Nobackup_File

       Specifies that there is no default backup file specification.
       Omission of this keyword retains the current default backup
       file specification.

    o  Edit_Filename=(options)

       The Edit_Filename keyword specifies an edit string to apply
       to .aij files when they are backed up automatically. When
       the Edit_Filename=(options) keyword is used, the .aij backup
       file names are edited by appending any or all of the values
       specified by the following options to the backup file name:

       -  Day_Of_Year

          The current day of the year expressed as a 3-digit integer
          (001 to 366).

       -  Day_Of_Month

          The current day of the month expressed as a 2-digit integer
          (01 to 31).

       -  Hour

          The current hour of the day expressed as a 2-digit integer
          (00 to 23).

       -  Julian_Date

          The number of days passed since 17-Nov-1858.

       -  Minute

          The current minute of the hour expressed as a 2-digit
          integer (00 to 59).

       -  Month

          The current month expressed as a 2-digit integer (01 to
          12).

       -  Sequence

          The journal sequence number of the first journal in the
          backup operation.

       -  Vno

          Synonymous with the Sequence option. See the description of
          the Sequence option.

       -  Year

          The current year (A.D.) expressed as a 4-digit integer.

       If you specify more than one option, place a comma between
       each option.

       The edit is performed in the order specified. For example, the
       file backup.aij and the keyword EDIT_FILENAME=(HOUR, MINUTE,
       MONTH, DAY_OF_MONTH, SEQUENCE) creates a file with the name
       backup_160504233.aij when journal 3 is backed up at 4:05 P.M.
       on April 23rd.

       You can make the name more readable by inserting quoted
       strings between each Edit_Filename option. For example, the
       option shown in the following code adds the string "$30_0155-
       2" to the .aij file name if the day of the month is the 30th,
       the time is 1:55 and the version number is 2:

       /EDIT_FILENAME=("$",DAY_OF_MONTH,"_",HOUR,MINUTE,"-",SEQUENCE)

       This keyword is useful for creating meaningful file names for
       your backup files and makes file management easier.

       If you use a combination of the Edit_Filename keyword with
       the Add qualifier and the Edit_Filename keyword with the
       Backups qualifier, the Add qualifier keyword takes precedence
       over the Backups qualifier keyword for the named .aij file.
       In other words, the options you specify with Edit_Filename
       keyword to the Backups qualifier are applied to all .aij back
       up files except those for which you explicitly specify the
       Edit_Filename keyword with the Add qualifier. See Example 6.

    o  Quiet_Point

       Specifies that the after-image journal backup operation is
       to acquire the quiet-point lock prior to performing an .aij
       backup operation for the specified database. This option
       (as with all the other Backup options) affects only the
       database specified in the RMU Set After_Journal command line.
       For information on specifying that the quiet-point lock be
       acquired before any .aij backup operation is performed on a
       system, see the Usage Notes.

    o  Noquiet_Point

       Specifies that the after-image journal backup operation will
       not acquire the quiet-point lock prior to performing an .aij
       backup operation for the specified database. This option (as
       with all the other Backup options) affects only the database
       specified in the RMU Set After_Journal command line. For
       information on specifying that the quiet-point lock will not
       be acquired prior to any .aij backup operations performed on a
       system, see the Usage Notes.

6  –  Cache

    Cache=file
    Nocache

    Specifies an after-image journal cache file specification on a
    solid-state disk. If the Cache qualifier is specified, after-
    image journal caches are enabled. If you specify a file name, but
    not a file extension, the file extension .aij is used by default.

    If the Nocache qualifier is specified, AIJ caches are disabled.
    You can use this qualifier only when users are detached from the
    database.

    This file must be written to a solid-state disk. If a solid-state
    disk is not available, after-image journal caching should not be
    used. Unless you are involved in a high performance, high-volume
    environment, you probably do not need the features provided by
    this qualifier.

    You can determine whether the cache file is accessible by
    executing the RMU Dump command with the Header qualifier. If
    caching is enabled, but the cache file is unavailable, the cache
    file is marked inaccessible and after-image journaling continues
    as if caching was disabled. Once the cache file has been marked
    inaccessible, it will remain so marked until either the existing
    cache file is dropped from the database, or a new cache file is
    added to the database (even if this is the same cache file as was
    previously used).

    If this qualifier is omitted, the AIJ cache state remains
    unchanged.

7  –  Disable

    Disable

    Disables after-image journaling if it has already been enabled.
    If after-image journaling has already been disabled, this
    qualifier has no effect. You can specify the Disable qualifier
    only when users are detached from the database.

    When the Disable qualifier and other qualifiers are specified
    with the RMU Set After_Journal command, after-image journaling is
    disabled before other requested operations.

    There is no default for the Disable qualifier. If you do not
    specify either the Disable or Enable qualifier, the after-image
    journaling state remains unchanged.

8  –  Drop

    Drop=(Name=name)

    Specifies that the named after-image journal object be deleted.
    You can drop an after-image journal object while users are
    attached to the database, but the named after-image journal
    object must not be the current .aij file or be waiting to be
    backed up. When the Drop qualifier is specified with the Alter
    or Add qualifiers on the RMU Set After_Journal command, the named
    after-image journal object is dropped before any after-image
    journal objects are altered or added.

    Each after-image journal object to be deleted is specified by
    the required keyword, Name=name. This specifies the name of the
    after-image journal object to be dropped, which must match the
    name of an existing after-image journal object.

9  –  Enable

    Enable

    Enables after-image journaling if it has been disabled. You can
    specify the Enable qualifier only when users are detached from
    the database and at least one unmodified .aij file is available
    (unless you also specify the Overwrite qualifier). After-image
    journaling is enabled after other specified qualifiers have been
    processed.

10  –  Extent

    Extent=number-blocks

    Sets the size, in blocks, of the default .aij file extension.
    This qualifier has no effect on fixed-length .aij files. This
    qualifier can be used while users are attached to the database.

    The minimum valid number-blocks value is 512. The default is also
    512.

    If the Extent qualifier is omitted, the default extension remains
    unchanged.

    See the Oracle Rdb Guide to Database Maintenance for guidance on
    setting the extent size.

11  –  Log

    Log
    Nolog

    Specifies whether the processing of the command is reported to
    SYS$OUTPUT. Specify the Log qualifier to request log output and
    the Nolog qualifier to prevent it. If you specify neither, the
    default is the current setting of the DCL verify switch. (The DCL
    SET VERIFY command controls the DCL verify switch.)

12  –  Notify

    Notify=(operator-class-list)
    Nonotify

    Sets the operator notification state for after-image journaling
    and selects the operators to be notified when the journaling
    state changes. Oracle RMU uses the OpenVMS operator communication
    manager (OPCOM). The following events evoke operator
    notification:

    o  An error writing to an .aij file.

    o  No .aij file is available for write operations.

    o  The .aij file has been overwritten.

    o  The RMU Backup After_Journal command fails.

    You can use this qualifier while users are attached to the
    database. If you specify the Nonotify qualifier, operator
    notification is disabled. If the qualifier is omitted, the
    operator notification state is unchanged.

    The operator classes follow:

    o  [No]All

       The All operator class broadcasts a message to all terminals
       that are attached to the system or cluster. These terminals
       must be turned on and have broadcast-message reception
       enabled. The Noall operator class inhibits the display of
       messages to the entire system or cluster.

    o  [No]Central

       The Central operator class broadcasts messages to the central
       system operator. The Nocentral operator class inhibits the
       display of messages to the central system operator.

    o  [No]Disks

       The Disks operator class broadcasts messages pertaining to
       mounting and dismounting disk volumes. The Nodisks operator
       class inhibits the display of messages pertaining to mounting
       and dismounting disk volumes.

    o  [No]Cluster

       The Cluster operator class broadcasts messages from the
       connection manager pertaining to cluster state changes. The
       Nocluster operator class inhibits the display of messages from
       the connection manager pertaining to cluster state changes.

    o  [No]Security

       The Security operator class displays messages pertaining to
       security events. The Nosecurity operator class inhibits the
       display of messages pertaining to security events.

    o  [No]Oper1 through [No]Oper12

       The Oper1 through Oper12 operator classes display messages
       to operators identified as OPER1 through OPER12. The Nooper1
       through Nooper12 operator classes inhibit messages from being
       sent to the specified operator.

                                   NOTE

       Use the Notify qualifier conservatively. Be sure that
       messages regarding a private database are not broadcast
       to an entire system or cluster of users who may not be
       interested in the broadcast information. Similarly, be
       conservative regarding even a clusterwide database. You
       do not want to overload the operators with insignificant
       messages.

13  –  Overwrite

    Overwrite
    Nooverwrite

    The Overwrite qualifier specifies that .aij files can be
    overwritten without first being backed up. The Nooverwrite
    qualifier specifies that only an .aij file that has been backed
    up can be overwritten. You can specify the Nooverwrite qualifier
    only when users are detached from the database. If you do
    not specify either the Overwrite qualifier or the Nooverwrite
    qualifier, the Overwrite characteristic remains unchanged.

    This qualifier is ignored if only one .aij file is available.
    When you specify the Overwrite qualifier, it is only activated
    when two or more .aij files are, or become, available.

    Note that if you use the Overwrite qualifier, you will be unable
    to perform a rollforward from a restored backup file. Most users
    will not want to use the Overwrite qualifier; it is provided for
    layered applications that might want to take advantage of some
    performance features provided by Oracle Rdb that require after-
    image journaling, but where the use of after-image journaling is
    not required for the application to run reliably.

14  –  Reserve

    Reserve=number-journals

    Reserves additional space in the after-image journal
    configuration for the specified number of .aij files. You can
    specify the Reserve qualifier only when users are detached from
    the database. If you do not specify the Reserve qualifier, no
    space is reserved for additional .aij files.

    Note that you cannot reserve space in a single-file database for
    .aij files by using this qualifier with the RMU Set After_Journal
    command. After-image journal file reservations for a single-
    file database can be made only when you use the RMU Convert, RMU
    Restore, or RMU Copy_Database commands.

    Note that once you reserve space in the journal configuration
    (using the Reserve=n qualifier), the reservations are permanent.
    There is no way to unreserve this space unless you back up and
    restore the database. Specify fewer reservations with RMU Restore
    command After_Journal qualifier.

    Each reservation uses two blocks of space in the root file and
    the run-time global sections.

    When you reserve journals slots to create additional journals
    for your journal system, the reserve operation is not journaled.
    Therefore, you should perform a full database backup operation to
    ensure database consistency.

15  –  Shutdown Timeout

    Shutdown_Timeout=minutes

    Modifies the after-image journal shutdown time in the event that
    after-image journaling becomes unavailable. The after-image
    journaling shutdown time is the period, in minutes, between
    the point when after-image journaling becomes unavailable and
    the point when the database is shut down. During the after-
    image journaling shutdown period, all database update activity
    is stalled.

    If operator notification has been enabled, operator messages are
    broadcast to all enabled operator classes and to the RMU Show
    Statistics screen at 1-minute intervals.

    To recover from the after-image journaling shutdown state
    and to resume normal database operations, you must make an
    .aij file available for use. You can do this by backing up an
    existing modified journal, or, if you have a journal reservation
    available, by adding a new journal to the after-image journaling
    configuration. If you do not make a journal available before the
    after-image journal shutdown time expires, the database is shut
    down and all active database attaches are terminated.

    The after-image journaling shutdown period is only in effect when
    fixed-size AIJ journaling is used. When a single extensible .aij
    file is used, the default action is to shut down all database
    operations when the .aij file becomes unavailable.

    If you do not specify the Shutdown_Timeout qualifier, the
    database shuts down 60 minutes after the after-image journaling
    configuration becomes unavailable. The maximum value you can
    specify for the Shutdown_Timeout qualifier is 4320 minutes (3
    days).

16  –  Suppress

    Suppress=(Name=name)

    Prevents further use of the named after-image journal object. The
    named after-image journal object must be an existing after-image
    journal object.

    This qualifier is useful when you want to temporarily disallow
    the use of an .aij file. For example, suppose the disk containing
    the next .aij file to use goes off line. You do not want the
    database to attempt to access that file until the disk is back on
    line. Use the Suppress qualifier so the database does not attempt
    to access the specified .aij file. When the disk is back on line,
    use the RMU Set After_Journal command with the Alter qualifier
    to unsuppress the after-image journal object that references this
    .aij file.

    You can specify the Suppress qualifier while users are attached
    to the database, but the .aij file referenced by the after-image
    journal object must not be the current journal or be waiting
    to be backed up. You must back up the referenced .aij file
    before the after-image journal object that references it can
    be suppressed.

    The Suppress qualifier is processed prior to any Drop, Add, or
    Alter qualifiers specified with the same command.

17  –  Switch Journal

    Switch_Journal

    Changes the currently active .aij file to the next available .aij
    file in a fixed-size after-image journaling configuration.

    In an extensible journal file configuration, the Switch_Journal
    qualifier has no effect and is ignored if specified.

    The Switch_Journal qualifier is useful for forcing a switch to an
    .aij file on another disk when you want to perform maintenance on
    the disk containing the currently active journal file.

    You cannot specify the Switch_Journal qualifier and the Enable
    or the Disable qualifier on the same command line. In addition,
    after-image journaling must be enabled when you issue the Switch_
    Journal qualifier.

    It is seldom necessary to specify this option because normally a
    switch occurs automatically.
Close Help