Class: MintPress::OracleRCU::Client

Inherits:
Object
  • Object
show all
Includes:
MintLogger, Mixins::Properties, MintPress::OracleUtils
Defined in:
src/oracle-rcu/lib/oracle-rcu/client.rb

Overview

This resource provides direct access to the oracle RCU client. It is not recommended to use this, but instead use the wls_metadata_repository resource which is linked to the domain object.

Properties (Read/Write)

  • #standard_components ⇒ [TrueClass, FalseClass] (Default Value: true)
    Should we install standard components, such as STB?
    Property Attributes
    • default ⇒ true
    

37
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 37

property :standard_components, type: [TrueClass, FalseClass], default: true
  • #rcu_db_username ⇒ String
    Database sys username - usually 'sys'
    Property Attributes
    • required ⇒ true
    

39
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 39

property :rcu_db_username, type: String, required: true
  • #rcu_sysdba_password ⇒ Mint::Secret
    Database sysdba password
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    

41
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 41

property :rcu_sysdba_password, type: Mint::Secret, from: String, required: true
  • #rcu_schema_password ⇒ Mint::Secret
    Database password for created users
    Property Attributes
    • from ⇒ String
    • required ⇒ true
    

43
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 43

property :rcu_schema_password, type: Mint::Secret, from: String, required: true
  • #rcu_schema_prefix ⇒ String
    Schema prefix for created schemas
    Property Attributes
    • allowed_values ⇒ /[A-Za-z0-9]{1,12}/
    

45
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 45

property :rcu_schema_prefix, type: String, allowed_values: /[A-Za-z0-9]{1,12}/
  • #rcu_db_hostname ⇒ String
    Database hostname
    Property Attributes
    • required ⇒ true
    

48
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 48

property :rcu_db_hostname, type: String, required: true
  • #rcu_db_port ⇒ Integer
    Database port
    Property Attributes
    • required ⇒ true
    

50
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 50

property :rcu_db_port, type: Integer, required: true
  • #rcu_db_type ⇒ String (Default Value: 'ORACLE')
    Database type
    Property Attributes
    • default ⇒ 'ORACLE'
    

52
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 52

property :rcu_db_type, type: String, default: 'ORACLE'
  • #rcu_db_service_name ⇒ String
    Database Service Name
    Property Attributes
    • required ⇒ true
    

54
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 54

property :rcu_db_service_name, type: String, required: true
  • #rcu_db_jdbc_url ⇒ String (Default Value: '#{rcu_db_hostname}:#{rcu_db_port}/#{rcu_db_service_name}')
    The final JDBC url - this is normally formed from the other properties, but can be specified directly if so desired
    Property Attributes
    • default ⇒ '#{rcu_db_hostname}:#{rcu_db_port}/#{rcu_db_service_name}'
    

56
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 56

property :rcu_db_jdbc_url, type: String, default: '#{rcu_db_hostname}:#{rcu_db_port}/#{rcu_db_service_name}'
  • #rcu_select_dependents_for_components ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we automatically select dependencies?
    Property Attributes
    • default ⇒ false
    

59
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 59

property :rcu_select_dependents_for_components,type: [TrueClass, FalseClass], default: false
  • #rcu_extra_passwords ⇒ Array of ⇒ Mint::Secret
    Any extra passwords that we need to pass as a part of optional_args
    Property Attributes
    • from ⇒ String
    

63
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 63

property :rcu_extra_passwords, type: Mint::Secret, from: String, array: true
  • #optional_args ⇒ String (Default Value: '')
    Additional optional arguments to pass to the RCU binary
    Property Attributes
    • default ⇒ ''
    

66
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 66

property :optional_args, type: String, default: ''
  • #ignore_nonfatal_errors ⇒ [TrueClass, FalseClass] (Default Value: false)
    Should we ignore nonfatal errors?
    Property Attributes
    • default ⇒ false
    

69
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 69

property :ignore_nonfatal_errors, type: [TrueClass, FalseClass], default: false
  • #rcu_components_list ⇒ Array of ⇒ String
    List of components to create
    Property Attributes 
    

72
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 72

property :rcu_components_list, type: String, array: true
  • #host ⇒ MintPress::Infrastructure::Host
    The host on which to run the RCU binary
    Property Attributes 
    

74
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 74

property :host, type: MintPress::Infrastructure::Host
  • #encrypt_tablespaces ⇒ [TrueClass, FalseClass] (Default Value: false)
    Encypt tablespaces?
    Property Attributes
    • default ⇒ false
    

79
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 79

property :encrypt_tablespaces, type: [TrueClass, FalseClass], default: false
  • #datafile_initial_size ⇒ String
    Datafile initial size for RCU, if specified and created by us
    Property Attributes 
    

81
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 81

property :datafile_initial_size, type: String
  • #edition ⇒ String
    Edition for EBR databases
    Property Attributes 
    

83
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 83

property :edition, type: String
  • #db_role ⇒ [String, Symbol] (Default Value: :SYSDBA)
    Role for DB connect
    Property Attributes
    • default ⇒ :SYSDBA
    

