socketry / db

Event-driven database drivers for streaming queries.

High-level Ruby socket library with support for TCP, UDP, and SSL sockets.

Implements thread-safe timeouts using asynchronous I/O and high-precision monotonic timers.

Motivation

By default, Ruby sockets do not provide a built-in timeout mechanism. The only timeout mechanism provided by the language leverages timeout.rb, which uses unsafe multithreaded behaviors to implement timeouts.

While Socketry provides a synchronous, blocking API similar to Ruby's own TCPSocket and UDPSocket classes, behind the scenes it uses non-blocking I/O to implement thread-safe timeouts.

Installation

Add this line to your application's Gemfile:

gem "socketry"

And then execute:

$ bundle

Or install it yourself as:

$ gem install socketry

Basic Usage

Below is a basic example of how to use Socketry to make an HTTPS request:

require "socketry"

socket = Socketry::SSL::Socket.connect("github.com", 443)
socket.writepartial("GET / HTTP/1.0\r\nHost: github.com\r\n\r\n")
p socket.readpartial(1024)

TCP, SSL, and UDP servers and sockets also available.

Documentation

Please see the Socketry wiki for more detailed documentation and usage notes.

YARD API documentation is also available.

Supported Ruby Versions

This library aims to support and is tested against the following Ruby versions:

• Ruby 2.2.6+
• Ruby 2.3
• Ruby 2.4
• Ruby 2.5
• JRuby 9.1.6.0+

If something doesn't work on one of these versions, it's a bug.

This library may inadvertently work (or seem to work) on other Ruby versions, however support will only be provided for the versions listed above.

If you would like this library to support another Ruby version or implementation, you may volunteer to be a maintainer. Being a maintainer entails making sure all tests run and pass on that implementation. When something breaks on your implementation, you will be responsible for providing patches in a timely fashion. If critical issues for a particular implementation exist at the time of a major release, support for that Ruby version may be dropped.

Contributing

• Fork this repository on github
• Make your changes and send us a pull request
• If we like them we'll merge them
• If we've accepted a patch, feel free to ask for commit access

License

Copyright (c) 2016 Tony Arcieri. Distributed under the MIT License. See LICENSE.txt for further details.

db's Issues

Expose some basic interface for escaping parameters into a query.

While there is a consistent interface for escaping literals at the connection level, this is non-trivial for users to access.

There is no nice way to escape fields efficiently, and string substitution seems like a poor approach.

result = session.call("SELECT * FROM users WHERE name = ?", user_name)

This is the most basic interface I can think of. However it has some issues - we need to do string substitutions which is not cheap.

result = session.call("SELECT * FROM users WHERE name = #{session[user_name]}")

This uses string interpolation which is better, but still not perfect given that it generates temporary strings.

Here is a quick hack to generate an object and use ruby concatenation to generate queries.

class Query
	def self.>>(text)
		self.new(text)
	end
	
	def initialize(buffer = String.new)
		@buffer = +buffer
	end
	
	def << literal
		@buffer << literal.dump
		
		return self
	end
	
	def >> text
		@buffer << text
		
		return self
	end
	
	def to_str
		@buffer
	end
end

name = "ioquatix"

query = Query >> "SELECT * FROM users WHERE name = " <<name>> " AND active = TRUE"

puts query.to_str
# => SELECT * FROM users WHERE name = "ioquatix" AND active = TRUE

Maybe something like this would be both efficient and relatively easy to read, without imposing the semantic burden of a DSL.

rails adapter

Hi, you may have noticed I'm assembling a whole async rails stack for a high performance open source fun project. Do you have a working rails adapter for this? Do you see any problems to write one? I'd give it a try.

THX

Expose database capabilities similar to how ActiveRecord works.

After a discussion with @tenderlove, it looks like we could abstract https://github.com/rails/rails/blob/98d65ed19c7d3c4a0187616984deb4c3f1b9d270/activerecord/lib/active_record/connection_adapters/abstract_adapter.rb#L257-L462 into a Capabilities class, which would be implemented as an attribute of an active connection and used for lowering AST and other statements into valid SQL.