Class: MintPress::OracleDatabase::Datafile

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

Overview

An Oracle database object that represents an Oracle Datafile for an Oracle Database Database This class provides a set of methods to manage an Oracle Database in an Oracle Database. The attributes of this class closely resemble the DBA_DATA_FILES data dictionary view

Properties (Read/Write)

  • #file_name ⇒ String
    What is the filename for this datafile?
    Property Attributes
    • required ⇒ true
    • alias ⇒ :name
    

20
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 20

property :file_name, required: true, type: String, alias: :name
  • #file_id ⇒ Integer
    What is the internal ID of this datafile?
    Property Attributes
    • from ⇒ BigDecimal
    

22
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 22

property :file_id, type: Integer, from: BigDecimal
  • #tablespace_name ⇒ String (Default Value: Proc.new { r = nil if ! self.get_property(:parent, disable_proc: true).nil? and self.get_property(:parent, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace) r = "#{self.get_property(:parent, disable_proc: true).tablespace_name}" elsif ! self.get_property(:tablespace, disable_proc: true).nil? and self.get_property(:tablespace, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace) r = "#{self.get_property(:tablespace, disable_proc: true).tablespace_name}" end r })
    To which tablespace does this datafile belong?
    Property Attributes
    • required ⇒ true
    • default ⇒ Proc.new { r = nil if ! self.get_property(:parent, disable_proc: true).nil? and self.get_property(:parent, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace) r = "#{self.get_property(:parent, disable_proc: true).tablespace_name}" elsif ! self.get_property(:tablespace, disable_proc: true).nil? and self.get_property(:tablespace, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace) r = "#{self.get_property(:tablespace, disable_proc: true).tablespace_name}" end r }
    

24
25
26
27
28
29
30
31
32
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 24

property :tablespace_name, required: true, type: String, default: Proc.new { 
  r = nil
  if ! self.get_property(:parent, disable_proc: true).nil? and self.get_property(:parent, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace)
    r = "#{self.get_property(:parent, disable_proc: true).tablespace_name}"
  elsif ! self.get_property(:tablespace, disable_proc: true).nil? and self.get_property(:tablespace, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace)
    r = "#{self.get_property(:tablespace, disable_proc: true).tablespace_name}"
  end
  r
}
  • #size ⇒ String
    How large is this datafile? used for creation rather than harvest
    Property Attributes
    • from ⇒ Integer
    

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

property :size, type: String, from: Integer
  • #bytes ⇒ Integer
    How large is this datafile, in bytes?
    Property Attributes
    • from ⇒ BigDecimal
    

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

property :bytes, type: Integer, from: BigDecimal
  • #blocks ⇒ Integer
    How large is this datafile, in blocks?
    Property Attributes
    • from ⇒ BigDecimal
    

39
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 39

property :blocks, type: Integer, from: BigDecimal
  • #status ⇒ String
    Is the datafile available?
    Property Attributes
    • allowed_values ⇒ %w{AVAILABLE INVALID}
    

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

property :status, type: String, allowed_values: %w{AVAILABLE INVALID}
  • #relative_fno ⇒ Integer

    Property Attributes
    • from ⇒ BigDecimal
    

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

property :relative_fno, type: Integer, from: BigDecimal
  • #autoextensible ⇒ [ TrueClass, FalseClass ] (Default Value: false)
    Is this datafile set up for autoextend?
    Property Attributes
    • default ⇒ false
    • from ⇒ Proc.new { |v| v.to_s.downcase == 'yes' ? true : false }
    

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

property :autoextensible, type: [ TrueClass, FalseClass ], default: false, from: Proc.new { |v| v.to_s.downcase == 'yes' ? true : false }
  • #maxbytes ⇒ Integer
    What is the maximum size of this datafile in bytes?
    Property Attributes
    • from ⇒ BigDecimal
    

47
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 47

property :maxbytes, type: Integer, from: BigDecimal
  • #maxblocks ⇒ Integer
    What is the maximum size of this datafile, in blocks?
    Property Attributes
    • from ⇒ BigDecimal
    

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

