1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ibase-restore">
<refnamediv>
<refname>ibase_restore</refname>
<refpurpose>Initiates a restore task in the service manager and returns immediately</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>mixed</type><methodname>ibase_restore</methodname>
<methodparam><type>resource</type><parameter>service_handle</parameter></methodparam>
<methodparam><type>string</type><parameter>source_file</parameter></methodparam>
<methodparam><type>string</type><parameter>dest_db</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 restore 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_file</parameter></term>
<listitem>
<para>
The absolute path on the server where the backup file is located.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>dest_db</parameter></term>
<listitem>
<para>
The path to create the new database on the server. You can also use database alias.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
Additional options to pass to the database server for restore.
The <parameter>options</parameter> parameter can be a combination
of the following constants:
<constant>IBASE_RES_DEACTIVATE_IDX</constant>,
<constant>IBASE_RES_NO_SHADOW</constant>,
<constant>IBASE_RES_NO_VALIDITY</constant>,
<constant>IBASE_RES_ONE_AT_A_TIME</constant>,
<constant>IBASE_RES_REPLACE</constant>,
<constant>IBASE_RES_CREATE</constant>,
<constant>IBASE_RES_USE_ALL_SPACE</constant>,
<constant>IBASE_PRP_PAGE_BUFFERS</constant>,
<constant>IBASE_PRP_SWEEP_INTERVAL</constant>,
<constant>IBASE_RES_CREATE</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 restore 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 restore 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_restore</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 restore process on database server
// Restore employee backup to the new emps.fdb database
// Don't use any special arguments
ibase_restore($service, '/srv/backup/employees.fbk', '/srv/firebird/emps.fdb');
// Free the attached connection
ibase_service_detach ($service);
?>
]]>
</programlisting>
</example>
</para>
<para>
<example>
<title><function>ibase_restore</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 restore process on database server
// Restore to employee database using alias.
// Restore without indixes. Replace existing database.
ibase_restore($service, '/srv/backup/employees.fbk', 'employees.fdb', IBASE_RES_DEACTIVATE_IDX | IBASE_RES_REPLACE);
// Free the attached connection
ibase_service_detach ($service);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ibase_backup</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
-->
|
