Class: MintPress::OracleDatabase::RMAN

Inherits:
Object
  • Object
show all
Includes:
MintLogger, Mixins::Properties, Utils
Defined in:
src/oracle-database/lib/oracle-database/model/database/rman.rb

Overview

An RMAN object that represents an Oracle RecoveryMANager This class provides a set of methods to Back up, restore, and recover Oracle databases

Since:

  • 0.1.0

Properties (Read/Write)

  • #name ⇒ String (Default Value: self.class.to_s.gsub('::',''))
    The name of ORACLE_HOME installation
    Property Attributes
    • default ⇒ self.class.to_s.gsub('::','')
    

24
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 24

property :name, type: String, default: self.class.to_s.gsub('::','')
  • #db_host ⇒ MintPress::Infrastructure::Host
    Database host
    Property Attributes
    • required ⇒ true
    

27
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 27

property :db_host, type: MintPress::Infrastructure::Host, required: true
  • #db_port ⇒ Integer (Default Value: 1521)
    Database connect port - this defaults to 1521.
    Property Attributes
    • required ⇒ true
    • default ⇒ 1521
    

30
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 30

property :db_port, type: Integer, required: true, default: 1521
  • #oracle_home ⇒ Pathname
    The oracle home for the server installation Specify the complete path of the Oracle Home.
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    

34
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 34

property :oracle_home, type: Pathname, from: String, required: true
  • #instance_name ⇒ String
    The instance name for the database
    Property Attributes
    • required ⇒ true
    

37
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 37

property :instance_name, type: String, required: true
  • #db_username (Default Value: 'sys')
    Username for the sys user. Defaults to 'sys' Leaving alias: :sysdba_username for backward compatibility
    Property Attributes
    • default ⇒ 'sys'
    • alias ⇒ :sysdba_username
    

41
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 41

property :db_username, default: 'sys', alias: :sysdba_username
  • #db_password ⇒ Mint::Secret
    Password for the sys user Leaving alias: :sysdba_password for backward compatibility
    Property Attributes
    • from ⇒ String
    • alias ⇒ :sysdba_password
    

45
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 45

property :db_password, type: Mint::Secret, from: String, alias: :sysdba_password
  • #console_output ⇒ [TrueClass, FalseClass] (Default Value: true)
    property that controls if console output is show in stdout
    Property Attributes
    • default ⇒ true
    

48
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 48

property :console_output, type: [TrueClass, FalseClass], default: true
  • #backup_mode ⇒ String (Default Value: 'ARCHIVELOG')
    Mode of backup ARCHIVELOG(inconsistent backup)/NOARCHIVELOG(consistent backup)
    Property Attributes
    • required ⇒ true
    • default ⇒ 'ARCHIVELOG'
    • allowed_values ⇒ ["ARCHIVELOG", "NOARCHIVELOG"]
    

51
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 51

property :backup_mode, type: String, required: true, default: 'ARCHIVELOG', allowed_values: ["ARCHIVELOG", "NOARCHIVELOG"]
  • #backup_type ⇒ String (Default Value: 'CDB')
    Type of backup CDB/PDB
    Property Attributes
    • required ⇒ true
    • default ⇒ 'CDB'
    • allowed_values ⇒ ["CDB", "PDB"]
    

54
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 54

property :backup_type, type: String, required: true, default: 'CDB', allowed_values: ["CDB", "PDB"]
  • #pdb ⇒ String
    PDB name
    Property Attributes 
    

57
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 57

property :pdb, type: String
  • #auth_mode ⇒ String (Default Value: 'OS')
    Type of RMAN authentication (Operating System Authentication, Net Service Name)
    Property Attributes
    • required ⇒ true
    • default ⇒ 'OS'
    • allowed_values ⇒ ["OS", "NETSERVICE"]
    

60
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 60

property :auth_mode, type: String, required: true, default: 'OS', allowed_values: ["OS", "NETSERVICE"]
  • #list_option ⇒ String (Default Value: 'BACKUP OF DATABASE')
    List Backups choice
    Property Attributes
    • required ⇒ true
    • default ⇒ 'BACKUP OF DATABASE'
    

63
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 63

property :list_option, type: String, required: true, default: 'BACKUP OF DATABASE'
  • #report_option ⇒ String (Default Value: 'NEED BACKUP DATABASE')
    Report Backups choice
    Property Attributes
    • required ⇒ true
    • default ⇒ 'NEED BACKUP DATABASE'
    

66
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 66

property :report_option, type: String, required: true, default: 'NEED BACKUP DATABASE'
  • #format ⇒ Pathname
    Specifies a location and name for backup pieces and copies
    Property Attributes
    • from ⇒ String
    

