DBA Data[Home] [Help]

PACKAGE: SYS.DBMS_STORAGE_MAP

Source


1 PACKAGE dbms_storage_map AUTHID CURRENT_USER AS
2 
3   --
4   -- map_object()
5   -- builds the mapping information for the object identified by
6   -- objname.
7   --
8   -- Input arguments:
9   --   objname			- name of object
10   --   objtype                  - object type
11   --
12 
13   PROCEDURE map_object(objname IN VARCHAR2,
14                        owner   IN VARCHAR2,
15 		       objtype IN VARCHAR2
16 		       );
17 
18   --
19   -- map_element()
20   -- builds the mapping information for the element identified by
21   -- elemname.
22   --
23   -- Input arguments:
24   --   elemname			- name of element
25   --   cascade			- cascade parameter, if true, all elements
26   --				  within the I/O stack DAG for elemname
27   --				  are mapped.
28   --   dictionary_update	- if true, mapping info in data dictionary
29   --				  is updated to reflect changes
30   --
31 
32   PROCEDURE map_element(elemname IN VARCHAR2,
33 			cascade IN BOOLEAN,
34 			dictionary_update IN BOOLEAN DEFAULT TRUE
35 			);
36 
37   --
38   -- map_file()
39   -- builds the mapping info for the file identified by filename
40   --
41   -- Input arguments:
42   --   file			- name of file
43   --   filetype			- type of file, 'datafile', 'spfile',
44   --				  'tempfile', 'controlfile', 'logfile',
45   --				  'archivefile'
46   --   cascade			- cascade parameter, if true, mapping DAGs are
47   --				  also built for elements where file resides
48   --   max_num_fileextent	- the maximum number of file extents to
49   --				  be mapped
50   --   dictionary_update	- if true, update data dictionary w/ map info
51   --
52 
53   PROCEDURE map_file(filename IN VARCHAR2,
54 		     filetype IN VARCHAR2,
55 		     cascade IN BOOLEAN,
56 		     max_num_fileextent IN NUMBER DEFAULT 100,
57 		     dictionary_update IN BOOLEAN DEFAULT TRUE
58 		     );
59 
60   --
61   -- map_all()
62   -- builds the entire mapping info for all Oracle data files including
63   -- DAG elements
64   --
65   -- Input arguments:
66   --   max_num_fileext          - the maximum number of file extents to
67   --				  be mapped
68   --   dictionary_update	- if true, update data dictionary w/ map info
69   --
70 
71   PROCEDURE map_all(max_num_fileextent IN NUMBER DEFAULT 100,
72 		    dictionary_update IN BOOLEAN DEFAULT TRUE
73 		    );
74 
75 
76   --
77   -- drop_element()
78   -- drops mapping info for the element defined by elemname
79   --
80   -- Input arguments:
81   --   elemname			- name of element
82   --   cascade			- cascade parameter, if true, all elements
83   --				  within the I/O stack DAG for elemname
84   --				  are dropped.
85   --   dictionary_update	- if true, mapping info in data dictionary
86   --				  is updated to reflect changes
87   --
88 
89   PROCEDURE drop_element(elemname IN VARCHAR2,
90 			 cascade IN BOOLEAN,
91 			 dictionary_update IN BOOLEAN DEFAULT TRUE
92 			 );
93 
94   --
95   -- drop_file()
96   -- drop the file mapping infor defined by filename
97   --
98   -- Input arguments:
99   --   filename			- name of file
100   --   cascade			- cascade parameter, mapping DAGs for elements
101   --				  where the file resides are dropped
102   --   dictionary_update	- if true, update data dictionary
103   --
104 
105   PROCEDURE drop_file(filename IN VARCHAR2,
106 		      cascade IN BOOLEAN,
107 		      dictionary_update IN BOOLEAN DEFAULT TRUE
108 		      );
109 
110   --
111   -- drop_all()
112   -- drop all mapping information in the shard memory of the instance
113   --
114   --   dictionary_update	- if true, update data dictionary
115   --
116 
117   PROCEDURE drop_all(dictionary_update IN BOOLEAN DEFAULT TRUE
118 		     );
119 
120   --
121   -- save()
122   -- This function saves into the data dictionary the required information
123   -- needed to regenerate the entire mapping information.
124   --
125 
126   PROCEDURE save;
127 
128   --
129   -- restore()
130   -- This function restores the entire mapping information from the data
131   -- dictionary into the shared memory of the instance. restore() needs to
132   -- be explicitly called in a warm startup scenario. restore() can only
133   -- be invoked after a save() operation.
134   --
135 
136   PROCEDURE restore;
137 
138   --
139   -- lock_map()
140   -- This function locks the mapping information in the shared memory of
141   -- the instance in either shared or exclusive mode
142   --
143   -- Input argument:
144   --   lock_mode - locking mode - 'SHARED' or 'EXCLUSIVE'
145   --
146 
147   PROCEDURE lock_map;
148 
149   --
150   -- unlock_map()
151   -- This function unlocks the mapping information in the shared memory
152   -- of the instance
153   --
154 
155   PROCEDURE unlock_map;
156 
157 END dbms_storage_map;