<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Copies the database</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.construct.html">TokyoTyrant::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.ext.html">TokyoTyrant::ext</a></div>
<div class="up"><a href="class.tokyotyrant.html">TokyoTyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="tokyotyrant.copy" class="refentry">
<div class="refnamediv">
<h1 class="refname">TokyoTyrant::copy</h1>
<p class="verinfo">(PECL tokyo_tyrant >= 0.1.0)</p><p class="refpurpose"><span class="refname">TokyoTyrant::copy</span> — <span class="dc-title">Copies the database</span></p>
</div>
<div class="refsect1 description" id="refsect1-tokyotyrant.copy-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="class.tokyotyrant.html" class="type TokyoTyrant">TokyoTyrant</a></span> <span class="methodname"><strong>TokyoTyrant::copy</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
)</div>
<p class="para rdfs-comment">
Makes a copy of the current database
</p>
</div>
<div class="refsect1 parameters" id="refsect1-tokyotyrant.copy-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">path</code></em></span>
<dd>
<p class="para">
Path to where to copy the database. The user running the remote
database must have a write access to the directory.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-tokyotyrant.copy-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This method returns the current object and throws TokyoTyrantException on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-tokyotyrant.copy-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2206">
<p><strong>Example #1 <span class="methodname"><strong>TokyoTyrant::copy()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$tt </span><span style="color: #007700">= new </span><span style="color: #0000BB">TokyoTyrant</span><span style="color: #007700">(</span><span style="color: #DD0000">"localhost"</span><span style="color: #007700">, </span><span style="color: #0000BB">1978</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$tt</span><span style="color: #007700">-></span><span style="color: #0000BB">copy</span><span style="color: #007700">(</span><span style="color: #DD0000">"/tmp/foobar.tct"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-tokyotyrant.copy-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="tokyotyrant.restore.html" class="methodname" rel="rdfs-seeAlso">TokyoTyrant::restore()</a> - Restore the database</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="tokyotyrant.construct.html">TokyoTyrant::__construct</a></div>
<div class="next" style="text-align: right; float: right;"><a href="tokyotyrant.ext.html">TokyoTyrant::ext</a></div>
<div class="up"><a href="class.tokyotyrant.html">TokyoTyrant</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
