File: repl_pub_remove.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (121 lines) | stat: -rw-r--r-- 5,918 bytes parent folder | download | duplicates (2)
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
<?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_pub_remove">
  <refmeta>
    <refentrytitle>REPL_PUB_REMOVE</refentrytitle>
    <refmiscinfo>repl</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>REPL_PUB_REMOVE</refname>
    <refpurpose>remove item from publication.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_repl_pub_remove">
      <funcprototype id="fproto_repl_pub_remove">
        <funcdef><function>REPL_PUB_REMOVE</function></funcdef>
        <paramdef>in <parameter>publication</parameter> varchar</paramdef>
        <paramdef>in <parameter>item</parameter> varchar</paramdef>
        <paramdef>in <parameter>type</parameter> integer</paramdef>
        <paramdef>in <parameter>flag</parameter> integer</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_repl_pub_remove">
    <title>Description</title>
    <para>This function is used to remove an item from existing publication.
    It's action is performed on publisher side and depending of flag it 
    can send replication message to subscribers to remove this from subscription.
    </para>
  </refsect1>
  <refsect1 id="params_repl_pub_remove">
    <title>Parameters</title>
    <refsect2>
      <title>publication</title>
      <para>publication account name.</para>
    </refsect2>
    <refsect2>
      <title>item</title>
      <para>dependent on <emphasis>type</emphasis> should be:</para>
    <simplelist>
    <member>Valid WebDAV collection full path in local repository.</member>
    <member>Fully qualified table name.</member>
    <member>Fully qualified Virtuoso/PL procedure name.</member>
    </simplelist>
    </refsect2>
    <refsect2>
      <title>type</title>
      <para>type of item, can accept following types:</para>
    <simplelist>
    <member>1 - item is a WebDAV collection.</member>
    <member>2 - item is a database table.</member>
    <member>3 - item is a Virtuoso/PL procedure.</member>
    </simplelist>
    </refsect2>
    <refsect2>
      <title>flag</title>
      <para>Behavior on the subscriber side</para>
      <member>NULL - do not send a replication message to the subscribers.</member>
      <member>1 - send a message to the subscribers to remove entry from local description.</member>
    </refsect2>
  </refsect1>
  <!-- 3019
  This function has no return value
  
  Errors:
  TR001   37000           The publication <name> doesn't exist
  -->
  <refsect1 id="examples_repl_pub_remove"><title>Example</title>
    <example id="ex_repl_pub_remove_1"><title>Removal of an item from publication</title>
     <para>This will remove the table Demo.demo.Products from publication. Furthermore issuing of the replication messages for this item will be stopped and subscriber will remove this entry from local description.</para>
      <screen>
SQL> DB.DBA.REPL_PUB_REMOVE ('demo-publication', 'Demo.demo.Products', 2, 1);
      </screen>
    </example>
  </refsect1>
  <refsect1 id="seealso_repl_pub_remove"><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_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"><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>