<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.ibase.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.ibase-backup.php',
    1 => 'ibase_backup',
    2 => 'Initiates a backup task in the service manager and returns immediately',
  ),
  'up' => 
  array (
    0 => 'ref.ibase.php',
    1 => 'Firebird/InterBase 関数',
  ),
  'prev' => 
  array (
    0 => 'function.ibase-affected-rows.php',
    1 => 'ibase_affected_rows',
  ),
  'next' => 
  array (
    0 => 'function.ibase-blob-add.php',
    1 => 'ibase_blob_add',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/ibase/functions/ibase-backup.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.ibase-backup" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">ibase_backup</h1>
  <p class="verinfo">(PHP 5, PHP 7 &lt; 7.4.0)</p><p class="refpurpose"><span class="refname">ibase_backup</span> &mdash; <span class="dc-title">Initiates a backup task in the service manager and returns immediately</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.ibase-backup-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>ibase_backup</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> <code class="parameter">$service_handle</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$source_db</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$dest_file</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$options</code><span class="initializer"> = 0</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$verbose</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span><br>): <span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span></div>

  <p class="simpara">
   This function passes the arguments to the (remote) database server. There it starts a new backup process. Therefore you
   won&#039;t get any responses.
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.ibase-backup-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">service_handle</code></dt>
    <dd>
     <span class="simpara">
      A previously opened connection to the database server.
     </span>
    </dd>
   
   
    <dt><code class="parameter">source_db</code></dt>
    <dd>
     <span class="simpara">
      The absolute file path to the database on the database server. You can also use a database alias.
     </span>
    </dd>
   
   
    <dt><code class="parameter">dest_file</code></dt>
    <dd>
     <span class="simpara">
      The path to the backup file on the database server.
     </span>
    </dd>
   
   
    <dt><code class="parameter">options</code></dt>
    <dd>
     <p class="para">
      Additional options to pass to the database server for backup.
      The <code class="parameter">options</code> parameter can be a combination
      of the following constants:
      <strong><code><a href="ibase.constants.php#constant.ibase-bkp-ignore-checksums">IBASE_BKP_IGNORE_CHECKSUMS</a></code></strong>,
      <strong><code><a href="ibase.constants.php#constant.ibase-bkp-ignore-limbo">IBASE_BKP_IGNORE_LIMBO</a></code></strong>,
      <strong><code><a href="ibase.constants.php#constant.ibase-bkp-metadata-only">IBASE_BKP_METADATA_ONLY</a></code></strong>,
      <strong><code><a href="ibase.constants.php#constant.ibase-bkp-no-garbage-collect">IBASE_BKP_NO_GARBAGE_COLLECT</a></code></strong>,
      <strong><code><a href="ibase.constants.php#constant.ibase-bkp-old-descriptions">IBASE_BKP_OLD_DESCRIPTIONS</a></code></strong>,
      <strong><code><a href="ibase.constants.php#constant.ibase-bkp-non-transportable">IBASE_BKP_NON_TRANSPORTABLE</a></code></strong> or
      <strong><code><a href="ibase.constants.php#constant.ibase-bkp-convert">IBASE_BKP_CONVERT</a></code></strong>.
      Read the section about <a href="ibase.constants.php" class="xref">定義済み定数</a> for further information.
     </p>
    </dd>
   
   
    <dt><code class="parameter">verbose</code></dt>
    <dd>
     <span class="simpara">
      Since the backup process is done on the database server, you don&#039;t have any chance
      to get its output. This argument is useless.
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.ibase-backup-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   成功した場合に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を、失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
  <p class="simpara">
   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&#039;t get <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
  </p>
 </div>


 <div class="refsect1 examples" id="refsect1-function.ibase-backup-examples">
  <h3 class="title">例</h3>
  <div class="example" id="example-1">
   <p><strong>例1 <span class="function"><strong>ibase_backup()</strong></span> example</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// Attach to database server by ip address and port<br /></span><span style="color: #0000BB">$service </span><span style="color: #007700">= </span><span style="color: #0000BB">ibase_service_attach </span><span style="color: #007700">(</span><span style="color: #DD0000">'10.1.11.200/3050'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sysdba'</span><span style="color: #007700">, </span><span style="color: #DD0000">'masterkey'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Start the backup process on database server<br />// Backup employee database using full path to /srv/backup/employees.fbk<br />// Don't use any special arguments<br /></span><span style="color: #0000BB">ibase_backup</span><span style="color: #007700">(</span><span style="color: #0000BB">$service</span><span style="color: #007700">, </span><span style="color: #DD0000">'/srv/firebird/employees.fdb'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/srv/backup/employees.fbk'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Free the attached connection<br /></span><span style="color: #0000BB">ibase_service_detach </span><span style="color: #007700">(</span><span style="color: #0000BB">$service</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>

  <div class="example" id="example-2">
   <p><strong>例2 <span class="function"><strong>ibase_backup()</strong></span> example with arguments</strong></p>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #FF8000">// Attach to database server by name and default port<br /></span><span style="color: #0000BB">$service </span><span style="color: #007700">= </span><span style="color: #0000BB">ibase_service_attach </span><span style="color: #007700">(</span><span style="color: #DD0000">'fb-server.contoso.local'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sysdba'</span><span style="color: #007700">, </span><span style="color: #DD0000">'masterkey'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Start the backup process on database server<br />// Backup employee database using alias to /srv/backup/employees.fbk.<br />// Backup only the metadata. Don't create a transportable backup.<br /></span><span style="color: #0000BB">ibase_backup</span><span style="color: #007700">(</span><span style="color: #0000BB">$service</span><span style="color: #007700">, </span><span style="color: #DD0000">'employees.fdb'</span><span style="color: #007700">, </span><span style="color: #DD0000">'/srv/backup/employees.fbk'</span><span style="color: #007700">, </span><span style="color: #0000BB">IBASE_BKP_METADATA_ONLY </span><span style="color: #007700">| </span><span style="color: #0000BB">IBASE_BKP_NON_TRANSPORTABLE</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// Free the attached connection<br /></span><span style="color: #0000BB">ibase_service_detach </span><span style="color: #007700">(</span><span style="color: #0000BB">$service</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.ibase-backup-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.ibase-restore.php" class="function" rel="rdfs-seeAlso">ibase_restore()</a> - Initiates a restore task in the service manager and returns immediately</span></li>
  </ul>
 </div>


</div><?php manual_footer($setup); ?>