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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<?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_subscribe">
<refmeta>
<refentrytitle>REPL_SUBSCRIBE</refentrytitle>
<refmiscinfo>repl</refmiscinfo>
</refmeta>
<refnamediv>
<refname>REPL_SUBSCRIBE</refname>
<refpurpose>add a subscription</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_repl_subscribe">
<funcprototype id="fproto_repl_subscribe">
<funcdef><function>REPL_SUBSCRIBE</function></funcdef>
<paramdef>in <parameter>server_name</parameter> varchar</paramdef>
<paramdef>in <parameter>publication</parameter> varchar</paramdef>
<paramdef>in <parameter>dav_user</parameter> varchar</paramdef>
<paramdef>in <parameter>dav_group</parameter> varchar</paramdef>
<paramdef>in <parameter>replication_user</parameter> varchar</paramdef>
<paramdef>in <parameter>replication_password</parameter> varchar</paramdef>
<paramdef><optional>in <parameter>sync_user</parameter> varchar</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_repl_subscribe"><title>Description</title>
<para>This function is used to subscribe to an existing publication,
and to specify the local WebDAV owner for replicated WebDAV content.
Before making a subscription the <function>repl_server()</function> function
must be called in order to define the publishing server. After making a
subscription it becomes off-line awaiting synchronization from a scheduled
task or call to the <function>repl_sync()</function> function.
Also the initial data of the subscription will be not loaded until
<function>repl_init_copy()</function> is called or the initial image
has been loaded.</para>
</refsect1>
<refsect1 id="params_repl_subscribe"><title>Parameters</title>
<refsect2><title>server_name</title>
<para>target publisher server name.</para></refsect2>
<refsect2><title>publication</title>
<para>publication account name.</para></refsect2>
<refsect2><title>dav_user</title>
<para>A valid local WebDAV user account name that will own local
copy. If this is null 'REPLICATION' user account will be created that will
be disabled by default.</para></refsect2>
<refsect2><title>dav_group</title>
<para>A valid local WebDAV group name to own the local copy.</para></refsect2>
<refsect2><title>replication_user</title>
<para>Is used for authentication on the publisher. This should be a valid DB account on publisher.</para></refsect2>
<refsect2><title>replication_password</title>
<para>Is used for authentication on the publisher. This should be valid password
for <parameter>replication_user</parameter> on publisher.</para></refsect2>
<refsect2><title>sync_user</title>
<para>A local DB account used to replay replication feeds.</para></refsect2>
</refsect1>
<!-- 3019
This function do not return value
Errors:
TR005 37000 publication and subscription servers have identical names.
TR006 37000 Publishing server must be declared with REPL_SERVER before subscribing
TR007 37000 The subscription <name> already exist
TR008 22023 User name and password should be supplied when subscribe to new publisher
TR009 37000 The WebDAV collection <name> already exist
TR010 37000 The table <name> already exist
TR011 22023 The item type <type> not applicable
-->
<refsect1 id="examples_repl_subscribe"><title>Example</title>
<example id="ex_repl_subscribe_1"><title>Subscribing to a publication</title>
<para>This example shows making a subscription to the 'table_publication'
published on a 'demo-srv' server. The WebDAV items will belong to the WebDAV administrator.</para>
<screen>
SQL> DB.DBA.REPL_SUBSCRIBE ('demo-srv','demo-publication', 'dav', 'dav', 'demo', 'demo');
</screen>
</example>
</refsect1>
<refsect1 id="seealso_repl_subscribe"><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_sync"><function>repl_sync()</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>
|