69
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 69

property :format, type: Pathname, from: String
  • #tag ⇒ String
    Specifies a user-defined string as a label for the backup
    Property Attributes 
    

72
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 72

property :tag, type: String
  • #configuration_parameters ⇒ Array of ⇒ String
    An array of configuration parameters to be updated
    Property Attributes 
    

75
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 75

property :configuration_parameters, type: String, array: true
  • #log ⇒ Pathname
    Specifies a location and name forlogs
    Property Attributes
    • from ⇒ String
    

78
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 78

property :log, type: Pathname, from: String
  • #target_tmp_dir ⇒ String (Default Value: '#{oracle_home}/../tmp')
    Which folder should we use for temporary files?
    Property Attributes
    • default ⇒ '#{oracle_home}/../tmp'
    

81
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 81

property :target_tmp_dir, type: String, default: '#{oracle_home}/../tmp'
  • #incremental_backup ⇒ [TrueClass, FalseClass] (Default Value: false)
    Incremental Backups
    Property Attributes
    • default ⇒ false
    

84
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 84

property :incremental_backup, type: [TrueClass, FalseClass], default: false
  • #increment_backup_level ⇒ Integer (Default Value: 0)
    Incremental backup level. An incremental backup at level 0 is identical in content to a full backup,
    Property Attributes
    • required ⇒ true
    • default ⇒ 0
    

87
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 87

property :increment_backup_level, type: Integer, required: true, default: 0
  • #cumulative ⇒ [TrueClass, FalseClass] (Default Value: false)
    cumulative incremental backup or differential incremental backup
    Property Attributes
    • default ⇒ false
    

90
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 90

property :cumulative, type: [TrueClass, FalseClass], default: false
  • #db_recovery_file_dest ⇒ String
    fast recovery area location
    Property Attributes
    • required ⇒ false
    

93
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 93

property :db_recovery_file_dest, type: String, required: false
  • #db_recovery_file_dest_size ⇒ String
    fast recovery area size
    Property Attributes
    • required ⇒ false
    

96
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 96

property :db_recovery_file_dest_size, type: String, required: false
  • #db_recovery_file_dest_scope ⇒ String (Default Value: 'BOTH')
    fast recovery area SCOPE
    Property Attributes
    • required ⇒ false
    • default ⇒ 'BOTH'
    

99
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 99

property :db_recovery_file_dest_scope, type: String, required: false, default: 'BOTH'
  • #db_recovery_file_dest_sid ⇒ String (Default Value: '*')
    fast recovery area SID
    Property Attributes
    • required ⇒ false
    • default ⇒ '*'
    

102
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 102

property :db_recovery_file_dest_sid, type: String, required: false, default: '*'
  • #autoenable_archivelog ⇒ [TrueClass, FalseClass] (Default Value: false)
    "Automatically enables archive log"
    Property Attributes
    • default ⇒ false
    

104
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/rman.rb', line 104

property :autoenable_archivelog, type: [TrueClass, FalseClass], default: false, description: "Automatically enables archive log"

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from Utils

#session, #sql_ruby_session, #to_hash

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ RMAN

Returns a new instance of RMAN.

Since:

  • 0.1.0

Instance Method Details

#backup ⇒ void

This method returns an undefined value.

backup the database The back up location in order of preference: A. FORMAT location if provided B. fast recovery area location and size with the DB_RECOVERY_FILE_DEST and DB_RECOVERY_FILE_DEST_SIZE initialization parameters. C. default location

Since:

  • 0.1.0

#configure ⇒ void

This method returns an undefined value.

update RMAN configuration parameters

Since:

  • 0.1.0

#delete ⇒ void

This method returns an undefined value.

deletes the backups

Since:

  • 0.1.0

#execute(operation) ⇒ Object

Since:

  • 0.1.0

#list ⇒ void

This method returns an undefined value.

lists the backup user can pass any RMAN supported 'list' option - the default is BACKUP OF DATABASE Example: BACKUP BY FILE, BACKUP OF DATABASE BY BACKUP, BACKUP SUMMARY, BACKUP RECOVERABLE, EXPIRED COPY

Since:

  • 0.1.0

#report ⇒ void

This method returns an undefined value.

lists the backup user can pass any RMAN supported 'report' option - the default is NEED BACKUP DATABASE Example: OBSOLETE, SCHEMA, UNRECOVERABLE

Since:

  • 0.1.0

#show ⇒ void

This method returns an undefined value.

shows the current RMAN configuration parameters

Since:

  • 0.1.0

#usage ⇒ String

Example usage of the class

Returns:

Since:

  • 0.1.0