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
|
<?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
-
-
-->
<refentry id="fn_cl_exec">
<refmeta>
<refentrytitle>cl_exec</refentrytitle>
<refmiscinfo>sql</refmiscinfo>
</refmeta>
<refnamediv>
<refname>cl_exec</refname>
<refpurpose>executes things on all nodes of a cluster</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_cl_exec">
<funcprototype id="fproto_cl_exec">
<funcdef><function>cl_exec</function></funcdef>
<paramdef>in <parameter>cmd </parameter> varchar</paramdef>
<paramdef><optional>in <parameter>params </parameter> any := NULL</optional></paramdef>
<paramdef><optional>in <parameter>is_txn </parameter> int := 0</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_cl_exec"><title>Description</title>
<para>The cl_exec SQL function can be used for executing things on all nodes of a cluster.</para>
</refsect1>
<refsect1 id="params_cl_exec">
<title>Parameters</title>
<refsect2><title>cmd</title>
<para>A SQL string. If it contains parameter markers (?), the params array is used for assigning values, left to right.</para>
</refsect2>
<refsect2><title>params</title>
<para>Any params.</para>
</refsect2>
<refsect2><title>is_txn</title>
<para>If set to 1, the cl_exec makes a distributed transaction and does not automatically commit on locally on each node.
Thus cl_exec can be used as part of a containing distributed transaction.</para>
</refsect2>
</refsect1>
<refsect1 id="examples_cl_exec">
<title>Examples</title>
<example id="ex_cl_exec"><title>Simple example</title>
<screen><![CDATA[
SQL> cl_exec ('shutdown')
--will shut all nodes.
SQL> cl_exec ('dbg_obj_print (?)', vector ('hello'));
--will print hello to the standard output of all the processes of the cluster.
]]></screen>
</example>
</refsect1>
<refsect1 id="seealso_rdf_loader_run">
<title>See Also</title>
<para><link linkend="http://docs.openlinksw.com/virtuoso/clusterstcnf.html">Cluster Installation and Config</link></para>
<para><link linkend="http://docs.openlinksw.com/virtuoso/clusterstcnf.html#clusterstcnfbackuprestore">Backup and Restore Example</link></para>
</refsect1>
</refentry>
|
