require 'socket' class Vertica::Connection attr_reader :notices, :transaction_status, :backend_pid, :backend_key, :parameters, :notice_handler, :session_id attr_accessor :row_style, :debug, :options def self.cancel(existing_conn) existing_conn.cancel end # Opens a connectio the a Vertica server # @param [Hash] options The connection options to use. def initialize(options = {}) reset_values @options = {} options.each { |key, value| @options[key.to_s.to_sym] = value if value} @options[:port] ||= 5433 @options[:read_timeout] ||= 600 @row_style = @options[:row_style] ? @options[:row_style] : :hash boot_connection unless options[:skip_startup] end def on_notice(&block) @notice_handler = block end def socket @socket ||= begin raw_socket = TCPSocket.new(@options[:host], @options[:port].to_i) if @options[:ssl] require 'openssl' raw_socket.write Vertica::Messages::SslRequest.new.to_bytes if raw_socket.read(1) == 'S' raw_socket = OpenSSL::SSL::SSLSocket.new(raw_socket, OpenSSL::SSL::SSLContext.new) raw_socket.sync = true raw_socket.connect else raise Vertica::Error::SSLNotSupported.new("SSL requested but server doesn't support it.") end end raw_socket end end def ssl? Object.const_defined?('OpenSSL') && socket.kind_of?(OpenSSL::SSL::SSLSocket) end def opened? @socket && @backend_pid && @transaction_status end def closed? !opened? end def busy? !ready_for_query? end def ready_for_query? @current_job.nil? end def write(message) raise ArgumentError, "invalid message: (#{message.inspect})" unless message.respond_to?(:to_bytes) puts "=> #{message.inspect}" if @debug socket.write message.to_bytes rescue SystemCallError => e close_socket raise Vertica::Error::ConnectionError.new(e.message) end def close write Vertica::Messages::Terminate.new ensure close_socket end def close_socket socket.close @socket = nil rescue SystemCallError ensure reset_values end def reset_connection close boot_connection end def boot_connection startup_connection initialize_connection end def cancel conn = self.class.new(options.merge(:skip_startup => true)) conn.write Vertica::Messages::CancelRequest.new(backend_pid, backend_key) conn.write Vertica::Messages::Flush.new conn.socket.close end def interrupt raise Vertica::Error::InterruptImpossible, "Session cannopt be interrupted because the session ID is not known!" if session_id.nil? conn = self.class.new(options.merge(:interruptable => false, :role => nil, :search_path => nil)) response = conn.query("SELECT CLOSE_SESSION(#{Vertica.quote(session_id)})").the_value conn.close return response end def interruptable? !session_id.nil? end def read_message ready = IO.select([socket], nil, nil, @options[:read_timeout]) if ready type = read_bytes(1) size = read_bytes(4).unpack('N').first raise Vertica::Error::MessageError.new("Bad message size: #{size}.") unless size >= 4 message = Vertica::Messages::BackendMessage.factory type, read_bytes(size - 4) puts "<= #{message.inspect}" if @debug return message else close raise Vertica::Error::TimedOutError.new("Connection timed out.") end rescue SystemCallError => e close_socket raise Vertica::Error::ConnectionError.new(e.message) end def process_message(message) case message when Vertica::Messages::ErrorResponse raise Vertica::Error::ConnectionError.new(message.error_message) when Vertica::Messages::NoticeResponse @notice_handler.call(message) if @notice_handler when Vertica::Messages::BackendKeyData @backend_pid = message.pid @backend_key = message.key when Vertica::Messages::ParameterStatus @parameters[message.name] = message.value when Vertica::Messages::ReadyForQuery @transaction_status = message.transaction_status @current_job = nil else raise Vertica::Error::MessageError, "Unhandled message: #{message.inspect}" end end def query(sql, options = {}, &block) job = Vertica::Query.new(self, sql, { :row_style => @row_style }.merge(options)) job.row_handler = block if block_given? run_with_job_lock(job) end def copy(sql, source = nil, &block) job = Vertica::Query.new(self, sql, :row_style => @row_style) if block_given? job.copy_handler = block elsif source && File.exists?(source.to_s) job.copy_handler = lambda { |data| file_copy_handler(source, data) } elsif source.respond_to?(:read) && source.respond_to?(:eof?) job.copy_handler = lambda { |data| io_copy_handler(source, data) } end run_with_job_lock(job) end def inspect safe_options = @options.reject{ |name, _| name == :password } "#" end protected def run_with_job_lock(job) boot_connection if closed? raise Vertica::Error::SynchronizeError.new(@current_job, job) if busy? @current_job = job job.run end COPY_FROM_IO_BLOCK_SIZE = 1024 * 4096 def file_copy_handler(input_file, output) File.open(input_file, 'r') do |input| while data = input.read(COPY_FROM_IO_BLOCK_SIZE) output << data end end end def io_copy_handler(input, output) until input.eof? output << input.read(COPY_FROM_IO_BLOCK_SIZE) end end def read_bytes(n) bytes = socket.read(n) raise Errno::EIO if bytes.nil? || bytes.size != n return bytes end def startup_connection write Vertica::Messages::Startup.new(@options[:user] || @options[:username], @options[:database]) message = nil begin case message = read_message when Vertica::Messages::Authentication if message.code != Vertica::Messages::Authentication::OK write Vertica::Messages::Password.new(@options[:password], message.code, {:user => @options[:user], :salt => message.salt}) end else process_message(message) end end until message.kind_of?(Vertica::Messages::ReadyForQuery) end def initialize_connection query("SET SEARCH_PATH TO #{options[:search_path]}") if options[:search_path] query("SET ROLE #{options[:role]}") if options[:role] @session_id = query("SELECT session_id FROM v_monitor.current_session").the_value if options[:interruptable] end def reset_values @parameters = {} @session_id = nil @backend_pid = nil @backend_key = nil @transaction_status = nil @socket = nil @current_job = '' end end require 'vertica/query' require 'vertica/column' require 'vertica/result' require 'vertica/messages/message'