FirebirdSQL logo

-⁠ROLE

Role name for privileges.

Syntax
-RO[LE] role-name

Allows the specification of the role to be used by the connecting user.

-⁠SE[RVICE]

Perform backup or restore through service manager.

Syntax
-SE[RVICE] service-name

This switch causes gbak to backup or restore a remote database via the service manager.This causes the backup file to be created or read on the remote server, so the path format and filename must be valid on the remote server.For Firebird 3.0 and earlier, the servicename must always end in service_mgr.

More details on the syntax of service-name can be found in [gbak-recipies-remote].

Note

You can use this option to connect to a locally hosted database as well.If you do, taking a backup or restoring using this option can run quicker than accessing the database directly.See also [gbak-backup-speedup].

-⁠SKIP_D[ATA]

Exclude table data from backup or restore for matching table names.

Syntax
-SKIP_D[ATA] sql-regex

The backup or restore skips the data for table(s) matching the SQL regular expression argument.Opposite of [gbak-cmdline-include-data].To skip all data, use [gbak-cmdline-meta-data].

The metadata of the table is included, only their data is skipped.

Warning

Excluding data from a backup or restore can yield errors during restore when constraints are enabled, and a foreign key constraint exists on a table not excluded, depending on a table that was excluded.

You can use [gbak-cmdline-inactive] to disable all indices, primary key, unique key and foreign key constraints.If CHECK constraints depend on excluded data, you may also need to specify [gbak-cmdline-no-validity].

The SQL regular expression syntax is documented in theFirebird 5.0 Language Reference.

Note
Introduced in Firebird 3.0.

-⁠INCLUDE[_DATA]

Includes table data in the backup or restore for matching table names only.

Syntax
-INCLUDE[_DATA] sql-regex

The backup or restore only includes data for table(s) matching the SQL regular expression argument.Opposite of [gbak-cmdline-skip-data].

The metadata of non-matching tables is included, only their data is skipped.

Warning

Selectively including data in a backup or restore can yield errors during restore when constraints are enabled, and a foreign key constraint exists on a table that was included, depending on a table that was not included.

You can use [gbak-cmdline-inactive] to disable all indices, primary key, unique key and foreign key constraints.If CHECK constraints depend on not included data, you may also need to specify [gbak-cmdline-no-validity].

The SQL regular expression syntax is documented in theFirebird 5.0 Language Reference.

Note
Introduced in Firebird 5.0.