85
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 85

property :db_role, type: [String, Symbol], default: :SYSDBA
  • #unicode_support ⇒ [TrueClass, FalseClass]
    Unicode support?
    Property Attributes 
    

87
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 87

property :unicode_support, type: [TrueClass, FalseClass]
  • #skip_cleanup_on_failure ⇒ [TrueClass, FalseClass]
    Skip Cleanup on failure?
    Property Attributes 
    

89
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 89

property :skip_cleanup_on_failure, type: [TrueClass, FalseClass]
  • #honor_omf ⇒ [TrueClass, FalseClass]
    Honor Oracle Managed File configuration?
    Property Attributes 
    

91
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 91

property :honor_omf, type: [TrueClass, FalseClass]
  • #skip_tablespace_drop ⇒ [TrueClass, FalseClass]
    Skip tablespace drop when cleaning up?
    Property Attributes 
    

93
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 93

property :skip_tablespace_drop, type: [TrueClass, FalseClass]
  • #variables ⇒ Hash of ⇒ String
    RCU variables
    Property Attributes 
    

95
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 95

property :variables, type: String, hash: true
  • #tablespace ⇒ String
    tablespace to use for the data
    Property Attributes 
    

97
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 97

property :tablespace, type: String
  • #temp_tablespace ⇒ String
    Temp tablepsace to use for the data
    Property Attributes 
    

99
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 99

property :temp_tablespace, type: String
  • #script_location ⇒ String
    Should we generate a script instead of actually doing the RCU? If so, specify it with this property
    Property Attributes 
    

101
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 101

property :script_location, type: String
  • #post_sql ⇒ String (Default Value: nil)
    'Specifies the SQL you want to run after RCU has been created.'
    Property Attributes
    • default ⇒ nil
    

104
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 104

property :post_sql, type: String, default: nil, description: 'Specifies the SQL you want to run after RCU has been created.'
  • #pre_sql ⇒ String (Default Value: nil)
    'Specifies the SQL you want to run before RCU has been created.'
    Property Attributes
    • default ⇒ nil
    

106
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 106

property :pre_sql, type: String, default: nil, description: 'Specifies the SQL you want to run before RCU has been created.'
  • #tablespace_autocreate ⇒ [TrueClass, FalseClass] (Default Value: true)
    auto-create tablespace?
    Property Attributes
    • default ⇒ true
    

108
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 108

property :tablespace_autocreate, type: [TrueClass, FalseClass], default: true
  • #datafile_prefix ⇒ String
    Datafile prefix
    Property Attributes 
    

112
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 112

property :datafile_prefix, type: String
  • #datafile_autonaming ⇒ [TrueClass, FalseClass] (Default Value: true)
    Datafile autonaming?
    Property Attributes
    • default ⇒ true
    

114
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 114

property :datafile_autonaming, type: [TrueClass, FalseClass], default: true
  • #tablespace_autodestroy ⇒ [TrueClass, FalseClass] (Default Value: false)
    auto-destroy tablespace?
    Property Attributes
    • default ⇒ false
    

116
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 116

property :tablespace_autodestroy, type: [TrueClass, FalseClass], default: false
  • #tablespace_create_options ⇒ Array of ⇒ String
    Tablespace create options
    Property Attributes 
    

118
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 118

property :tablespace_create_options, type: String, array: true
  • #include_dbname_in_create ⇒ [TrueClass, FalseClass] (Default Value: false)
    Include the DB name in the tabelsapce name?
    Property Attributes
    • default ⇒ false
    

120
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 120

property :include_dbname_in_create, type: [TrueClass, FalseClass], default: false
  • #wait_for_db ⇒ [TrueClass, FalseClass] (Default Value: true)

    Property Attributes
    • default ⇒ true
    

122
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 122

property :wait_for_db, type: [TrueClass, FalseClass], default: true
  • #max_db_wait_time ⇒ Integer (Default Value: 60)
    max amount of time to wait for db startup in minutes
    Property Attributes
    • default ⇒ 60
    

124
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 124

property :max_db_wait_time, type: Integer, default: 60
  • #target_tmp_dir ⇒ String (Default Value: "/tmp/")
    Which folder to use for temporary files
    Property Attributes
    • default ⇒ "/tmp/"
    

127
    		 
    # File 'src/oracle-rcu/lib/oracle-rcu/client.rb', line 127

property :target_tmp_dir, type: String, default: "/tmp/"

Properties (Read Only)

Constant Summary

Constants included from MintLogger

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

Constants included from MintPress::OracleUtils

MintPress::OracleUtils::VERSION

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

Returns a new instance of Client.

Instance Method Details

#create_repository(java_home:, fmw_home:, version:) ⇒ Object

#drop_repository(java_home:, fmw_home:, version:) ⇒ Object

#rcu_exist? ⇒ Boolean

Returns:

  • (Boolean)

#run_adhoc_sql(sql_cmd) ⇒ Object