12.3.1 dbbackup.bat (backing up the database)
- Organization of this subsection
(1) Function
Logically backs up the database used by JP1/DH - Server.
(2) Executor
A user with a built-in Administrator account or with Administrator permissions executes the command from the command prompt.#
- #
-
Do not execute a command directly. Use the command prompt to execute a command.
(3) Format
dbbackup.bat DB-password backup-destination-folder [backup-file-name]
(4) Arguments
- DB-password
-
Specify the database password.
- backup-destination-folder
-
Specify the destination folder to output the database backup file with an absolute path.
Specify the absolute path length no more than 200 bytes.
- backup-file-name (optional)
-
Specify the name of the database backup file with an absolute path.
If you omit this argument, the backup file is created with the name of dbbackup.dump.
(5) Execution results
A backup file is output in the specified destination folder.
(6) Return codes
|
Return code |
Description |
Operation after an event occurrence |
Occurrence condition |
|---|---|---|---|
|
0 |
Normal |
-- |
Backup succeeded. |
|
4 |
Warning |
Interrupts command processing. |
Execution of command is canceled during overwrite-confirmation response. |
|
8 |
Warning |
Interrupts command processing. |
|
|
16 |
Error |
Interrupts command processing. |
Backup failed. |
(7) Output message (Output destination: stdout)
|
No. |
Message |
Return code |
Operation after an event occurrence |
Action to be taken by the operator |
Occurrence condition |
|---|---|---|---|---|---|
|
1 |
The backup will start. |
-- |
Starts command execution. |
None |
When a command is executed |
|
2 |
Successfully finished the backup. Press any key. |
0 |
Terminates command execution. |
None |
When backup succeeded |
|
3 |
Specify the DB password in the argument. Press any key and try again. |
8 |
Terminates command execution. |
Specify the database password as the argument, and then re-execute the command. |
When a command is executed without the database password specified as the argument |
|
4 |
Specify the backup folder in the argument. |
8 |
Terminates command execution. |
Specify the backup destination folder as the argument, and then execute the command. |
When a command is executed without the argument specified |
|
5 |
The specified folder does not exist. Press any key and try again. |
8 |
Terminates command execution. |
Make sure that the specified backup destination folder is correct. |
When an incorrect folder is specified as the argument |
|
6 |
Did not successfully finish the backup. Press any key and try again.# |
16 |
Terminates command execution. |
Check the following and re-execute the command:
|
When backup failed |
|
7 |
******* exists in the backup folder. Overwrite the output information? (y/n) |
-- |
Waits for user response. |
Select y to continue execution, or n to cancel execution. |
When a backup file already exists in the backup destination folder |
|
8 |
Canceled command execution. Press any key. |
4 |
Terminates command execution. |
If you selected n in No. 7, agree to the confirmation item and then press any key. |
When n is selected in No. 7 |
#: If an error occurs within the database, this error message is output after an error message is output by the database.
(8) Notes on using the command
Do not execute a command directly. Use the command prompt to execute a command.
If you have enabled UAC (User Account Control) in the operating system, use one of the following ways to execute a command:
-
Log in as a built-in Administrator user, start the command prompt, and then execute a command.
-
Log in as a user with Administrator permissions, start the command prompt by clicking Run as Administrator, and then execute a command.
-
Execute a command from a shortcut for the command prompt with the elevated privileges created at the time of JP1/DH - Server installation.#
- #
-
If you use a command prompt in this way in Windows Server 2012, Windows Server 2012 R2 or Windows Server 2016, you need to install Microsoft .NET Framework 3.5. For details about how to install Microsoft .NET Framework 3.5, see D. Installing .NET Framework 3.5.
If the command is interrupted due to an error in the database, a backup file with a size of 0 bytes is created.
Simultaneous executions of commands on the same machine are not supported.