ibase-backup.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-backup">
 <refnamediv>
  <refname>ibase_backup</refname>
  <refpurpose>Initiates a backup task in the service manager and returns immediately</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>mixed</type><methodname>ibase_backup</methodname>
   <methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
   <methodparam><type>string</type><parameter>source_db</parameter></methodparam>
   <methodparam><type>string</type><parameter>dest_file</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>0</initializer></methodparam>
   <methodparam choice="opt"><type>bool</type><parameter>verbose</parameter><initializer>&false;</initializer></methodparam>
  </methodsynopsis>
  <para>
   This function passes the arguments to the (remote) database server. There it starts a new backup process. Therefore you
   won't get any responses.
  </para>
 </refsect1>
 
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>service_handle</parameter></term>
     <listitem>
      <para>
       A previously opened connection to the database server.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>source_db</parameter></term>
     <listitem>
      <para>
       The absolute file path to the database on the database server. You can also use a database alias.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>dest_file</parameter></term>
     <listitem>
      <para>
       The path to the backup file on the database server.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>options</parameter></term>
     <listitem>
      <para>
       Additional options to pass to the database server for backup.
       The <parameter>options</parameter> parameter can be a combination 
       of the following constants:
       <constant>IBASE_BKP_IGNORE_CHECKSUMS</constant>,
       <constant>IBASE_BKP_IGNORE_LIMBO</constant>, 
       <constant>IBASE_BKP_METADATA_ONLY</constant>,
       <constant>IBASE_BKP_NO_GARBAGE_COLLECT</constant>,
       <constant>IBASE_BKP_OLD_DESCRIPTIONS</constant>,
       <constant>IBASE_BKP_NON_TRANSPORTABLE</constant> or
       <constant>IBASE_BKP_CONVERT</constant>.
       Read the section about <xref linkend="ibase.constants" /> for further information.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>verbose</parameter></term>
     <listitem>
      <para>
       Since the backup process is done on the database server, you don't have any chance
       to get its output. This argument is useless.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
  <para>
   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;.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>ibase_backup</function> example</title>
    <programlisting role="php">
<![CDATA[
<?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);
?>
]]>
    </programlisting>
   </example>
  </para>
  
  <para>
   <example>
    <title><function>ibase_backup</function> example with arguments</title>
    <programlisting role="php">
<![CDATA[
<?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);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ibase_restore</function></member>
   </simplelist>
  </para>
 </refsect1>
 
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->