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
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
project.
Copyright (C) 1998-2018 OpenLink Software
This project is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; only version 2 of the License, dated June 1991.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
: template.sh,v 1.5 2006/04/18 21:59:13 ivan Exp $
-->
<refentry id="fn_rdf_backup_metadata">
<refmeta>
<refentrytitle>DB.DBA.RDF_BACKUP_METADATA</refentrytitle>
<refmiscinfo>rdf</refmiscinfo>
</refmeta>
<refnamediv>
<refname>DB.DBA.RDF_BACKUP_METADATA</refname>
<refpurpose>Makes a backup copy of RDF metadata (i.e., descriptions of Linked Data Views and the like).</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_rdf_backup_metadata">
<funcprototype id="fproto_rdf_backup_metadata">
<funcdef><function>DB.DBA.RDF_BACKUP_METADATA</function></funcdef>
<paramdef><optional>in <parameter>save_to_file</parameter> integer := 0</optional></paramdef>
<paramdef><optional>in <parameter>backup_name</parameter> varchar := null</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_rdf_backup_metadata">
<title>Description</title>
<para>
This saves all RDF metadata to file or to some graph in RDF storage, depending on first argument (nonzero for file, zero for graph).
If the function gets nonzero as first argument then it creates two files, called, say, 'example.ttl', and 'example-DEBUG.ttl'.
It's enough to save only the former file in order to restore metadata later,
but the latter contains important additional debug information so both files should be attached to any bug report related to RDF metadata.
</para>
<para>There are no functions to make copies of backups. File backup consists of plain TURTLE RDF files only.
Backup graph is just a regular RDF graph in the default storage so it can be serialized into a file or copied into other graph.
However it is important to remember that the system graph, whose name is returned by JSO_SYS_GRAPH() stored procedure, should not be edited directly.
The content of the system graph is not necessarily equal to the content of a backup graph and it should be touched only by API function calls.
</para>
</refsect1>
<refsect1 id="params_rdf_backup_metadata">
<title>Parameters</title>
<refsect2><title>save_to_file</title>
<para>Value of 1 to backup to a files, 0 to backup into graph.</para>
</refsect2>
<refsect2><title>backup_name</title>
<para>Name of destination graph or file. Graph should be empty before backup, but file with the specified name may exist before backup and will be silently overwritten.
When the destination is file, the '.ttl' extension is concatenated to the backup_name.
If the argument is null then the backup name will contain date and time of backup creation, like '2007-12-31T23:59.59'.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_rdf_backup_metadata"><title>Return Types</title>
<para>The function returns the actual name of the created backup as a string.</para>
</refsect1>
<!-- <refsect1 id="errors_rdf_backup_metadata">
<title>Errors</title>
<para>This function can generate the following errors:</para>
<errorcode></errorcode>
</refsect1> -->
<!--<refsect1 id="examples_rdf_backup_metadata">
<title>Examples</title>
<example id="ex_rdf_backup_metadata"><title></title>
<para></para>
<screen><![CDATA[
]]>
</screen>
</example>
</refsect1>-->
<refsect1 id="seealso_rdf_backup_metadata">
<title>See Also</title>
<para><link linkend="fn_rdf_audit_metadata"><function>DB.DBA.RDF_AUDIT_METADATA()</function></link></para>
<para><link linkend="fn_rdf_restore_metadata"><function>DB.DBA.RDF_RESTORE_METADATA()</function></link></para>
</refsect1>
</refentry>
|
