Class: Comet::MSSQLConnection

Inherits:
Object
  • Object
show all
Defined in:
lib/comet/models/mssqlconnection.rb

Overview

MSSQLConnection is a typed class wrapper around the underlying Comet Server API data structure.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ MSSQLConnection

Returns a new instance of MSSQLConnection.



39
40
41
 
# File 'lib/comet/models/mssqlconnection.rb', line 39

def initialize
  clear
end

Instance Attribute Details

#hostname ⇒ Object

Deprecated.

This member has been deprecated since Comet version Unused



27
28
29
 
# File 'lib/comet/models/mssqlconnection.rb', line 27

def hostname
  @hostname
end

#instance_name ⇒ Object

Returns the value of attribute instance_name.



30
31
32
 
# File 'lib/comet/models/mssqlconnection.rb', line 30

def instance_name
  @instance_name
end

#method ⇒ Object

One of the MSSQL_METHOD_ constants, to control using x86_32 or x86_64 OLEDB drivers



34
35
36
 
# File 'lib/comet/models/mssqlconnection.rb', line 34

def method
  @method
end

#password ⇒ Object

Returns the value of attribute password.



23
24
25
 
# File 'lib/comet/models/mssqlconnection.rb', line 23

def password
  @password
end

#type ⇒ Object

One of the MSSQL_AUTH_ constants (e.g. “windows” or “native”)



17
18
19
 
# File 'lib/comet/models/mssqlconnection.rb', line 17

def type
  @type
end

#unknown_json_fields ⇒ Object

Returns the value of attribute unknown_json_fields.



37
38
39
 
# File 'lib/comet/models/mssqlconnection.rb', line 37

def unknown_json_fields
  @unknown_json_fields
end

#username ⇒ Object

Returns the value of attribute username.



20
21
22
 
# File 'lib/comet/models/mssqlconnection.rb', line 20

def username
  @username
end

Instance Method Details

#clear ⇒ Object 



43
44
45
46
47
48
49
50
51
 
# File 'lib/comet/models/mssqlconnection.rb', line 43

def clear
  @type = ''
  @username = ''
  @password = ''
  @hostname = ''
  @instance_name = ''
  @method = ''
  @unknown_json_fields = {}
end

#from_hash(obj) ⇒ Object

Parameters:

  • obj (Hash) —

    The complete object as a Ruby hash

Raises:

  • (TypeError) 


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/comet/models/mssqlconnection.rb', line 61

def from_hash(obj)
  raise TypeError, "'obj' expected Hash, got #{obj.class}" unless obj.is_a? Hash

  obj.each do |k, v|
    case k
    when 'Type'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @type = v
    when 'Username'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @username = v
    when 'Password'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @password = v
    when 'Hostname'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @hostname = v
    when 'InstanceName'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @instance_name = v
    when 'Method'
      raise TypeError, "'v' expected String, got #{v.class}" unless v.is_a? String

      @method = v
    else
      @unknown_json_fields[k] = v
    end
  end
end

#from_json(json_string) ⇒ Object

Parameters:

  • json_string (String) —

    The complete object in JSON format

Raises:

  • (TypeError) 


54
55
56
57
58
 
# File 'lib/comet/models/mssqlconnection.rb', line 54

def from_json(json_string)
  raise TypeError, "'json_string' expected String, got #{json_string.class}" unless json_string.is_a? String

  from_hash(JSON.parse(json_string))
end

#to_h ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



112
113
114
 
# File 'lib/comet/models/mssqlconnection.rb', line 112

def to_h
  to_hash
end

#to_hash ⇒ Hash

Returns The complete object as a Ruby hash.

Returns:

  • (Hash) —

    The complete object as a Ruby hash



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/comet/models/mssqlconnection.rb', line 97

def to_hash
  ret = {}
  ret['Type'] = @type
  ret['Username'] = @username
  ret['Password'] = @password
  ret['Hostname'] = @hostname
  ret['InstanceName'] = @instance_name
  ret['Method'] = @method
  @unknown_json_fields.each do |k, v|
    ret[k] = v
  end
  ret
end

#to_json(options = {}) ⇒ String

Returns The complete object as a JSON string.

Returns:

  • (String) —

    The complete object as a JSON string



117
118
119
 
# File 'lib/comet/models/mssqlconnection.rb', line 117

def to_json(options = {})
  to_hash.to_json(options)
end