property :maxblocks, type: Integer, from: BigDecimal
  • #increment_by ⇒ Integer
    How many bytes should the datafile increment by when growing?
    Property Attributes
    • from ⇒ BigDecimal
    

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

property :increment_by, type: Integer, from: BigDecimal
  • #user_bytes ⇒ Integer
    How many bytes are currently in use?
    Property Attributes
    • from ⇒ BigDecimal
    

53
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 53

property :user_bytes, type: Integer, from: BigDecimal
  • #user_blocks ⇒ Integer
    How many blocks are currently in use?
    Property Attributes
    • from ⇒ BigDecimal
    

55
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 55

property :user_blocks, type: Integer, from: BigDecimal
  • #online_status ⇒ String
    What is the status of this datafile?
    Property Attributes
    • allowed_values ⇒ %w{SYSOFF SYSTEM OFFLINE ONLINE RECOVER}
    

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

property :online_status, type: String, allowed_values: %w{SYSOFF SYSTEM OFFLINE ONLINE RECOVER}
  • #lost_write_protect ⇒ String
    Is this datafile write protected?
    Property Attributes 
    

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

property :lost_write_protect, type: String
  • #parent ⇒ MintPress::OracleDatabase::Tablespace

    Property Attributes
    • prop_name ⇒ :datafiles
    

62
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 62

property :parent, type: MintPress::OracleDatabase::Tablespace, prop_name: :datafiles
  • #tablespace ⇒ MintPress::OracleDatabase::Tablespace

    Property Attributes
    • prop_name ⇒ :datafiles
    

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

property :tablespace, type: MintPress::OracleDatabase::Tablespace, prop_name: :datafiles
  • #database ⇒ MintPress::OracleDatabase::Database (Default Value: Proc.new { r = nil if self.get_property(:parent, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace) if self.get_property(:parent, disable_proc: true).database.is_a?(MintPress::OracleDatabase::Database) r = self.get_property(:parent, disable_proc: true).database end end r })

    Property Attributes
    • default ⇒ Proc.new { r = nil if self.get_property(:parent, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace) if self.get_property(:parent, disable_proc: true).database.is_a?(MintPress::OracleDatabase::Database) r = self.get_property(:parent, disable_proc: true).database end end r }
    

64
65
66
67
68
69
70
71
72
    		 
    # File 'src/oracle-database/lib/oracle-database/model/database/datafile.rb', line 64

property :database, type: MintPress::OracleDatabase::Database, default: Proc.new { 
  r = nil
  if self.get_property(:parent, disable_proc: true).is_a?(MintPress::OracleDatabase::Tablespace)
    if self.get_property(:parent, disable_proc: true).database.is_a?(MintPress::OracleDatabase::Database)
      r = self.get_property(:parent, disable_proc: true).database
    end
  end
  r
}

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

Returns a new instance of Datafile.

Instance Method Details

#create ⇒ void

This method returns an undefined value.

Create/Add a datafile to a database METHOD NOT YET IMPLEMENTED

#drop ⇒ void

This method returns an undefined value.

Drop/Remove a datafile from a database METHOD NOT YET IMPLEMENTED

#exist? ⇒ Boolean

Returns:

  • (Boolean)

#exists? ⇒ Boolean

Returns:

  • (Boolean)

#extend ⇒ void

This method returns an undefined value.

Extend a datafile in a database METHOD NOT YET IMPLEMENTED

#freespace ⇒ void

This method returns an undefined value.

Determine the amount of available freespace in a datafile METHOD NOT YET IMPLEMENTED

#harvest ⇒ MintPress::OracleDatabase::Datafile

Harvest details of a datafile from a database METHOD NOT YET IMPLEMENTED

Returns:

#to_hash ⇒ Hash

Return a Hash representation for the class and all its sub-classes.

Returns:

  • (Hash) —
    the object in Hash format

#usage ⇒ String

Example usage of the class

Returns: