swift 0.6.1 → 0.7.0

data/API.rdoc

@@ -38,6 +38,7 @@ Public API minus the optional stuff like Pool, IdentityMap, Migrations etc.
     Result
       .new       #=> Result
       #insert_id #=> Numeric
+      #fields    #=> [Symbol, ...] # Field names identical to .first.keys if rows > 0
 
     Statement < Result
       .new     #=> Statement

data/README.rdoc

@@ -9,10 +9,16 @@ A rational rudimentary object relational mapper.
 == Dependencies
 
 * ruby   >= 1.9.1
-* dbic++ >= 0.1.6
-* mysql  >= 5.0.17 or postgresql >= 8.4
+* dbic++ >= 0.4.0 (http://github.com/deepfryed/dbicpp)
+* mysql  >= 5.0.17 or postgresql >= 8.4 or db2 >= 9.7.2
 
-dbic++ can be found here http://github.com/deepfryed/dbicpp
+== Caveats
+
+=== DB2
+* The server needs to be running under DB2_COMPATIBILITY_VECTOR=77FF if you want to use the ORM
+  features of swift.
+* DB2 asynchronous operations are highly experimental at this point due to inherent limitations of the
+  underlying api. It is more an academic exercise and is not ready for real-world use.
 
 == Features
 
@@ -71,7 +77,7 @@ primitive Ruby type conversion.
     attribute :id,         Swift::Type::Integer, serial: true, key: true
     attribute :name,       Swift::Type::String
     attribute :email,      Swift::Type::String
-    attribute :updated_at, Swift::Type::DateTime
+    attribute :updated_at, Swift::Type::Time
   end # User
 
   Swift.db do |db|
@@ -169,7 +175,7 @@ Swift comes with a simple identity map. Just require it after you load swift.
 
 === Bulk inserts
 
-Swift comes with adapter level support for bulk inserts for MySQL and PostgreSQL. This
+Swift comes with adapter level support for bulk inserts for MySQL, PostgreSQL and DB2. This
 is usually very fast (~5-10x faster) than regular prepared insert statements for larger
 sets of data.
 
@@ -191,8 +197,8 @@ But you can do it almost as fast in ruby,
     end
   end
 
-You are not just limited to files - you can stream data from anywhere into MySQL and
-PostgreSQL directly without creating temporary files.
+You are not just limited to files - you can stream data from anywhere into your database without
+creating temporary files.
 
 == Performance
 
@@ -203,6 +209,8 @@ http://github.com/shanna/swift/tree/master/benchmarks
 
 === Benchmarks
 
+==== ORM
+
 The following bechmarks were run on a machine with 4G ram, 5200rpm sata drive,
 Intel Core2Duo P8700 2.53GHz and stock PostgreSQL 8.4.1.
 
@@ -214,26 +222,57 @@ Intel Core2Duo P8700 2.53GHz and stock PostgreSQL 8.4.1.
   objects allocated and the pressure on Ruby GC if it were running. When GC is enabled,
   the actual memory consumption might be much lower than the numbers below.
 
-    ./benchmarks/simple.rb -r 10000 -n 1
 
-    benchmark       sys         user        total       real        rss
-    dm #create      0.390000    3.950000    4.340000    5.771812    244.32m
-    dm #select      0.150000    1.760000    1.910000    2.035583    128.97m
-    dm #update      0.690000    7.880000    8.570000    11.295239   603.30m
+    ./simple.rb -n1 -r10000 -s ar -s dm -s sequel -s swift
+
+    benchmark       sys       user      total     real      rss
+    ar #create      0.800000  6.620000  7.420000  9.898821  369.44m
+    ar #select      0.020000  0.300000  0.320000  0.372809  38.83m
+    ar #update      0.770000  6.550000  7.320000  10.02434  361.92m
+
+    dm #create      0.110000  3.590000  3.700000  4.847609  248.74m
+    dm #select      0.120000  1.840000  1.960000  2.029552  128.98m
+    dm #update      0.400000  7.750000  8.150000  9.741249  599.52m
+
+    sequel #create  0.770000  3.910000  4.680000  7.432611  263.59m
+    sequel #select  0.020000  0.080000  0.100000  0.147321  9.82m
+    sequel #update  0.730000  3.910000  4.640000  7.594949  259.18m
+
+    swift #create   0.210000  0.850000  1.060000  2.618661  32.72m
+    swift #select   0.000000  0.080000  0.080000  0.132245  9.91m
+    swift #update   0.270000  0.650000  0.920000  2.204108  37.48m
+
+    -- bulk insert api --
+    swift #write    0.000000  0.080000  0.080000  0.151146  7.29m
 
-    ar #create      0.930000    6.620000    7.550000    10.002911   367.82m
-    ar #select      0.050000    0.310000    0.360000    0.417127     38.82m
-    ar #update      0.770000    6.180000    6.950000    9.711788    361.93m
 
-    swift #create   0.180000    0.820000    1.000000    1.968757     27.35m
-    swift #select   0.010000    0.070000    0.080000    0.130234      9.85m
-    swift #update   0.250000    0.610000    0.860000    1.996165     29.35m
-    swift #write    0.000000    0.100000    0.100000    0.167199      6.23m
+==== Adapter
+
+The adapter level SELECT benchmarks without using ORM.
+
+* Same dataset as above.
+* All rows are selected 5 times.
+* The pg benchmark uses pg_typecast gem to provide typecasting support
+  for pg gem and also makes the benchmarks more fair.
+
+===== PostgreSQL
+
+    benchmark       sys       user      total     real      rss
+    do #select      0.060000  1.070000  1.130000  1.370092  99.83m
+    pg #select      0.030000  0.270000  0.300000  0.584091  46.13m
+    swift #select   0.020000  0.290000  0.310000  0.571635  39.08m
+
+===== MySQL
+
+    benchmark       sys       user      total     real      rss
+    do #select      0.030000  1.070000  1.100000  1.200177  99.26m
+    mysql2 #select  0.060000  0.450000  0.510000  0.609236  76.44m
+    swift #select   0.050000  0.170000  0.220000  0.334932  33.61m
 
 == TODO
 
-* Tests.
-* Extension performance. Remove all repeated rb_intern() calls etc.
+* More tests.
+* Make db2 async api more stable.
 * Assertions for dumb stuff.
 * Abstract interface for other adapters? Move dbic++ to Swift::DBI::(Adapter, Pool, Result, Statment etc.)
 
@@ -241,4 +280,3 @@ Intel Core2Duo P8700 2.53GHz and stock PostgreSQL 8.4.1.
 
 Go nuts! There is no style guide and I do not care if you write tests or comment code. If you write something neat just
 send a pull request, tweet, email or yell it at me line by line in person.
-

data/VERSION

@@ -1 +1 @@
-0.6.1
+0.7.0

data/examples/scheme.rb

@@ -13,7 +13,7 @@ class User < Swift::Scheme
   attribute :name,     Swift::Type::String
   attribute :email,    Swift::Type::String
   attribute :active,   Swift::Type::Boolean
-  attribute :created,  Swift::Type::DateTime, default: proc { Time.now }
+  attribute :created,  Swift::Type::Time,     default: proc { Time.now }
   attribute :optional, Swift::Type::String,   default: 'woot'
 
   validations do |errors|

data/ext/adapter.cc

@@ -3,7 +3,10 @@
 static VALUE cSwiftAdapter;
 
 static void adapter_free(dbi::Handle *handle) {
-    if (handle) delete handle;
+    if (handle) {
+      handle->conn()->cleanup();
+      delete handle;
+    }
 }
 
 VALUE adapter_alloc(VALUE klass) {
@@ -83,15 +86,15 @@ static VALUE adapter_execute(int argc, VALUE *argv, VALUE self) {
     query.sql    = CSTRING(statement);
     query.handle = handle;
 
-    if (RARRAY_LEN(bind_values) > 0) query_bind_values(&query, bind_values);
+    if (RARRAY_LEN(bind_values) > 0) query_bind_values(&query, bind_values, handle->driver());
     if (dbi::_trace)                 dbi::logMessage(dbi::_trace_fd, dbi::formatParams(query.sql, query.bind));
 
     if ((rows = rb_thread_blocking_region(((VALUE (*)(void*))query_execute), &query, RUBY_UBF_IO, 0)) == Qfalse)
       rb_raise(eSwiftRuntimeError, "%s", query.error);
 
     if (rb_block_given_p()) {
-      dbi::AbstractResultSet *result = handle->results();
-      return result_each(Data_Wrap_Struct(cSwiftResult, 0, result_free, result));
+      dbi::AbstractResult *result = handle->results();
+      return result_each(result_wrap_handle(cSwiftResult, self, result, false));
     }
     else
       return rows;
@@ -121,7 +124,8 @@ static VALUE adapter_initialize(VALUE self, VALUE options) {
   }
   CATCH_DBI_EXCEPTIONS();
 
-  rb_iv_set(self, "@options", options);
+  rb_iv_set(self, "@timezone", rb_hash_aref(options, ID2SYM(rb_intern("timezone"))));
+  rb_iv_set(self, "@options",  options);
   return Qnil;
 }
 
@@ -139,7 +143,7 @@ static VALUE adapter_prepare(int argc, VALUE *argv, VALUE self) {
   try {
     // TODO: Move to statement_* constructor.
     statement = handle->conn()->prepare(CSTRING(sql));
-    prepared  = Data_Wrap_Struct(cSwiftStatement, 0, statement_free, statement);
+    prepared  = statement_wrap_handle(cSwiftStatement, self, statement);
     rb_iv_set(prepared, "@scheme",  scheme);
     return prepared;
   }
@@ -226,8 +230,8 @@ static VALUE adapter_write(int argc, VALUE *argv, VALUE self) {
 VALUE adapter_results(VALUE self) {
   dbi::Handle *handle = adapter_handle(self);
   try {
-      dbi::AbstractResultSet *result = handle->results();
-      return Data_Wrap_Struct(cSwiftResult, 0, result_free, result);
+    dbi::AbstractResult *result = handle->results();
+    return result_wrap_handle(cSwiftResult, self, result, false);
   }
   CATCH_DBI_EXCEPTIONS();
 }

data/ext/attribute.cc

@@ -0,0 +1,22 @@
+#include "attribute.h"
+
+ID fcall;
+
+VALUE attribute_default(VALUE self) {
+  VALUE value = rb_iv_get(self, "@default");
+
+  if (NIL_P(value) || rb_special_const_p(value))
+    return value;
+  else if (rb_respond_to(value, fcall))
+    return rb_funcall(value, fcall, 0);
+  else
+    return rb_obj_dup(value);
+}
+
+void init_swift_attribute() {
+  VALUE mSwift          = rb_define_module("Swift");
+  VALUE cSwiftAttribute = rb_define_class_under(mSwift, "Attribute", rb_cObject);
+
+  fcall = rb_intern("call");
+  rb_define_method(cSwiftAttribute, "default", RUBY_METHOD_FUNC(attribute_default), 0);
+}

data/ext/attribute.h

@@ -0,0 +1,8 @@
+#ifndef SWIFT_ATTRIBUTE_H
+#define SWIFT_ATTRIBUTE_H
+
+#include "swift.h"
+
+void init_swift_attribute();
+
+#endif

data/ext/extconf.rb

@@ -55,6 +55,6 @@ exit 1 unless library_installed? 'pcrecpp', apt_install_hint('libpcre3-dev')
 exit 1 unless library_installed? 'uuid',    apt_install_hint('uuid-dev')
 exit 1 unless library_installed? 'dbic++',  apt_install_hint('dbic++-dev')
 
-assert_dbicpp_version '0.3.1'
+assert_dbicpp_version '0.4.0'
 
 create_makefile 'swift'

data/ext/pool.cc

@@ -18,15 +18,10 @@ static dbi::ConnectionPool* pool_handle(VALUE self) {
   return pool;
 }
 
-// TODO: Remove unnecessary assignments. See Adapter.
 VALUE pool_init(VALUE self, VALUE n, VALUE options) {
   VALUE db       = rb_hash_aref(options, ID2SYM(rb_intern("db")));
-  VALUE host     = rb_hash_aref(options, ID2SYM(rb_intern("host")));
-  VALUE port     = rb_hash_aref(options, ID2SYM(rb_intern("port")));
   VALUE user     = rb_hash_aref(options, ID2SYM(rb_intern("user")));
   VALUE driver   = rb_hash_aref(options, ID2SYM(rb_intern("driver")));
-  VALUE password = rb_hash_aref(options, ID2SYM(rb_intern("password")));
-  VALUE zone     = rb_hash_aref(options, ID2SYM(rb_intern("timezone")));
 
   if (NIL_P(db))     rb_raise(eSwiftArgumentError, "Pool#new called without :db");
   if (NIL_P(driver)) rb_raise(eSwiftArgumentError, "#new called without :driver");
@@ -39,20 +34,28 @@ VALUE pool_init(VALUE self, VALUE n, VALUE options) {
       NUM2INT(n),
       CSTRING(driver),
       CSTRING(user),
-      CSTRING(password),
+      CSTRING(rb_hash_aref(options, ID2SYM(rb_intern("password")))),
       CSTRING(db),
-      CSTRING(host),
-      CSTRING(port)
+      CSTRING(rb_hash_aref(options, ID2SYM(rb_intern("host")))),
+      CSTRING(rb_hash_aref(options, ID2SYM(rb_intern("port"))))
     );
+
+    rb_iv_set(self, "@timezone", rb_hash_aref(options, ID2SYM(rb_intern("timezone"))));
   }
   CATCH_DBI_EXCEPTIONS();
+
   return Qnil;
 }
 
-void pool_callback(dbi::AbstractResultSet *result) {
+void pool_callback(dbi::AbstractResult *result) {
   VALUE callback = (VALUE)result->context;
-  // NOTE ResultSet will be free'd by the underlying connection pool dispatcher ib dbic++
-  if (!NIL_P(callback)) rb_proc_call(callback, rb_ary_new3(1, Data_Wrap_Struct(cSwiftResult, 0, 0, result)));
+
+  // NOTE: C Result object will be deallocated in dbic++
+  if (!NIL_P(callback)) {
+    VALUE obj = result_wrap_handle(cSwiftResult, 0, result, false);
+    rb_iv_set(obj, "@timezone", rb_iv_get(callback, "@timezone"));
+    rb_proc_call(callback, rb_ary_new3(1, obj));
+  }
 }
 
 VALUE pool_execute(int argc, VALUE *argv, VALUE self) {
@@ -65,11 +68,15 @@ VALUE pool_execute(int argc, VALUE *argv, VALUE self) {
   dbi::ConnectionPool *pool = pool_handle(self);
   rb_scan_args(argc, argv, "1*&", &sql, &bind_values, &callback);
 
-  if (NIL_P(callback)) rb_raise(eSwiftArgumentError, "No block given in Pool#execute");
+  // The only way to pass timezone to the C callback routine.
+  if (NIL_P(callback))
+    rb_raise(eSwiftArgumentError, "No block given in Pool#execute");
+  else
+    rb_iv_set(callback, "@timezone", rb_iv_get(self, "@timezone"));
 
   try {
     Query query;
-    query_bind_values(&query, bind_values);
+    query_bind_values(&query, bind_values, pool->driver());
     request = request_alloc(cSwiftRequest);
     DATA_PTR(request) = pool->execute(CSTRING(sql), query.bind, pool_callback, (void*)callback);
     return request;

data/ext/query.cc

@@ -1,5 +1,8 @@
 #include "query.h"
 
+ID fstrftime, fto_s, fusec;
+VALUE dtformat, tzformat;
+
 VALUE query_execute(Query *query) {
   try {
     return UINT2NUM(
@@ -28,7 +31,7 @@ VALUE query_execute_statement(Query *query) {
   }
 }
 
-void query_bind_values(Query *query, VALUE bind_values) {
+void query_bind_values(Query *query, VALUE bind_values, std::string driver) {
   for (int i = 0; i < RARRAY_LEN(bind_values); i++) {
     VALUE bind_value = rb_ary_entry(bind_values, i);
 
@@ -45,6 +48,16 @@ void query_bind_values(Query *query, VALUE bind_values) {
       bind_value = rb_funcall(bind_value, rb_intern("read"), 0);
       query->bind.push_back(dbi::PARAM_BINARY((unsigned char*)RSTRING_PTR(bind_value), RSTRING_LEN(bind_value)));
     }
+    // TODO convert timestamps to server timezone if @timezone is set in adapter.
+    else if (rb_obj_is_kind_of(bind_value, rb_cTime)) {
+      std::string timestamp = RSTRING_PTR(rb_funcall(bind_value, fstrftime, 1, dtformat));
+
+      timestamp += RSTRING_PTR(rb_funcall(rb_funcall(bind_value, fusec, 0), fto_s, 0));
+      if (driver != "db2")
+        timestamp += RSTRING_PTR(rb_funcall(bind_value, fstrftime, 1, tzformat));
+
+      query->bind.push_back(dbi::PARAM(timestamp));
+    }
     else {
       bind_value = TO_S(bind_value);
       if (strcmp(rb_enc_get(bind_value)->name, "UTF-8") != 0)
@@ -54,3 +67,10 @@ void query_bind_values(Query *query, VALUE bind_values) {
   }
 }
 
+void init_swift_query() {
+  fstrftime = rb_intern("strftime");
+  fto_s     = rb_intern("to_s");
+  fusec     = rb_intern("usec");
+  dtformat  = rb_str_new2("%F %T.");
+  tzformat  = rb_str_new2("%z");
+}

data/ext/query.h

@@ -13,6 +13,7 @@ struct Query {
 
 VALUE query_execute(Query*);
 VALUE query_execute_statement(Query*);
-void query_bind_values(Query*, VALUE);
+void query_bind_values(Query*, VALUE, std::string);
+void init_swift_query();
 
 #endif