1 PACKAGE DBMS_CDC_PUBLISH AUTHID CURRENT_USER AS
2
3 -------------------------------------------------------------------------------
4 -- PROCEDURE DBMS_CDC_PUBLISH.CREATE_AUTOLOG_CHANGE_SOURCE
5 --
6 -- Purpose: Describes the source system that is providing the asynchronous
7 -- AutoLog change data.
8 --
9 -- PROCEDURE DBMS_CDC_PUBLISH.ALTER_AUTOLOG_CHANGE_SOURCE
10 --
11 -- Purpose: Alter the properties of an AutoLog change source after it
12 -- has been created.
13 --
14 -- PROCEDURE DBMS_CDC_PUBLISH.DROP_CHANGE_SOURCE
15 --
16 -- Purpose: Drops the specifed change source.
17 --
18 -- PARAMETERS
19 --
20 -- change_source_name: The name of the change source
21 --
22 -- description: A comment field used to describe the source system in
23 -- more detail
24 --
25 -- remove_description: Whether to remove change source description (Y|N)
26 --
27 -- source_database: global database name of the source database that this
28 -- change source represents
29 --
30 -- first_scn: SCN of the LogMiner data dictionary at which capture can
31 -- begin
32 --
33 -- EXCEPTION DESCRIPTION
34 --
35 --
36 -------------------------------------------------------------------------------
37 -- PROCEDURE DBMS_CDC_PUBLISH.CREATE_CHANGE_SET
38 --
39 -- Purpose: Creates a change set and defines properties for the
40 -- change tables belonging to this change set.
41 --
42 -- PROCEDURE DBMS_CDC_PUBLISH.ALTER_CHANGE_SET
43 --
44 -- Purpose: Alter the properties of an existing change set.
45 --
46 -- PROCEDURE DBMS_CDC_PUBLISH.DROP_CHANGE_SET
47 --
48 -- Purpose: Drops the specifed change set.
49 --
50 -- PARAMETERS
51 --
52 -- change_set_name: The name of the change set.
53 --
54 -- description: A comment field used to describe the change set in
55 -- more detail
56 --
57 -- remove_description: Whether to remove change set description (Y|N)
58 --
59 -- change_source_name: Name of an existing change source that will feed this
60 -- change set.
61 --
62 -- stop_on_ddl: Indicates whether to stop capture when DDL is encountered
63 -- (Y|N)
64 --
65 -- begin_date: The date at which the change set should start capturing data.
66 --
67 -- end_date: The date at which the change set should end capturing data.
68 --
69 -- enable_capture: whether to enable capture for an asynchronous change set
70 -- (Y|N)
71 --
72 -- recover_after_error: whether to attempt to recover from previous
73 -- capture errors (Y|N)
74 --
75 -- EXCEPTION DESCRIPTION
76 --
77 --
78 -------------------------------------------------------------------------------
79 -- PROCEDURE DBMS_CDC_PUBLISH.CREATE_CHANGE_TABLE
80 --
81 -- Purpose: Creates a change table in the user's schema and sets several
82 -- parameters.
83 --
84 -- PROCEDURE DBMS_CDC_PUBLISH.ALTER_CHANGE_TABLE
85 --
86 -- Purpose: Alter the properties of an existing change table by adding or
87 -- dropping columns.
88 --
89 -- PROCEDURE DBMS_CDC_PUBLISH.DROP_CHANGE_TABLE
90 --
91 -- Purpose: Drops the specifed change table.
92 --
93 --
94 -- PARAMETERS
95 --
96 -- owner: The schema name that owns the change table.
97 --
98 -- change_table_name: The name of the change table.
99 --
100 -- column_[type_]list: A comma-separated list of columns [and datatypes]
101 -- that should be placed in the change table or dropped from the change table.
102 --
103 -- operation: Either the value 'DROP' or 'ADD' or NULL - indicates whether to
104 -- add or drop the columns when altering a change table.
105 --
106 -- rs_id: Indicates whether a column containing a sequence number
107 -- is included in the change table (Y|N)
108 --
109 -- row_id: Indicates whether a column containing the rowid of
110 -- the change in the source table is included in the change table (Y|N)
111 --
112 -- user_id: Indicates whether a column containing the username who issued
113 -- the DML statement is included in the change table (Y|N)
114 --
115 -- timestamp: Indicates whether a column containing the
116 -- timestamp of the change record is included in the change table (Y|N)
117 --
118 -- object_id: Indicates whethera column containing the
119 -- object-id is included in the change table
120 --
121 -- source_colmap: Indicates whether a column containing a
122 -- change column vector for the source table is included in the change table.
123 --
124 -- target_colmap: Indicates whether a column containing a
125 -- change column vector for the change table is included in the change table.
126 --
127 -- options_string: Quoted string containing a list of options to pass into
128 -- the CREATE TABLE DDL statement
129 --
130 -- EXCEPTION DESCRIPTION
131 --
132 --
133 -------------------------------------------------------------------------------
134 -- PROCEDURE DBMS_CDC_PUBLISH.DROP_SUBSCRIPTION
135 --
136 -- Purpose: Allows a publisher to remove an existing subscription.
137 --
138 -- PARAMETERS
139 --
140 -- subscription_name: Name of an existing subscription to drop
141 --
142 -- EXCEPTION DESCRIPTION
143 --
144 --
145 -------------------------------------------------------------------------------
146 -- PROCEDURE DBMS_CDC_PUBLISH.PURGE
147 --
148 -- Purpose: Initiates a purge of all change sets on staging database
149 --
150 -- PROCEDURE DBMS_CDC_PUBLISH.PURGE_CHANGE_SET
151 --
152 -- Purpose: Initiates a purge of the specified change set
153 --
154 -- PROCEDURE DBMS_CDC_PUBLISH.PURGE_CHANGE_TABLE
155 --
156 -- Purpose: Initiates a purge of the specified change table
157 --
158 -- PARAMETERS
159 --
160 -- change_set_name: Name of an existing change set to purge
161 --
162 -- owner: Owner of the change table to purge
163 --
164 -- change_table_name: Name of an existing change table to purge
165 --
166 --
167 -------------------------------------------------------------------------------
168 --
169 -- 10.2 publisher interface
170 --
171
172 -- This transaltes the DDLOPR$ value number into a text
173 -- This is used for quick understanding of this field
174 FUNCTION get_DDLOper (ddloper IN BINARY_INTEGER) RETURN VARCHAR2;
175
176 PROCEDURE create_hotlog_change_source (
177 change_source_name IN VARCHAR2,
178 description IN VARCHAR2 DEFAULT NULL,
179 source_database IN VARCHAR2);
180
181 PROCEDURE alter_hotlog_change_source (
182 change_source_name IN VARCHAR2,
183 description IN VARCHAR2 DEFAULT NULL,
184 remove_description IN CHAR DEFAULT 'N',
185 enable_source IN CHAR DEFAULT NULL);
186
187 --
188 -- 10i publisher interface
189 --
190
191 PROCEDURE create_autolog_change_source (
192 change_source_name IN VARCHAR2,
193 description IN VARCHAR2 DEFAULT NULL,
194 source_database IN VARCHAR2,
195 first_scn IN NUMBER,
196 online_log IN CHAR DEFAULT 'N');
197
198 PROCEDURE alter_autolog_change_source (
199 change_source_name IN VARCHAR2,
200 description IN VARCHAR2 DEFAULT NULL,
201 remove_description IN CHAR DEFAULT 'N',
202 first_scn IN NUMBER DEFAULT NULL);
203
204 PROCEDURE drop_change_source (change_source_name IN VARCHAR2);
205
206 PROCEDURE create_change_set (
207 change_set_name IN VARCHAR2,
208 description IN VARCHAR2 DEFAULT NULL,
209 change_source_name IN VARCHAR2,
210 stop_on_ddl IN CHAR DEFAULT 'N',
211 begin_date IN DATE DEFAULT NULL,
212 end_date IN DATE DEFAULT NULL);
213
214 PROCEDURE alter_change_set (
215 change_set_name IN VARCHAR2,
216 description IN VARCHAR2 DEFAULT NULL,
217 remove_description IN CHAR DEFAULT 'N',
218 enable_capture IN CHAR DEFAULT NULL,
219 recover_after_error IN CHAR DEFAULT NULL,
220 remove_ddl IN CHAR DEFAULT NULL,
221 stop_on_ddl IN CHAR DEFAULT NULL);
222
223 PROCEDURE drop_change_set (change_set_name IN VARCHAR2);
224
225 PROCEDURE create_change_table (owner IN VARCHAR2,
226 change_table_name IN VARCHAR2,
227 change_set_name IN VARCHAR2,
228 source_schema IN VARCHAR2,
229 source_table IN VARCHAR2,
230 column_type_list IN VARCHAR2,
231 capture_values IN VARCHAR2,
232 rs_id IN CHAR,
233 row_id IN CHAR,
234 user_id IN CHAR,
235 timestamp IN CHAR,
236 object_id IN CHAR,
237 source_colmap IN CHAR,
238 target_colmap IN CHAR,
239 options_string IN VARCHAR2,
240 ddl_markers IN CHAR DEFAULT 'Y');
241
242 PROCEDURE alter_change_table (owner IN VARCHAR2,
243 change_table_name IN VARCHAR2,
244 operation IN VARCHAR2,
245 column_list IN VARCHAR2,
246 rs_id IN CHAR,
247 row_id IN CHAR,
248 user_id IN CHAR,
249 timestamp IN CHAR,
250 object_id IN CHAR,
251 source_colmap IN CHAR,
252 target_colmap IN CHAR,
253 ddl_markers IN CHAR DEFAULT NULL);
254
255 PROCEDURE drop_change_table (owner IN VARCHAR2,
256 change_table_name IN VARCHAR2,
257 force_flag IN CHAR);
258
259 PROCEDURE drop_subscription (subscription_name IN VARCHAR2);
260
261 PROCEDURE purge;
262
263 PROCEDURE purge_change_set (change_set_name IN VARCHAR2,
264 force IN CHAR DEFAULT 'Y',
265 purge_date IN DATE DEFAULT NULL);
266
267 PROCEDURE purge_change_table (owner IN VARCHAR2,
268 change_table_name IN VARCHAR2,
269 force IN CHAR DEFAULT 'Y',
270 purge_date IN DATE DEFAULT NULL);
271
272 --
273 -- 9i publisher interface - deprecated
274 --
275
276 PROCEDURE drop_subscriber_view (subscription_handle IN NUMBER,
277 source_schema IN VARCHAR2,
278 source_table IN VARCHAR2);
279
280 PROCEDURE drop_subscription (subscription_handle IN NUMBER);
281
282 END DBMS_CDC_PUBLISH;