DBA Data[Home] [Help]

PACKAGE: SYS.DBMS_PDB

Source


1 package dbms_pdb authid current_user is
2 
3   ----------------------------
4   --  PROCEDURES AND FUNCTIONS
5   --
6   procedure describe(pdb_descr_file varchar2,
7                      pdb_name varchar2 DEFAULT NULL);
8   -- Generate an XML which describes the various tablespaces and the datafiles
9   -- that belong to the pluggable database
10   --  Input arguments:
11   --    pdb_descr_file - path of the XML file which will contain description
12   --                     of a Pluggable Database.
13   --    pdb_name - name of a Pluggable Database to be described. If pdb_name
14   --               is omitted, the Pluggable Database to which the session
15   --               is connected will be described. If pdb_name is omitted,
16   --               and the session is connected to the Root, an error will
17   --               be returned.
18 
19   function check_plug_compatibility(pdb_descr_file IN varchar2,
20                                     pdb_name IN varchar2 DEFAULT NULL)
21            return boolean;
22   -- Determine whether a pluggable database described by file pdb_descr_file
23   -- is compatibile with the current cdb
24   --  Input arguments:
25   --    pdb_descr_file - path of the XML file which will contain description
26   --                     of a Pluggable Database.
27   --    pdb_name       - name of the Pluggable Database to be used for the
28   --                     check. If pdb_name is omitted, PDB name in the
29   --                     XML file will be used.
30 
31   procedure exec_as_oracle_script(sql_stmt varchar2);
32   -- NAME:
33   --   exec_as_oracle_script - execute a statement as oracle script
34   --
35   -- DESCRIPTION:
36   --   This procedure enables execution of certain restricted statements
37   --   (most DDLs) on metadata-linked objects, from within a pdb.  This is
38   --   accomplished by running the statement as an oracle script (i.e. with
39   --   the parameter _oracle_script set to TRUE).  This is for use by Oracle
40   --   internal packages only.
41   --
42   -- PARAMETERS:
43   --   sql_stmt (IN) - sql statement to execute
44   --
45   -- NOTE
46   --   ************************************************************************
47   --   ************************************************************************
48   --   IMPORTANT, PLEASE READ!
49   --   This procedure is not meant to be documented.  It is supplied for use by
50   --   Oracle internal packages only to bypass some restrictions for pluggable
51   --   databases.  Please talk to the package owners to determine if it is
52   --   appropriate to use this procedure in your particular usage scenario.
53   --   ************************************************************************
54   --   ************************************************************************
55 
56   --   The following routine is related to operations done in SMON
57   --   until 11.2. But, with the introduction of PDBs in 12c and with
58   --   the possibility of having multiple PDBs in a single
59   --   CDB, we want to move this cleanup out of SMON so that SMON is not
60   --   overloaded with work that can be done in some other background process.
61   --   The goal is to move everything except transaction recovery out of SMON.
62 
63   function cleanup_task(task_id number)
64     return number;
65 
66   -- NAME:
67   -- cleanup_task - cleanup task previously done in SMON
68   --
69   -- DESCRIPTION:
70   --   This procedure performs cleanup task previously done in SMON
71   --
72   -- PARAMETERS:
73   -- task_id  - Task Id
74   --
75   -- RETURNS:
76   -- 0 - if the next scheduled time for job does not need to be changed.
77   -- N - if the next scheduled time for job should be N seconds from now
78   --
79   -- NOTE
80   --   ************************************************************************
81   --   ************************************************************************
82   --   IMPORTANT, PLEASE READ!
83   --   This procedure is not meant to be documented.  It is supplied for use by
84   --   Oracle internal scripts only. Please talk to the package owners to
85   --   determine if it is appropriate to use this procedure in your particular
86   --   usage scenario.
87   --   ************************************************************************
88 
89   procedure sync_pdb;
90   -- NAME:
91   -- sync_pdb - sync PDB with CDB
92   --
93   -- DESCRIPTION:
94   --   After plug, syncs the PDB with the CDB, so that it will be ready for use.
95   --   ************************************************************************
96 
97   procedure recover(pdb_descr_file varchar2, pdb_name varchar2, filenames varchar2);
98   -- Recover the PDB XML file from datafile headers
99   --  Input arguments:
100   --    pdb_descr_file - path of the XML file which will contain description
101   --                     of a Pluggable Database.
102   --    pdb_name - pluggable database name to use in the XML file
103   --    filenames - full path of the datafile belongs to the PDB. If there are
104   --                multiple datafiles, a comma (ie ',') seperator should be
105   --                inserted between two datafile paths.
106   --   ************************************************************************
107 
108   function update_cdbvw_stats
109     return number;
110 
111   -- NAME:
112   -- update_cdbvw_stats - update CDB View Stats
113   --
114   -- DESCRIPTION:
115   --   This procedure updates CDB View Stats
116   --
117   -- PARAMETERS:
118   --
119   -- RETURNS:
120   -- 0 - if the next scheduled time for job does not need to be changed.
121   -- N - if the next scheduled time for job should be N seconds from now
122   --
123   -- NOTE
124   --   ************************************************************************
125   --   ************************************************************************
126   --   IMPORTANT, PLEASE READ!
127   --   This procedure is not meant to be documented.  It is supplied for use by
128   --   Oracle internal scripts only. Please talk to the package owners to
129   --   determine if it is appropriate to use this procedure in your particular
130   --   usage scenario.
131   --   ************************************************************************
132 
133   procedure noncdb_to_pdb(phase number);
134 
135   -- NAME:
136   --   noncdb_to_pdb - Helper procedure for noncdb_to_pdb.sql
137   --
138   -- DESCRIPTION:
139   --   This procedure is internally used by noncdb_to_pdb.sql
140   --
141   -- PARAMETERS:
142   --   phase  (IN)  - phase of script
143   --
144 
145   procedure update_version;
146   -- NAME:
147   -- update_version - update PDB's VSN
148   --
149   -- DESCRIPTION:
150   --   update PDB's VSN in container$ after upgrade.
151   --
152   -- NOTE
153   --   ************************************************************************
154   --   ************************************************************************
155   --   IMPORTANT, PLEASE READ!
156   --   This procedure is not meant to be documented.  It is supplied for use by
157   --   Oracle internal scripts only. Please talk to the package owners to
158   --   determine if it is appropriate to use this procedure in your particular
159   --   usage scenario.
160   --   ************************************************************************
161   --   ************************************************************************
162 
163   function update_comdata_stats
164     return number;
165 
166   -- NAME:
167   -- update_comdata_stats - update Stats for Common Data Views
168   --
169   -- DESCRIPTION:
170   --   This procedure updates Common Data View stats.
171   --
172   -- PARAMETERS:
173   --
174   -- RETURNS:
175   -- 0 - if the next scheduled time for job does not need to be changed.
176   -- N - if the next scheduled time for job should be N seconds from now
177   --
178   -- NOTE
179   --   ************************************************************************
180   --   ************************************************************************
181   --   IMPORTANT, PLEASE READ!
182   --   This procedure is not meant to be documented.  It is supplied for use by
183   --   Oracle internal scripts only. Please talk to the package owners to
184   --   determine if it is appropriate to use this procedure in your particular
185   --   usage scenario.
186   --   ************************************************************************
187 
188   function update_objlink_stats
189     return number;
190 
191   -- NAME:
192   -- update_objlink_stats - update Stats for Object Linked Views
193   --
194   -- DESCRIPTION:
195   --   This procedure updates Object Linked View stats. It needs to be invoked
196   --   only in ROOT. If invoked in PDB, this procedure is a NO-OP.
197   --
198   -- PARAMETERS:
199   --
200   -- RETURNS:
201   -- 0 - if the next scheduled time for job does not need to be changed.
202   -- N - if the next scheduled time for job should be N seconds from now
203   --
204   -- NOTE
205   --   ************************************************************************
206   --   ************************************************************************
207   --   IMPORTANT, PLEASE READ!
208   --   This procedure is not meant to be documented.  It is supplied for use by
209   --   Oracle internal scripts only. Please talk to the package owners to
210   --   determine if it is appropriate to use this procedure in your particular
211   --   usage scenario.
212   --   ************************************************************************
213 
214   -- DESCRIPTION:
215   --   This procedure should be called to create Permanent Tables corresponding
216   --   to controlfile related Fixed Tables. It should be invoked in ROOT.
217   -- NOTE
218   --   ************************************************************************
219   --   ************************************************************************
220   --   IMPORTANT, PLEASE READ!
221   --   This procedure is not meant to be documented.  It is supplied for use by
222   --   Oracle internal scripts only. Please talk to the package owners to
223   --   determine if it is appropriate to use this procedure in your particular
224   --   usage scenario.
225   --   ************************************************************************
226   --   ************************************************************************
227   --   ************************************************************************
228   procedure createX$PermanentTables;
229 
230   -- DESCRIPTION:
231   --   This procedure should be called to drop Permanent Tables corresponding
232   --   to controlfile related Fixed Tables. It should be invoked in ROOT.
233   -- NOTE
234   --   ************************************************************************
235   --   ************************************************************************
236   --   IMPORTANT, PLEASE READ!
237   --   This procedure is not meant to be documented.  It is supplied for use by
238   --   Oracle internal scripts only. Please talk to the package owners to
239   --   determine if it is appropriate to use this procedure in your particular
240   --   usage scenario.
241   --   ************************************************************************
242   --   ************************************************************************
243   --   ************************************************************************
244   procedure dropX$PermanentTables;
245 
246   procedure populateSyncTable;
247   -- NAME:
248   -- populateSyncTable - populates pdbsync$ on upgrade from 12.1.0.1
249   --
250   -- DESCRIPTION:
251   --   when upgrading from 12.1.0.1
252   --
253   -- NOTE
254   --   ************************************************************************
255   --   ************************************************************************
256   --   IMPORTANT, PLEASE READ!
257   --   This procedure is not meant to be documented.  It is supplied for use by
258   --   Oracle internal scripts only. Please talk to the package owners to
259   --   determine if it is appropriate to use this procedure in your particular
260   --   usage scenario.
261   --   ************************************************************************
262   --   ************************************************************************
263 
264 
265 end;