DBA Data[Home] [Help]

PACKAGE: SYS.DBMS_ROLLING

Source


1 PACKAGE     dbms_rolling AUTHID CURRENT_USER AS
2 
3 --
4 -- NAME
5 --   rollback_plan
6 --
7 -- DESCRIPTION
8 --   This procedure rolls back the group of DBMS_ROLLING administered
9 --   databases to their initial state.  The DBMS_ROLLING package will
10 --   create an initial set of guaranteed restore points for all participating
11 --   databases.  This procedure will flashback all databases in the leading
12 --   change group to their respective restore points.  This procedure will only
13 --   permit the rollback if the switchover has not been performed.
14 --
15 PROCEDURE rollback_plan;
16 
17 --
18 -- NAME
19 --   build_plan
20 --
21 -- DESCRIPTION
22 --   This procedure either builds a complete upgrade plan or modifies the
23 --   remaining unprocessed portion of an existing plan.  The build procedure
24 --   interprets the configured rolling upgrade parameters to produce a
25 --   customized upgrade plan.
26 --
27 PROCEDURE build_plan;
28 
29 --
30 -- NAME
31 --   destroy_plan
32 --
33 -- DESCRIPTION
34 --   This procedure purges all rolling upgrade state from the database.  It
35 --   is called upon completion of the rolling upgrade.
36 --
37 PROCEDURE destroy_plan;
38 
39 --
40 -- NAME
41 --   finish_plan
42 --
43 -- DESCRIPTION
44 --   This procedure executes the FINISH phase instructions in the upgrade
45 --   plan.  It is called after the START and SWITCHOVER phase instructions
46 --   have completed, and the user has restarted the original primary and
47 --   physical standbys of the primary on their higher version binaries.
48 --   Upon completion of this procedure, the original primary and its
49 --   physical standbys will have completed recovery of the ugprade redo.
50 --
51 PROCEDURE finish_plan;
52 
53 --
54 -- NAME
55 --   init_plan
56 --
57 -- DESCRIPTION
58 --   This procedure is the first procedure that must be called to prepare
59 --   for a DBMS_ROLLING administered rolling upgrade.  It communicates
60 --   with the complete set of databases in the DG_CONFIG, and creates a
61 --   default set of rolling upgrade parameters for building rolling
62 --   upgrade plans.
63 --
64 PROCEDURE init_plan (future_primary IN VARCHAR2);
65 
66 --
67 -- NAME
68 --   set_parameter
69 --
70 -- DESCRIPTION
71 --   This procedure is called to set and unset rolling upgrade parameters.
72 --   Changes to the plan parameters, however, do not take effect until the
73 --   user re-invokes the BUILD procedure to reconstruct the upgrade plan.
74 --
75 PROCEDURE set_parameter (scope IN VARCHAR2, name IN VARCHAR2,
76                          value IN VARCHAR2);
77 PROCEDURE set_parameter (name IN VARCHAR2, value IN VARCHAR2);
78 
79 
80 --
81 -- NAME
82 --   start_plan
83 --
84 -- DESCRIPTION
85 --   This procedure executes the START phase instructions in the upgrade plan.
86 --   It is the first procedure that is called to initiate the rolling upgrade.
87 --   Upon completion of this phase, the future primary will be ready to be
88 --   ugpraded.
89 --
90 PROCEDURE start_plan;
91 
92 --
93 -- NAME
94 --   switchover
95 --
96 -- DESCRIPTION
97 --   This procedure executes the SWITCHOVER phase instructions in the upgrade
98 --   plan.  It is called once the START procedure has completed execution of
99 --   all START phase instructions.  It is responsible for switching the
100 --   configuration over to the new primary which will have been upgraded by
101 --   the time this procedure is called.  Upon completion of this procedure,
102 --   the future primary will be the new primary, and the original primary
103 --   and physicals of the original primary will be ready for restart on
104 --   their higher version binaries.
105 --
106 PROCEDURE switchover;
107 
108 END dbms_rolling;