Class: MintPress::OracleDatabase::Parameter

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

Overview

An Oracle database parameter object that represents an Oracle Initialization parameter for an Oracle Database Instance Instance This class provides a set of methods to manage an Oracle Initialisation parameters in an Oracle Database instance. The attributes of this class closely resemble the GV$INSTANCE data dictionary view

Properties (Read/Write)

  • #name ⇒ String
    Name of the parameter
    Property Attributes
    • required ⇒ true
    

26
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/parameter.rb', line 26

property :name, required: true, type: String
  • #value ⇒ [String, Integer]
    Value to assign to the parameter
    Property Attributes
    • required ⇒ true
    

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

property :value, required: true, type: [String, Integer]
  • #scope ⇒ String (Default Value: 'both')
    Scope to apply the parameter to - SPFILE, MEMORY, or BOTH
    Property Attributes
    • required ⇒ true
    • default ⇒ 'both'
    • allowed_values ⇒ %w{SPFILE MEMORY BOTH spfile memory both}
    

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

property :scope, required: true, type: String, default: 'both', allowed_values: %w{SPFILE MEMORY BOTH spfile memory both}
  • #sid ⇒ String (Default Value: Proc.new { database.sid })
    Database SID to apply the parameter to. This defaults to the SID of the attached database
    Property Attributes
    • default ⇒ Proc.new { database.sid }
    

32
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/parameter.rb', line 32

property :sid, type: String, default: Proc.new { database.sid }
  • #comment ⇒ String
    Command to set when applying this parameter
    Property Attributes 
    

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

property :comment, type: String
  • #parent ⇒ MintPress::OracleDatabase::DatabaseCommon
    property :deferred, type: [ TrueClass, FalseClass ], default: false
    Property Attributes
    • prop_name ⇒ :parameters
    

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

property :parent, type: MintPress::OracleDatabase::DatabaseCommon, prop_name: :parameters
  • #database ⇒ MintPress::OracleDatabase::DatabaseCommon
    Database associated with this parameter
    Property Attributes
    • prop_name ⇒ :parameters
    

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

property :database, type: MintPress::OracleDatabase::DatabaseCommon, prop_name: :parameters
  • #db_username (Default Value: 'sys')
    Username with sys privilege. Defaults to 'sys'
    Property Attributes
    • default ⇒ 'sys'
    • alias ⇒ :dba_username
    

43
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/parameter.rb', line 43

property :db_username, default: 'sys', alias: :dba_username
  • #db_password ⇒ Mint::Secret
    Password for the above user
    Property Attributes
    • from ⇒ String
    • alias ⇒ :dba_password
    

46
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/parameter.rb', line 46

property :db_password, type: Mint::Secret, from: String, alias: :dba_password
  • #db_role ⇒ String
    Role for the above user
    Property Attributes 
    

49
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/parameter.rb', line 49

property :db_role, type: String
  • #db_connect_descriptor ⇒ String
    'Database connect descriptor that will override with advanced DB connect string such as failover and other advanced settings'
    Property Attributes 
    

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

property :db_connect_descriptor, type: String, description: 'Database connect descriptor that will override with advanced DB connect string such as failover and other advanced settings'
  • #host ⇒ MintPress::Infrastructure::Host (Default Value: Proc.new { MintPress::Infrastructure::LocalHost.new })
    Host used to acquire the OCI8 gem
    Property Attributes
    • required ⇒ true
    • default ⇒ Proc.new { MintPress::Infrastructure::LocalHost.new }
    

54
55
56
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/parameter.rb', line 54

property :host, type: MintPress::Infrastructure::Host, required: true, default: Proc.new {
  MintPress::Infrastructure::LocalHost.new
}

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

Returns a new instance of Parameter.

Instance Method Details

#reset ⇒ void

This method returns an undefined value.

Reset the initialisation parameter for a Database instance

#set ⇒ void

This method returns an undefined value.

Set the initialisation parameter for a Database instance

#usage ⇒ String

Example usage of the class

Returns: