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.



134
135
136
137
138
139
 
# File 'lib/db/postgres/native/connection.rb', line 134

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

Class Method Details

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



99
100
101
102
103
104
105
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
 
# File 'lib/db/postgres/native/connection.rb', line 99

def self.connect(io: IO, types: DEFAULT_TYPES, **options)
	# Prefer 'database' key for 'dbname' parameter:
	if database = options.delete(:database)
		options[:dbname] = database
	end
	
	keys = Native.array_of_strings(options.keys)
	values = Native.array_of_strings(options.values)
	
	pointer = Native.connect_start_params(keys, values, 0)
	
	io = io.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 "connect: #{error_message}"
	end
	
	Native.set_nonblocking(pointer, 1)
	
	return self.new(pointer, io, types)
end

Instance Method Details

#close ⇒ Object

Close the connection.



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

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

#discard_results ⇒ Object

Silently discard any results that application didn’t read.



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/db/postgres/native/connection.rb', line 204

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.



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

def error_message
	Native.error_message(self)
end

#escape_identifier(value) ⇒ Object 



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

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 



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/db/postgres/native/connection.rb', line 163

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 



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

def next_result(types: @types)
	if result = self.get_result
		return Result.new(self, types, result)
	end
end

#send_query(statement) ⇒ Object 



191
192
193
194
195
 
# File 'lib/db/postgres/native/connection.rb', line 191

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

#single_row_mode! ⇒ Object 



187
188
189
 
# File 'lib/db/postgres/native/connection.rb', line 187

def single_row_mode!
	Native.set_single_row_mode(self)
end

#socket ⇒ Object

Return the underlying socket used for IO.



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

def socket
	Native.socket(self)
end

#status ⇒ Object

Return the status of the connection.



142
143
144
 
# File 'lib/db/postgres/native/connection.rb', line 142

def status
	Native.status(self)
end