Class: MintPress::OracleDatabase::Service

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

Overview

An Oracle service object that represents an Oracle Database Service This class provides a set of methods to manage an Oracle Database Service

Since:

  • 0.1.0

Properties (Read/Write)

  • #service_name ⇒ String
    The the internal name of the service in the data dictionary
    Property Attributes
    • required ⇒ true
    • alias ⇒ :name
    

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

property :service_name, required: true, type: String, alias: :name
  • #network_name ⇒ String (Default Value: Proc.new { self.name })
    The name of the service presented by the listener
    Property Attributes
    • required ⇒ true
    • default ⇒ Proc.new { self.name }
    

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

property :network_name, required: true, type: String, default: Proc.new { self.name }
  • #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 }
    

30
31
32
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/service.rb', line 30

property :host, type: MintPress::Infrastructure::Host, required: true, default: Proc.new {
    MintPress::Infrastructure::LocalHost.new
}
  • #db_host ⇒ String (Default Value: Proc.new { self.host.name })
    'Database connection host'
    Property Attributes
    • default ⇒ Proc.new { self.host.name }
    

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

property :db_host, type: String, description: 'Database connection host', default: Proc.new { self.host.name }
  • #db_port ⇒ Integer (Default Value: 1521)
    Database connect port - this defaults to 1521.
    Property Attributes
    • required ⇒ true
    • default ⇒ 1521
    

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

property :db_port, type: Integer, required: true, default: 1521
  • #db_service_name ⇒ String
    The service name this database is accessable as
    Property Attributes 
    

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

property :db_service_name, type: String
  • #db_username (Default Value: 'sys')
    Username with sys privilege. Defaults to 'sys'
    Property Attributes
    • default ⇒ 'sys'
    • required ⇒ true
    • alias ⇒ :dba_username
    

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

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

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

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

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

property :db_role, type: String
  • #db_connect_descriptor ⇒ String (Default Value: Proc.new { "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=#{self.get_property(:db_host)})(PORT=#{self.get_property(:db_port)})))(CONNECT_DATA=(SERVICE_NAME=#{self.get_property(:db_service_name)})))" })
    'Database connect descriptor that will override with advanced DB connect string such as failover and other advanced settings'
    Property Attributes
    • default ⇒ Proc.new { "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=#{self.get_property(:db_host)})(PORT=#{self.get_property(:db_port)})))(CONNECT_DATA=(SERVICE_NAME=#{self.get_property(:db_service_name)})))" }
    

51
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/service.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', default: Proc.new { "(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=#{self.get_property(:db_host)})(PORT=#{self.get_property(:db_port)})))(CONNECT_DATA=(SERVICE_NAME=#{self.get_property(:db_service_name)})))" }

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

Returns a new instance of Service.

Since:

  • 0.1.0

Instance Method Details

#create ⇒ void

This method returns an undefined value.

Create the service

Since:

  • 0.1.0

#delete ⇒ void

This method returns an undefined value.

Delete the service

Since:

  • 0.1.0

#exists? ⇒ TrueClass | FalseClass

Does the service already exist

Returns:

  • (TrueClass | FalseClass)

Since:

  • 0.1.0

#restart ⇒ void

This method returns an undefined value.

Restart the Service

Since:

  • 0.1.0

#running? ⇒ TrueClass | FalseClass

Is the service up and running?

Returns:

  • (TrueClass | FalseClass)

Since:

  • 0.1.0

#start ⇒ void

This method returns an undefined value.

Start the service and wait for services to be up before returning

Since:

  • 0.1.0

#stop ⇒ void

This method returns an undefined value.

Stop the service and wait for services to be down before returning

Since:

  • 0.1.0

#usage ⇒ String

Example usage of the class

Returns:

Since:

  • 0.1.0

#wait_until_services_available ⇒ void

This method returns an undefined value.

Wait for the services to come up

Since:

  • 0.1.0

#wait_until_services_down ⇒ void

This method returns an undefined value.

Wait for the services to come down

Since:

  • 0.1.0