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
|
<?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_repl_sync">
<refmeta>
<refentrytitle>repl_sync</refentrytitle>
<refmiscinfo>repl</refmiscinfo>
</refmeta>
<refnamediv>
<refname>repl_sync</refname>
<refpurpose>starts the syncing process against an existing subscription</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_repl_sync">
<funcprototype id="fproto_repl_sync">
<funcdef><function>repl_sync</function></funcdef>
<paramdef>in <parameter>publisher</parameter> varchar</paramdef>
<paramdef>in <parameter>publication</parameter> varchar</paramdef>
<paramdef>in <parameter>uid</parameter> varchar</paramdef>
<paramdef>in <parameter>password</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_repl_sync"><title>Description</title>
<para>
This starts the syncing process against an existing subscription. The function
returns as soon as the request has been successfully sent. The synchronization will
take place in the background. If the syncing process is already underway or if
the subscriber is already in sync and connected to the publisher this function has no effect.
If there is no connection to the publisher at the time of calling this function and the connection
fails and an error is immediately signalled.
To initiate a synchronization a valid SQL account must be specified. Also the account must
have rights to the publication unless publisher DBA's account is used to connect.
</para>
</refsect1>
<refsect1 id="params_repl_sync"><title>Parameters</title>
<refsect2><title>publisher</title>
<para>The server name of the publisher.</para>
</refsect2>
<refsect2><title>publication</title>
<para>The name assigned to the publication.</para>
</refsect2>
<refsect2><title>uid</title>
<para>SQL account with rights to the publication, or publishers DBA account credentials will be required.</para>
</refsect2>
<refsect2><title>password</title>
<para>SQL account password.</para>
</refsect2>
</refsect1>
<!-- 3019
This function returns an integer enumerating the status of subscription: 0-off, 1-syncing, 2-in sync, 3-disconnected
Errors:
TR067 37000 No replication account <server> <account>
TR072 08001 Replication connect to <server> failed.
-->
<refsect1 id="examples_repl_sync"><title>Example</title>
<example id="ex_repl_sync"><title>Synchronizing a subscription</title>
<para>The following shows requesting a sync from publisher for an existing subscription. The account for authentication is a 'repl_user' SQL account.</para>
<screen>
SQL> repl_sync ('demo-srv', 'demo-publication', 'repl_user', 'repl_passwd');
</screen>
</example>
</refsect1>
<refsect1 id="seealso_repl_sync"><title>See Also</title>
<para><link linkend="fn_sub_schedule"><function>sub_schedule()</function></link></para>
<para><link linkend="fn_repl_disconnect"><function>repl_disconnect()</function></link></para>
<para><link linkend="fn_repl_grant"><function>repl_grant()</function></link></para>
<para><link linkend="fn_repl_init_copy"><function>repl_init_copy()</function></link></para>
<para><link linkend="fn_repl_new_log"><function>repl_new_log()</function></link></para>
<para><link linkend="fn_repl_pub_add"><function>repl_pub_add()</function></link></para>
<para><link linkend="fn_repl_pub_init_image"><function>repl_pub_init_image()</function></link></para>
<para><link linkend="fn_repl_pub_remove"><function>repl_pub_remove()</function></link></para>
<para><link linkend="fn_repl_publish"><function>repl_publish()</function></link></para>
<para><link linkend="fn_repl_revoke"><function>repl_revoke()</function></link></para>
<para><link linkend="fn_repl_sched_init"><function>repl_sched_init()</function></link></para>
<para><link linkend="fn_repl_server"><function>repl_server()</function></link></para>
<para><link linkend="fn_repl_server_rename"><function>repl_server_rename()</function></link></para>
<para><link linkend="fn_repl_stat"><function>repl_stat()</function></link></para>
<para><link linkend="fn_repl_status"><function>repl_status()</function></link></para>
<para><link linkend="fn_repl_subscribe"><function>repl_subscribe()</function></link></para>
<para><link linkend="fn_repl_sync_all"><function>repl_sync_all()</function></link></para>
<para><link linkend="fn_repl_text"><function>repl_text()</function></link></para>
<para><link linkend="fn_repl_this_server"><function>repl_this_server()</function></link></para>
<para><link linkend="fn_repl_unpublish"><function>repl_unpublish()</function></link></para>
<para><link linkend="fn_repl_unsubscribe"><function>repl_unsubscribe()</function></link></para>
</refsect1>
</refentry>
|
