Class: MintPress::OracleDatabase::PluggableDatabase

Inherits:
DatabaseCommon show all
Includes:
MintLogger, Mixins::Properties
Defined in:
src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb

Overview

An Oracle pluggable database object that represents an Oracle pluggable database associated with its parent container database This class provides a set of methods to create, delete, and unplug pluggable databases. This class uses the Oracle Database Creation Assistant to create/delete/unplug pluggable databases

Since:

  • 0.1.0

Properties (Read/Write)

  • #name ⇒ String
    The name of the pluggable database
    Property Attributes
    • required ⇒ true
    

28
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 28

property :name, required: true, type: String
  • #db_service_name ⇒ String (Default Value: Proc.new { self.name })
    Note that non-harvest actions will instead either connect directly on the local socket, or they will use the listener, and this will be ignored.
    Property Attributes
    • default ⇒ Proc.new { self.name }
    

31
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 31

property :db_service_name, type: String, default: Proc.new { self.name }
  • #cdb ⇒ MintPress::OracleDatabase::Database
    The container database of type {MintPress::OracleDatabase::Database}
    Property Attributes
    • required ⇒ true
    

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

property :cdb, type: MintPress::OracleDatabase::Database, required: true
  • #parent ⇒ MintPress::OracleDatabase::Database
    The parent container database of type {MintPress::OracleDatabase::Database}
    Property Attributes
    • prop_name ⇒ :pluggables
    

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

property :parent, type: MintPress::OracleDatabase::Database, prop_name: :pluggables
  • #create_as_clone ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    Create the pluggable database as a clone using the createAsClone of DBCA
    Property Attributes
    • default ⇒ false
    

40
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 40

property :createAsClone, type: [ TrueClass, FalseClass ], default: false
  • #create_pdb_from ⇒ String (Default Value: 'IGNORE')
    Create the pluggable database from which source using the createPDBFrom property of DBCA
    Property Attributes
    • allowed_values ⇒ %w{DEFAULT FILEARCHIVE RMANBACKUP USINGXML IGNORE},
    • default ⇒ 'IGNORE'
    

42
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 42

property :createPDBFrom, type: String, allowed_values: %w{DEFAULT FILEARCHIVE RMANBACKUP USINGXML IGNORE}, default: 'IGNORE'
  • #pdb_admin_user_name (Default Value: 'pdbadmin')
    The user name of the PDB's local administrator
    Property Attributes
    • default ⇒ 'pdbadmin'
    • required ⇒ true
    

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

property :pdbAdminUserName, default: 'pdbadmin', required: true
  • #pdb_admin_password ⇒ Mint::Secret (Default Value: Proc.new { r = nil if cdb r = cdb.db_password end r })
    The password of the PDB's local administrator
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    • default ⇒ Proc.new { r = nil if cdb r = cdb.db_password end r }
    

48
49
50
51
52
53
54
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 48

property :pdbAdminPassword, type: Mint::Secret, from: String, required: true, default: Proc.new {
        r = nil
        if cdb
          r = cdb.db_password
        end
        r
}
  • #pdb_roles ⇒ Array of ⇒ String (Default Value: [])
    Roles to be assigned to local administrator
    Property Attributes
    • default ⇒ []
    

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

property :pdbRoles, type: String, array: true, default: []
  • #pdb_archive_file ⇒ Pathname
    FILEARCHIVE Options
    Property Attributes
    • from ⇒ String
    

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

property :pdbArchiveFile, type: Pathname, from: String
  • #create_new_pdb_admin_user ⇒ [TrueClass, FalseClass] (Default Value: false)

    Property Attributes
    • default ⇒ false
    

61
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 61

property :createNewPDBAdminUser, type: [TrueClass, FalseClass], default: false
  • #pdb_back_upfile ⇒ Pathname
    RMANBACKUP Options
    Property Attributes
    • from ⇒ String
    

64
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 64

property :pdbBackUpfile, type: Pathname, from: String
  • #pdb_metadata_file ⇒ Pathname
    Both RMANBACKUP and USINGXML Options
    Property Attributes
    • from ⇒ String
    

67
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 67

property :pdbMetadataFile, type: Pathname, from: String
  • #copy_pdb_files ⇒ [TrueClass, FalseClass] (Default Value: false)

    Property Attributes
    • default ⇒ false
    

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

property :copyPDBFiles, type: [TrueClass, FalseClass], default: false
  • #pdb_datafile_destination ⇒ Pathname
    The datafile location for the pluggable database
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    

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

property :pdbDatafileDestination, type: Pathname, from: String, required: true
  • #use_meta_data_file_location (Default Value: false)

    Property Attributes
    • kind_of ⇒ [TrueClass, FalseClass]
    • default ⇒ false
    

74
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 74

property :useMetaDataFileLocation, kind_of: [TrueClass, FalseClass], default: false
  • #create_user_table_space (Default Value: false)

    Property Attributes
    • kind_of ⇒ [TrueClass, FalseClass]
    • default ⇒ false
    

76
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 76

property :createUserTableSpace, kind_of: [TrueClass, FalseClass], default: false
  • #parameters ⇒ Hash of ⇒ MintPress::OracleDatabase::Parameter (Default Value: {})
    All of the parameters to apply to this database
    Property Attributes
    • default ⇒ {}
    • canonical ⇒ true
    

79
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 79

property :parameters, type: MintPress::OracleDatabase::Parameter, default: {}, hash: true, canonical: true
  • #alternate_service_names ⇒ Array of ⇒ String
    Any alternate service names this database is accessable as. It will always be accessable as the default service.
    Property Attributes 
    

82
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/pluggable_database.rb', line 82

property :alternate_service_names, type: String, array: true

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 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 = {}) ⇒ PluggableDatabase

Returns a new instance of PluggableDatabase.

Since:

  • 0.1.0

Instance Method Details

#create ⇒ Object

Since:

  • 0.1.0

#delete ⇒ Object

Since:

  • 0.1.0

#exists? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.1.0

#open_mode(sql) ⇒ Object

Since:

  • 0.1.0

#running? ⇒ Boolean

Returns:

  • (Boolean)

Since:

  • 0.1.0

#start ⇒ Object

Since:

  • 0.1.0

#stop ⇒ Object

Since:

  • 0.1.0

#unplug ⇒ Object

Since:

  • 0.1.0

#usage ⇒ Object

Since:

  • 0.1.0