jajs_dbbackup
- Organization of this page
Format
jajs_dbbackup [-id embedded-database-setup-ID] -o backup-data-storage-directory [-t time]
Description
Creates a backup of the data of an embedded database while JP1/AJS3 is running. The backup data is stored in the backup data storage directory that is specified for the -o option.
This command is available when the backup enhancement function is enabled.
This command is available when the embedded database is active.
Execution privileges
In Windows: Administrators privilege
In UNIX: Superuser privilege
Arguments
-id embedded-database-setup-ID
Use four characters, _JFn (n is 0 to 9 or A to Z), to specify the setup identifier of the embedded database to be backed up. Specify the value specified in the -id option of the ajsembdbbuild command.
If you omit this option, the system assumes _JF0.
-o backup-data-storage-directory
Specify the directory that stores the backup data. Use an absolute path to specify the directory. In Windows, to include space characters in the specified absolute path, enclose the path in double quotation marks (").
You can specify a character string of 1 to 200 bytes. In UNIX, you cannot specify the root directory.
The backup data is output to the following directory, which is located in the directory specified for this option. Note that YYYYMMDD_hhmmss in the directory name means year-month-day_hour-minute-second.
- In Windows
-
Backup-date-storage-directory\BK embedded-database-setup-ID_YYYYMMDD_hhmmss
- In UNIX
-
Backup-date-storage-directory/BK embedded-database-setup-ID_YYYYMMDD_hhmmss
-t time
Specify the timeout value for backup processing. The specified value applies to backup processing, and is not the timeout value for the command execution as a whole.
You can specify a value between 1 and 1,440 for the minute.
The default is 10 minute.
If the backup processing does not terminate within the specified time, the jajs_dbbackup command terminates abnormally.
Space requirements for the backup data storage directory
The amount of free space required for the backup file storage directory differs depending on the embedded database model as shown in the following table.
Database model |
Required free space |
---|---|
Large scale |
About 7,200 MB |
Medium scale |
About 1,900 MB |
Small scale |
About 700 MB |
If the database area has been expanded by using the ajsembdbaddarea command, additional free space equivalent to the area added by the expansion is required. Similarly, if the database auto-increment function is enabled, additional free space equivalent to the area added by the function is required.
For details about the database auto-increment function, see 23.2 Estimating the database area in the JP1/Automatic Job Management System 3 Configuration Guide.
Notes
-
Job execution is suspended while this command is being executed. Therefore, executing this command might cause a delay in the jobnet start time or end time. To minimize the impact on job operation, execute this command when no jobs are to be executed.
-
If the jajs_dbbackup command is executed during job execution, the command might terminate abnormally. If the jajs_dbbackup command terminates abnormally, re-execute it when no jobs are being executed.
-
During backup processing, the following operations on the embedded database to be backed up and scheduler services that run in that embedded database are paused until backup processing terminates:
-
Starting a scheduler service
-
Executing a command that operates a unit defined in the scheduler service
-
Operating a scheduler service from JP1/AJS3 - View
-
Executing a command that operates the embedded database
-
Executing a remote jobnet defined in the scheduler service (executive host)
-
Executing a remote jobnet defined in the scheduler service (execution target host)
-
Operating a scheduler service from JP1/AJS3 - Web Console
-
Adding, deleting, or changing an execution agent or an execution agent group#
#: If the agent management database is stored in the embedded database to be
backed up.
-
-
The jajs_dbbackup command might terminate abnormally if operation is being performed on the embedded database to be backed up or its scheduler service by using JP1/AJS3 - View, the JP1/AJS3 - Web Console, or another command. If the jajs_dbbackup command terminated abnormally, make sure that no operation is being performed on the embedded database or scheduler services that run in the embedded database, and then re-execute the jajs_dbbackup command.
-
To cancel the backup being performed, use the procedure in 2.5.2(4) Canceling the processing to back up the embedded database in the JP1/Automatic Job Management System 3 Administration Guide.
-
If you execute this command as a job, you cannot cancel the backup by performing any of the following operations:
-
Forcibly terminating a running job or jobnet
-
Interrupting a running jobnet
If you perform these operations, backup is not canceled according to the timeout setting. To cancel the backup being performed, use the procedure in 2.5.2(4) Canceling the processing to back up the embedded database in the JP1/Automatic Job Management System 3 Administration Guide.
-
-
Do not execute this command in an environment in which the JP1/AJS3 service does not start normally. If the backup data created in such a JP1/AJS3 environment is used for recovery, a problem might occur in the recovery environment.
-
If you continuously use this command for backup with the same backup data storage directory specified, free space on the disk that contains the backup data storage directory might become insufficient. Periodically delete unnecessary backup data in the backup data storage directory to prevent a shortage of disk space.
Return values
0 |
Normal end |
Values other than 0 |
Abnormal end |
Backup information file (backupinfo.txt)
When backup processing ends normally, this command outputs a backup information file (backupinfo.txt) to the backup data.
The following shows an output example of the backup information file. (backupinfo.txt).
[SETUP-ID] _JF0 [BACKUP START TIME] 2019/06/25 00:00:00 [BACKUP END TIME] 2019/06/25 00:05:00 [BACKUP RESULT] SUCCEEDED
The following shows the meaning of the output.
- [SETUP-ID]
-
Indicates the setup identifier of the embedded database whose backup was created.
- [BACKUP START TIME]
-
Indicates the time when the backup started.
- [BACKUP END TIME]
-
Indicates the time when the backup ended.
- [BACKUP RESULT]
-
Indicates the end status of the backup.
The following shows the statuses that can be displayed:
End status
Meaning
SUCCEEDED
Normal termination
FAILED
Abnormal termination
When you recover data by using the jajs_dbrestore command, you can use backup data for which SUCCEEDED is displayed for this item.
Example
The following command backs up the embedded database (_JF0), and then stores the backup in the backup data storage directory (/backup).
jajs_dbbackup -id _JF0 -o /backup