Document SQLite3::backup()

git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@350587 c90b9560-bf6c-de11-be94-00142212c4b1

Author: Yoshinari Takaoka

reference/sqlite3/sqlite3/backup.xml

@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!-- EN-Revision: 4aba1fc71aa5dccdd2fe5b619a5bd829eb9570ec Maintainer: mumumu Status: ready -->
+
+<refentry xml:id="sqlite3.backup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>SQLite3::backup</refname>
+  <refpurpose>あるデータベースを、別のデータベースにバックアップする</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>bool</type><methodname>SQLite3::backup</methodname>
+   <methodparam><type>SQLite3</type><parameter>destination_db</parameter></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>source_dbname</parameter><initializer>"main"</initializer></methodparam>
+   <methodparam choice="opt"><type>string</type><parameter>destination_dbname</parameter><initializer>"main"</initializer></methodparam>
+  </methodsynopsis>
+  <para>
+   <methodname>SQLite3::backup</methodname> は、あるデータベースの内容を別のデータベースにコピーし、
+   コピー先のデータベースの内容を上書きします。
+   このメソッドは、データベースのバックアップを作成したり、
+   インメモリのデータベースを永続的なファイルにコピーしたり、その逆を行う場合に便利です。
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <variablelist>
+   <varlistentry>
+    <term><parameter>destination_db</parameter></term>
+    <listitem>
+     <para>
+      <methodname>SQLite3::open</methodname> でオープンされたデータベース接続
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>source_dbname</parameter></term>
+    <listitem>
+     <para>
+      メインデータベースの場合、データベース名は <literal>"main"</literal> です。
+      一時的なデータベースの場合は、<literal>"temp"</literal> になります。
+      また、<literal>ATTACH</literal> 文の <literal>AS</literal> キーワードの後に指定された名前が使えます。
+     </para>
+    </listitem>
+   </varlistentry>
+   <varlistentry>
+    <term><parameter>destination_dbname</parameter></term>
+    <listitem>
+     <para>
+      <parameter>source_dbname</parameter> に似ていますが、 
+      コピー先のデータベースを表します。
+     </para>
+    </listitem>
+   </varlistentry>
+  </variablelist>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example xml:id="function-name.example.basic">
+   <title>既存のデータベースをバックアップする</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+// $conn は、既にオープンされた sqlite3 データベースへの接続です。
+
+$backup = new SQLite3('backup.sqlite');
+$conn->backup($backup);
+?>
+]]>
+   </programlisting>
+  </example>
+ </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
+-->