Class: OCI::DatabaseManagement::Models::MySqlQueryDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_management/models/my_sql_query_details.rb

Overview

The details of a given MySQL query, which consists of the query sample details, the explain plan, and potential warnings. MySQL support within OCI Database Management service has been deprecated as of January 29, 2026.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MySqlQueryDetails

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 53

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.query_sample_details = attributes[:'querySampleDetails'] if attributes[:'querySampleDetails']

  raise 'You cannot provide both :querySampleDetails and :query_sample_details' if attributes.key?(:'querySampleDetails') && attributes.key?(:'query_sample_details')

  self.query_sample_details = attributes[:'query_sample_details'] if attributes[:'query_sample_details']

  self.query_explain_plan = attributes[:'queryExplainPlan'] if attributes[:'queryExplainPlan']

  raise 'You cannot provide both :queryExplainPlan and :query_explain_plan' if attributes.key?(:'queryExplainPlan') && attributes.key?(:'query_explain_plan')

  self.query_explain_plan = attributes[:'query_explain_plan'] if attributes[:'query_explain_plan']

  self.query_messages = attributes[:'queryMessages'] if attributes[:'queryMessages']

  raise 'You cannot provide both :queryMessages and :query_messages' if attributes.key?(:'queryMessages') && attributes.key?(:'query_messages')

  self.query_messages = attributes[:'query_messages'] if attributes[:'query_messages']
end

Instance Attribute Details

#query_explain_plan ⇒ OCI::DatabaseManagement::Models::MySqlQueryExplainPlan

Returns:



16
17
18
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 16

def query_explain_plan
  @query_explain_plan
end

#query_messages ⇒ Array<OCI::DatabaseManagement::Models::MySqlQueryMessage>

The errors, warnings, and notes that could be raised by the execution of the query.

Returns:



20
21
22
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 20

def query_messages
  @query_messages
end

#query_sample_details ⇒ OCI::DatabaseManagement::Models::MySqlQuerySampleDetails

This attribute is required.

Returns:



13
14
15
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 13

def query_sample_details
  @query_sample_details
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



23
24
25
26
27
28
29
30
31
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 23

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'query_sample_details': :'querySampleDetails',
    'query_explain_plan': :'queryExplainPlan',
    'query_messages': :'queryMessages'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 34

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'query_sample_details': :'OCI::DatabaseManagement::Models::MySqlQuerySampleDetails',
    'query_explain_plan': :'OCI::DatabaseManagement::Models::MySqlQueryExplainPlan',
    'query_messages': :'Array<OCI::DatabaseManagement::Models::MySqlQueryMessage>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



85
86
87
88
89
90
91
92
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 85

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    query_sample_details == other.query_sample_details &&
    query_explain_plan == other.query_explain_plan &&
    query_messages == other.query_messages
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 117

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


97
98
99
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 97

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



106
107
108
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 106

def hash
  [query_sample_details, query_explain_plan, query_messages].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 150

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



144
145
146
 
# File 'lib/oci/database_management/models/my_sql_query_details.rb', line 144

def to_s
  to_hash.to_s
end