1 PACKAGE DBMS_CDC_SUBSCRIBE AS
2
3 ------------------------------------------------------------------------------
4 -- PROCEDURE DBMS_CDC_SUBSCRIBE.CREATE_SUBSCRIPTION
5 --
6 -- Purpose: Obtains a subscription name to be passed to all the other
7 -- subscription APIs
8 --
9 -- PROCEDURE DBMS_CDC_SUBSCRIBE.SUBSCRIBE
10 --
11 -- Purpose: Registers interest in a published source table or publication and
12 -- subscribes to those changes.
13 --
14 -- PROCEDURE DBMS_CDC_SUBSCRIBE.ACTIVATE_SUBSCRIPTION
15 --
16 -- Purpose: Activates a subscription, making it ready to receive change data.
17 --
18 -- PARAMETERS
19 --
20 -- change_set: The name of an existing change set
21 --
22 -- description: A description of the subscription and what it will be used for
23 --
24 -- subscription_name: Subscription name for a given subscription.
25 --
26 -- source_schema: Schema name where source tables reside
27 --
28 -- source_table: Name of a published source table
29 --
30 -- column_list: A comma-separated list of columns from the published
31 -- source table
32 --
33 -- publication_id: A specific publication ID (often used to distinguish
34 -- multiple publications on the same source_schema/source_table).
35 --
36 -- subscriber_view: Optional name of the subscriber view for subscription
37 -- to a particular source_schema/source_table or publication ID.
38 --
39 -- EXCEPTION DESCRIPTION
40 --
41 --
42 ------------------------------------------------------------------------------
43 -- PROCEDURE DBMS_CDC_SUBSCRIBE.EXTEND_WINDOW
44 --
45 -- Purpose: This procedure sets the high water mark of the subscription
46 -- window, thus permitting newly added change data to be seen.
47 --
48 -- PROCEDURE DBMS_CDC_SUBSCRIBE.PURGE_WINDOW
49 --
50 -- Purpose: Sets the low water mark equal to the high water mark for
51 -- this subscription window. The subscription can no longer see any of the
52 -- old change data.
53 --
54 -- PROCEDURE DBMS_CDC_SUBSCRIBE.DROP_SUBSCRIPTION
55 --
56 -- Purpose: Remove an existing subscription.
57 --
58 -- PARAMETERS
59 --
60 -- subscription_name: Name of an existing subscription
61 --
62 --
63 -- EXCEPTION DESCRIPTION
64 --
65 --
66 ------------------------------------------------------------------------------
67
68 --
69 -- 10i subscriber interface
70 --
71
72 PROCEDURE create_subscription (change_set_name IN VARCHAR2,
73 description IN VARCHAR2,
74 subscription_name IN VARCHAR2);
75
76 PROCEDURE subscribe (subscription_name IN VARCHAR2,
77 source_schema IN VARCHAR2,
78 source_table IN VARCHAR2,
79 column_list IN VARCHAR2,
80 subscriber_view IN VARCHAR2);
81
82 PROCEDURE subscribe (subscription_name IN VARCHAR2,
83 publication_id IN NUMBER,
84 column_list IN VARCHAR2,
85 subscriber_view IN VARCHAR2);
86
87 PROCEDURE activate_subscription (subscription_name IN VARCHAR2);
88
89 PROCEDURE extend_window (subscription_name IN VARCHAR2,
90 upper_bound IN DATE DEFAULT NULL);
91
92 PROCEDURE purge_window (subscription_name IN VARCHAR2,
93 lower_bound IN DATE DEFAULT NULL);
94
95 PROCEDURE drop_subscription (subscription_name IN VARCHAR2);
96
97
98 --
99 -- 9i subscriber interface - deprecated
100 --
101
102 PROCEDURE get_subscription_handle (change_set IN VARCHAR2,
103 description IN VARCHAR2,
104 subscription_handle OUT NUMBER);
105
106 PROCEDURE subscribe (subscription_handle IN NUMBER,
107 source_schema IN VARCHAR2,
108 source_table IN VARCHAR2,
109 column_list IN VARCHAR2);
110
111 PROCEDURE subscribe (subscription_handle IN NUMBER,
112 publication_id IN NUMBER,
113 column_list IN VARCHAR2);
114
115 PROCEDURE activate_subscription (subscription_handle IN NUMBER);
116
117 PROCEDURE extend_window (subscription_handle IN NUMBER);
118
119 PROCEDURE prepare_subscriber_view (subscription_handle IN NUMBER,
120 source_schema IN VARCHAR2,
121 source_table IN VARCHAR2,
122 view_name OUT VARCHAR2);
123
124 PROCEDURE drop_subscriber_view (subscription_handle IN NUMBER,
125 source_schema IN VARCHAR2,
126 source_table IN VARCHAR2);
127
128 PROCEDURE purge_window (subscription_handle IN NUMBER);
129
130 PROCEDURE drop_subscription (subscription_handle IN NUMBER);
131
132 END DBMS_CDC_SUBSCRIBE;