Built-in system procedures
Derby Reference Manual
154
Built-in system procedures
Some built-in procedures are not compatible with SQL syntax used by other relational
databases. These procedures can only be used with Derby.
SYSCS_UTIL.SYSCS_BACKUP_DATABASE system procedure
The
SYSCS_UTIL.SYSCS_BACKUP_DATABASE
system procedure backs up the
database to a specified backup directory.
Syntax
SYSCS_UTIL.SYSCS_BACKUP_DATABASE(IN BACKUPDIR VARCHAR())
No result is returned from the procedure.
BACKUPDIR
An input argument of type VARCHAR(32672) that specifies the path to a directory,
where the backup should be stored. Relative paths are resolved based on the current
user directory,
user.dir
, of the JVM where the database backup is occurring.
Relative paths are not resolved based on the derby home directory. To avoid
confusion, use the absolute path.
Execute privileges
If authentication and SQL authorization are both enabled, only the
execute privileges on this procedure by default. See "Enabling user authentication" and
"Setting the SQL standard authorization mode" in the Derby Developer's Guide for more
information. The database owner can grant access to other users.
JDBC example
The following example backs up the database to the
c:/backupdir
directory:
CallableStatement cs = conn.prepareCall
("CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE(?)");
cs.setString(1, "c:/backupdir");
cs.execute();
cs.close();
SQL example
The following example backs up the database to the
c:/backupdir
directory:
CALL SYSCS_UTIL.SYSCS_BACKUP_DATABASE('c:/backupdir');
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT system procedure
The
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT
system procedure backs up the
database to a specified backup directory.
If there are any transactions in progress with unlogged operations at the start of the
backup, the
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT
system procedure
returns an error immediately, instead of waiting for those transactions to complete.
Syntax
SYSCS_UTIL.SYSCS_BACKUP_DATABASE_NOWAIT(IN BACKUPDIR VARCHAR())
No result is returned from the procedure.
BACKUPDIR
