<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="Function: backup_online - Virtuoso Functions Guide" />
<meta name="dc.subject" content="Function: backup_online - Virtuoso Functions Guide" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href="functions.html" title="Chapter Contents" />
<link rel="prev" href="appendixa.html" title="Appendix" />
<link rel="next" href="functions.html#.html" title="" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>Function: backup_online - Virtuoso Functions Guide</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="fn_backup_online" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>22. Virtuoso Functions Guide - backup_online</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="fn_backup.html" title="backup">Prev</a> | <a class="link" href="fn_backup_context_clear.html" title="backup_context_clear">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a class="selected" href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
<div>
<a href="functions.html#admin">Administration</a>
</div>
<div>
<a href="functions.html#aggr">Aggregate Functions</a>
</div>
<div>
<a href="functions.html#array">Array Manipulation</a>
</div>
<div>
<a href="functions.html#bpel">BPEL APIs</a>
</div>
<div>
<a class="selected" href="functions.html#backup">Backup</a>
</div>
<div class="selected">
<div>
<a href="fn_backup.html">backup</a>
</div>
<div>
<a href="fn_backup_context_clear.html">backup_context_clear</a>
</div>
<div>
<a class="selected" href="fn_backup_online.html">backup_online</a>
</div>
<div>
<a href="fn_replay.html">replay</a>
</div>
</div>
<div>
<a href="functions.html#compression">Compression</a>
</div>
<div>
<a href="functions.html#cursors">Cursor</a>
</div>
<div>
<a href="functions.html#time">Date & Time Manipulation</a>
</div>
<div>
<a href="functions.html#debug">Debug</a>
</div>
<div>
<a href="functions.html#dict">Dictionary Manipulation</a>
</div>
<div>
<a href="functions.html#encoding">Encoding & Decoding</a>
</div>
<div>
<a href="functions.html#file">File Manipulation</a>
</div>
<div>
<a href="functions.html#ft">Free Text</a>
</div>
<div>
<a href="functions.html#hash">Hashing / Cryptographic</a>
</div>
<div>
<a href="functions.html#ldap">LDAP</a>
</div>
<div>
<a href="functions.html#localization">Locale</a>
</div>
<div>
<a href="functions.html#mail">Mail</a>
</div>
<div>
<a href="functions.html#misc">Miscellaneous</a>
</div>
<div>
<a href="functions.html#number">Number</a>
</div>
<div>
<a href="functions.html#phrz">Phrases</a>
</div>
<div>
<a href="functions.html#rdf">RDF data</a>
</div>
<div>
<a href="functions.html#rmt">Remote SQL Data Source</a>
</div>
<div>
<a href="functions.html#repl">Replication</a>
</div>
<div>
<a href="functions.html#soap">SOAP</a>
</div>
<div>
<a href="functions.html#sql">SQL</a>
</div>
<div>
<a href="functions.html#string">String</a>
</div>
<div>
<a href="functions.html#txn">Transaction</a>
</div>
<div>
<a href="functions.html#type">Type Mapping</a>
</div>
<div>
<a href="functions.html#uddi">UDDI</a>
</div>
<div>
<a href="functions.html#udt">User Defined Types & The CLR</a>
</div>
<div>
<a href="functions.html#vad">VAD</a>
</div>
<div>
<a href="functions.html#jvmpl">Virtuoso Java PL API</a>
</div>
<div>
<a href="functions.html#bif">Virtuoso Server Extension Interface (VSEI)</a>
</div>
<div>
<a href="functions.html#ws">Web & Internet</a>
</div>
<div>
<a href="functions.html#xml">XML</a>
</div>
<div>
<a href="functions.html#XPATH">XPATH & XQUERY</a>
</div>
<br />
<div>
<a href="functionidx.html">Functions Index</a>
</div>
<br />
</div>
<div id="text">
<h2>backup_online</h2>
<div class="refpurpose">perform online backup of database</div>
<div class="funcsynopsis">
<span class="funcdef">int <span class="function">backup_online</span>
</span>
(<span class="paramdef">in <span class="parameter">file_prefix</span> varchar</span>,
<span class="paramdef">in <span class="parameter">pages</span> integer</span>,
<span class="paramdefoptional">[in <span class="optional">timeout</span> integer]</span>,
<span class="paramdefoptional">[in <span class="optional">dirs</span> any]</span>);
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>This procedure will backup all information from the checkpoint
space to a series of files named
"<span class="computeroutput"><file_prefix><n>.bp</span>", where
<n> is the sequence number of the file in the backup series.
The first backup will be a full gzip compressed dump of database pages in
the checkpoint space. Any subsequent call will only backup pages which have
changed since the last backup was made. To start with a fresh full backup,
use backup_clear_context to clear the change tracking data.
At each checkpoint the checkpoint space will be updated, and the next
"backup_online;" procedure will create new files. Once backup_online()
has been called for the first time, the arguments supplied will be used for
subsequent calls to it. Hence, arguments supplied to this procedure (except the
"dirs" argument) will be ignored in subsequent calls.</p>
<p>Before a new backup series can be started, the
<a href="fn_backup_context_clear.html">backup_context_clear();</a>
procedure must be called first. This procedure will clear the current backup
context and mark all pages in the checkpoint space as ready for backup.</p>
<p>A database checkpoint cannot be performed while an online backup is
in progress. Attempt to do a checkpoint will wait until the backup is complete.</p>
<p>This is the preferred means of backing up databases and replaces any
other prior means. As an alternative, copying database files while the
database is running will still work, as long as no checkpoint is made during
the copy process.</p>
</div>
<div class="refsect1">
<div class="refsect1title">Parameters</div>
<div class="refsect2">
<span class="refsect2title">file_prefix – </span>
A string to prefix to the filename of the backup files.
</div>
<div class="refsect2">
<span class="refsect2title">pages – </span>
The pages argument indicates the maximum number of 8K pages that
will be backed up into each file. This argument must be larger than 100.
If pages < 100 an error will be returned.
</div>
<div class="refsect2">
<span class="refsect2title">timeout – </span>
This parameter has no effect.
</div>
<div class="refsect2">
<span class="refsect2title">dirs – </span>
This optional parameter must be an array of directory names (array of strings). The
backup files are first stored in the first directory. When running out of disk
any consecutive backup files are stored in the next directory in the list. If there are no
more directories then an error is signalled and all the files written by this call to backup_online are
deleted so as not to leave half made backups.
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Return Types</div>
<p>This function will return the number of 8k pages that were backed-up.</p>
</div>
<div class="refsect1title">Errors</div>
<p>This function can generate the following errors:</p>
<p>
<a href="errors.html#errIB001">IB001</a>, <a href="errors.html#errIB002">IB002</a>, <a href="errors.html#errIB003">IB003</a>, <a href="errors.html#errIB004">IB004</a>, <a href="errors.html#errIB005">IB005</a>, <a href="errors.html#errIB006">IB006</a>, <a href="errors.html#errIB007">IB007</a>, <a href="errors.html#errIB008">IB008</a>, <a href="errors.html#errIB009">IB009</a>, <a href="errors.html#errIB010">IB010</a>.</p>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="ex_fnbackup_online" />
<div class="example">
<div class="exampletitle">Performing an online backup</div>
<p>If there are 2010 new pages in the checkpoint space and user invokes:</p>
<div>
<pre class="screen">
"backup_online ('dump-20021010_#', 500);"
</pre>
</div>
<p>from ISQL, then the following series of backup files will be
created in the Virtuoso database directory:</p>
<div>
<pre class="screen">
dump-20011010_#1.bp
dump-20011010_#2.bp
dump-20011010_#3.bp
dump-20011010_#4.bp
dump-20011010_#5.bp
</pre>
</div>
<p>The first 4 files will each contain 500 8K pages. The actual length
of the files will vary due to varying compression ratio. </p>
</div>
<a name="ex_fnanonlinebackuprestore" />
<div class="example">
<div class="exampletitle">Restoring an Online Backup</div>
<p>The following command could be used to restore the database from the
backup files created:</p>
<div>
<pre class="programlisting">
virtuoso-iodbc-t +restore-backup dump-20011010_#
</pre>
</div>
<p>or:</p>
<div>
<pre class="programlisting">
virtuoso-odbc-t.exe +restore-backup dump-20011010_#
</pre>
</div>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">See Also</div>
<p>
<a href="fn_backup_context_clear.html">backup_context_clear();</a>
</p>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
158
