Class: DB::Postgres::Native::Connection

Inherits:
FFI::Pointer
  • Object
show all
Defined in:
lib/db/postgres/native/connection.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, io, types) ⇒ Connection

Returns a new instance of Connection.



145
146
147
148
149
150
 
# File 'lib/db/postgres/native/connection.rb', line 145

def initialize(address, io, types)
  super(address)
  
  @io = io
  @types = types
end

Class Method Details

.connect(wrapper: IO, types: DEFAULT_TYPES, **options) ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/db/postgres/native/connection.rb', line 106

def self.connect(wrapper: IO, types: DEFAULT_TYPES, **options)
  # Postgres expects "dbname" as the key name:
  if database = options.delete(:database)
    options[:dbname] = database
  end
  
  # Postgres expects "user" as the key name:
  if username = options.delete(:username)
    options[:user] = username
  end
  
  keys = Strings.new(options.keys)
  values = Strings.new(options.values)
  
  pointer = Native.connect_start_params(keys.array, values.array, 0)
  Native.set_nonblocking(pointer, 1)
  
  io = wrapper.new(Native.socket(pointer), "r+")
  
  while status = Native.connect_poll(pointer)
    break if status == :ok || status == :failed
    
    # one of :wait_readable or :wait_writable
    io.send(status)
  end
  
  if status == :failed
    io.close
    
    error_message = Native.error_message(pointer)
    
    Native.finish(pointer)
    
    raise Error, "Could not connect: #{error_message}"
  end
  
  return self.new(pointer, io, types)
end

Instance Method Details

#close ⇒ Object

Close the connection.



168
169
170
171
172
 
# File 'lib/db/postgres/native/connection.rb', line 168

def close
  Native.finish(self)
  
  @io.close
end

#discard_results ⇒ Object

Silently discard any results that application didn’t read.



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/db/postgres/native/connection.rb', line 225

def discard_results
  while result = self.get_result
    status = Native.result_status(result)
    Native.clear(result)
    
    case status
    when :copy_in
      self.put_copy_end("Discard results")
    when :copy_out
      self.flush_copy_out
    end
  end
  
  return nil
end

#error_message ⇒ Object

Return the last error message.



158
159
160
 
# File 'lib/db/postgres/native/connection.rb', line 158

def error_message
  Native.error_message(self)
end

#escape_identifier(value) ⇒ Object 



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/db/postgres/native/connection.rb', line 186

def escape_identifier(value)
  value = value.to_s
  
  result = Native.escape_identifier(self, value, value.bytesize)
  
  string = result.read_string
  
  Native.free_memory(result)
  
  return string
end

#escape_literal(value) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/db/postgres/native/connection.rb', line 174

def escape_literal(value)
  value = value.to_s
  
  result = Native.escape_literal(self, value, value.bytesize)
  
  string = result.read_string
  
  Native.free_memory(result)
  
  return string
end

#next_result(types: @types) ⇒ Object 



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/db/postgres/native/connection.rb', line 208

def next_result(types: @types)
  if result = self.get_result
    status = Native.result_status(result)
    
    if status == :fatal_error
      message = Native.result_error_message(result)
      
      Native.clear(result)
      
      raise Error, "Could not get next result: #{message}"
    end
    
    return Result.new(self, types, result)
  end
end

#send_query(statement) ⇒ Object 



202
203
204
205
206
 
# File 'lib/db/postgres/native/connection.rb', line 202

def send_query(statement)
  check! Native.send_query(self, statement)
  
  flush
end

#single_row_mode! ⇒ Object 



198
199
200
 
# File 'lib/db/postgres/native/connection.rb', line 198

def single_row_mode!
  Native.set_single_row_mode(self)
end

#socket ⇒ Object

Return the underlying socket used for IO.



163
164
165
 
# File 'lib/db/postgres/native/connection.rb', line 163

def socket
  Native.socket(self)
end

#status ⇒ Object

Return the status of the connection.



153
154
155
 
# File 'lib/db/postgres/native/connection.rb', line 153

def status
  Native.status(self)
end