ibase_backup
(PHP 5, PHP 7)
ibase_backup — Initiates a backup task in the service manager and returns immediately
Description
$service_handle
, string $source_db
, string $dest_file
[, int $options = 0
[, bool $verbose = FALSE
]] ) : mixedThis function passes the arguments to the (remote) database server. There it starts a new backup process. Therefore you won't get any responses.
Parameters
-
service_handle -
A previously opened connection to the database server.
-
source_db -
The absolute file path to the database on the database server. You can also use a database alias.
-
dest_file -
The path to the backup file on the database server.
-
options -
Additional options to pass to the database server for backup. The
optionsparameter can be a combination of the following constants:IBASE_BKP_IGNORE_CHECKSUMS,IBASE_BKP_IGNORE_LIMBO,IBASE_BKP_METADATA_ONLY,IBASE_BKP_NO_GARBAGE_COLLECT,IBASE_BKP_OLD_DESCRIPTIONS,IBASE_BKP_NON_TRANSPORTABLEorIBASE_BKP_CONVERT. Read the section about Predefined Constants for further information. -
verbose -
Since the backup process is done on the database server, you don't have any chance to get its output. This argument is useless.
Return Values
Returns TRUE on success or FALSE on failure.
Since the backup process is done on the (remote) server, this function just passes the arguments to it.
While the arguments are legal, you won't get FALSE.
Examples
Example #1 ibase_backup() example
<?php
// Attach to database server by ip address and port
$service = ibase_service_attach ('10.1.11.200/3050', 'sysdba', 'masterkey');
// Start the backup process on database server
// Backup employee database using full path to /srv/backup/employees.fbk
// Don't use any special arguments
ibase_backup($service, '/srv/firebird/employees.fdb', '/srv/backup/employees.fbk');
// Free the attached connection
ibase_service_detach ($service);
?>
Example #2 ibase_backup() example with arguments
<?php
// Attach to database server by name and default port
$service = ibase_service_attach ('fb-server.contoso.local', 'sysdba', 'masterkey');
// Start the backup process on database server
// Backup employee database using alias to /srv/backup/employees.fbk.
// Backup only the metadata. Don't create a transportable backup.
ibase_backup($service, 'employees.fdb', '/srv/backup/employees.fbk', IBASE_BKP_METADATA_ONLY | IBASE_BKP_NON_TRANSPORTABLE);
// Free the attached connection
ibase_service_detach ($service);
?>
English translation
You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.
Thank you in advance.
Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-function.ibase-backup.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.
