tiny_tds 0.4.2 → 0.4.3

data/CHANGELOG

@@ -1,4 +1,13 @@
 
+* 0.4.3 *
+
+* New Client#active? method to check for good connection. Always use this abstract method.
+
+* Better SYBEWRIT "Write to SQL Server failed." error handling. New Client#dead? check.
+
+* Azure tested using latest FreeTDS with submitted patch. https://gist.github.com/889190
+
+
 * 0.4.2 *
 
 * Iconv is a dep only when compiling locally. However, left in the ability to configure it for native gem installation but you must use --enable-iconv before using --with-iconv-dir=/some/dir

data/README.rdoc

@@ -30,7 +30,7 @@ Although we search for FreeTDS's libraries and headers, you may have to specify
 
 == FreeTDS Compatibility
 
-TinyTDS is developed for FreeTDS 0.82 & 0.83.dev. It is tested with SQL Server 2000, 2005, and 2008 using TDS Version 8.0. We utilize FreeTDS's db-lib client library. We compile against sybdb.h and define MSDBLIB which means that our client enables Microsoft behavior in the db-lib API where it diverges from Sybase's. You do NOT need to compile FreeTDS with the "--enable-msdblib" option for our client to work properly. However, please make sure to compile FreeTDS with libiconv support for encodings to work at their best. Run "tsql -C" in your console and check for "iconv library: yes".
+TinyTDS is developed for FreeTDS 0.82 & 0.83.dev. It is tested with SQL Server 2000, 2005, 2008 and Azure using TDS Version 8.0. We utilize FreeTDS's db-lib client library. We compile against sybdb.h, undefine MSDBLIB and define SYBDBLIB which means that internally we conform to sybase API to db-lib. TinyTDS will work for both Sybase & Miscrosoft SQL Server. You do NOT need to compile FreeTDS with the "--enable-msdblib" option for our client to work properly. However, please make sure to compile FreeTDS with libiconv support for encodings to work at their best. Run "tsql -C" in your console and check for "iconv library: yes".
 
 
 
@@ -64,11 +64,20 @@ Creating a new client takes a hash of options. For valid iconv encoding options,
 * :login_timeout - Seconds to wait for login. Default to 60 seconds.
 * :timeout - Seconds to wait for a response to a SQL command. Default 5 seconds.
 * :encoding - Any valid iconv value like CP1251 or ISO-8859-1. Default UTF-8.
+* :azure - Pass true to signal that you are connecting to azure.
 
-Close and free a clients connection.
-
+Use the #active? method to determine if a connection is good. The implementation of this method may change but it should always guarantee that a connection is good. Current it checks for either a closed or dead connection.
+  
+  client.dead?    # => false
+  client.closed?  # => false
+  client.active?  # => true
+  client.execute("SQL TO A DEAD SERVER")
+  client.dead?    # => true
+  client.closed?  # => false
+  client.active?  # => false
   client.close
-  client.closed? # => true
+  client.closed?  # => true
+  client.active?  # => false
 
 Escape strings.
 
@@ -95,7 +104,7 @@ Calling #each on the result will lazily load each row from the database.
 
 A result object has a #fields accessor. It can be called before the result rows are iterated over. Even if no rows are returned, #fields will still return the column names you expected. Any SQL that does not return columned data will always return an empty array for #fields. It is important to remember that if you access the #fields before iterating over the results, the columns will always follow the default query option's :symbolize_keys setting at the client's level and will ignore the query options passed to each.
 
-  result = client.execute("USE [tinytds_test]")
+  result = client.execute("USE [tinytdstest]")
   result.fields # => []
   result.do
   
@@ -219,9 +228,15 @@ http://github.com/rails-sqlserver/activerecord-sqlserver-adapter/wiki/Using-Tiny
 
 
 
+== Using TinyTDS with Azure
+
+TinyTDS is fully tested with the Azure platform. You must set the :azure => true connection option when connecting. This is needed to specify the default in the login packet since Azure has no notion of "USE [database]". You must use the latest FreeTDS 0.83.dev and it must be compiled with OpenSSL.
+
+
+
 == Development & Testing
 
-We use bundler for development. Simply run "bundle install" then "rake" to build the gem and run the unit tests. The tests assume you have created a database named "tinytds_test" accessible by a database owner named "tinytds". Before running the test rake task, you may need to define a pair of environment variables that help the client connect to your specific FreeTDS database server name and which schema (2000, 2005 or 2008) to use. For example:
+We use bundler for development. Simply run "bundle install" then "rake" to build the gem and run the unit tests. The tests assume you have created a database named "tinytdstest" accessible by a database owner named "tinytds". Before running the test rake task, you may need to define a pair of environment variables that help the client connect to your specific FreeTDS database server name and which schema (2000, 2005, 2008 or azure) to use. For example:
 
   $ rake TINYTDS_UNIT_DATASERVER=mydbserver TINYTDS_SCHEMA=sqlserver_2008
 
@@ -244,7 +259,7 @@ Current to do list.
 
 == About Me
 
-My name is Ken Collins and to avoid confusion – I have no love for Microsoft nor do I work on Windows or have I ever owned a PC, just so we know :) – I currently maintain the SQL Server adapter for ActiveRecord and wrote this library as my first cut into learning ruby C extensions. Hopefully it will help promote the power of ruby and the rails framework to those that have not yet discovered it. My blog is http://metaskills.net and I can be found on twitter as @metaskills. Enjoy!
+My name is Ken Collins and I currently maintain the SQL Server adapter for ActiveRecord and wrote this library as my first cut into learning ruby C extensions. Hopefully it will help promote the power of ruby and the rails framework to those that have not yet discovered it. My blog is http://metaskills.net and I can be found on twitter as @metaskills. Enjoy!
 
 
 

data/ext/tiny_tds/client.c

@@ -4,7 +4,7 @@
 
 VALUE cTinyTdsClient;
 extern VALUE mTinyTds, cTinyTdsError;
-static ID sym_username, sym_password, sym_dataserver, sym_database, sym_appname, sym_tds_version, sym_login_timeout, sym_timeout, sym_encoding;
+static ID sym_username, sym_password, sym_dataserver, sym_database, sym_appname, sym_tds_version, sym_login_timeout, sym_timeout, sym_encoding, sym_azure;
 static ID intern_source_eql, intern_severity_eql, intern_db_error_number_eql, intern_os_error_number_eql;
 static ID intern_new, intern_dup, intern_transpose_iconv_encoding, intern_local_offset, intern_gsub;
 VALUE opt_escape_regex, opt_escape_dblquote;
@@ -66,6 +66,8 @@ int tinytds_err_handler(DBPROCESS *dbproc, int severity, int dberr, int oserr, c
    case SYBESEOF: {
      if (userdata && userdata->timing_out)
        return_value = INT_TIMEOUT;
+     return INT_CANCEL;
+     break;
    }
    case SYBETIME: {
      if (userdata) {
@@ -78,6 +80,12 @@ int tinytds_err_handler(DBPROCESS *dbproc, int severity, int dberr, int oserr, c
      cancel = 1;
      break;
    }
+   case SYBEWRIT: {
+     if (userdata && (userdata->dbsqlok_sent || userdata->dbcancel_sent))
+       return INT_CANCEL;
+     cancel = 1;
+     break;
+   }
    case SYBEREAD:
      cancel = 1;
      break;
@@ -150,6 +158,11 @@ static VALUE rb_tinytds_close(VALUE self) {
   return Qtrue;
 }
 
+static VALUE rb_tinytds_dead(VALUE self) {
+  GET_CLIENT_WRAPPER(self);
+  return dbdead(cwrap->client) ? Qtrue : Qfalse;
+}
+
 static VALUE rb_tinytds_closed(VALUE self) {
   GET_CLIENT_WRAPPER(self);
   return (cwrap->closed || cwrap->userdata->closed) ? Qtrue : Qfalse;
@@ -224,7 +237,7 @@ static VALUE rb_tinytds_return_code(VALUE self) {
 
 static VALUE rb_tinytds_connect(VALUE self, VALUE opts) {
   /* Parsing options hash to local vars. */
-  VALUE user, pass, dataserver, database, app, version, ltimeout, timeout, charset;
+  VALUE user, pass, dataserver, database, app, version, ltimeout, timeout, charset, azure;
   user = rb_hash_aref(opts, sym_username);
   pass = rb_hash_aref(opts, sym_password);
   dataserver = rb_hash_aref(opts, sym_dataserver);
@@ -234,6 +247,7 @@ static VALUE rb_tinytds_connect(VALUE self, VALUE opts) {
   ltimeout = rb_hash_aref(opts, sym_login_timeout);
   timeout = rb_hash_aref(opts, sym_timeout);
   charset = rb_hash_aref(opts, sym_encoding);
+  azure = rb_hash_aref(opts, sym_azure);
   /* Dealing with options. */
   if (dbinit() == FAIL) {
     rb_raise(cTinyTdsError, "failed dbinit() function");
@@ -257,14 +271,22 @@ static VALUE rb_tinytds_connect(VALUE self, VALUE opts) {
     dbsettime(NUM2INT(timeout));
   if (!NIL_P(charset))
     DBSETLCHARSET(cwrap->login, StringValuePtr(charset));
+  if (!NIL_P(database) && (azure == Qtrue)) {
+    #ifdef DBSETLDBNAME
+      DBSETLDBNAME(cwrap->login, StringValuePtr(database));
+    #else
+      rb_warn("TinyTds: Azure connections not supported in this version of FreeTDS.\n");
+    #endif
+  }
   cwrap->client = dbopen(cwrap->login, StringValuePtr(dataserver));
   if (cwrap->client) {
     cwrap->closed = 0;
     cwrap->charset = charset;
     dbsetuserdata(cwrap->client, (BYTE*)cwrap->userdata);
     cwrap->userdata->closed = 0;
-    if (!NIL_P(database))
+    if (!NIL_P(database) && (azure != Qtrue)) {
       dbuse(cwrap->client, StringValuePtr(database));
+    }
     #ifdef HAVE_RUBY_ENCODING_H
       VALUE transposed_encoding = rb_funcall(cTinyTdsClient, intern_transpose_iconv_encoding, 1, charset);
       cwrap->encoding = rb_enc_find(StringValuePtr(transposed_encoding));
@@ -284,6 +306,7 @@ void init_tinytds_client() {
   rb_define_method(cTinyTdsClient, "close", rb_tinytds_close, 0);
   rb_define_method(cTinyTdsClient, "closed?", rb_tinytds_closed, 0);
   rb_define_method(cTinyTdsClient, "canceled?", rb_tinytds_canceled, 0);
+  rb_define_method(cTinyTdsClient, "dead?", rb_tinytds_dead, 0);
   rb_define_method(cTinyTdsClient, "sqlsent?", rb_tinytds_sqlsent, 0);
   rb_define_method(cTinyTdsClient, "execute", rb_tinytds_execute, 1);
   rb_define_method(cTinyTdsClient, "charset", rb_tinytds_charset, 0);
@@ -302,6 +325,7 @@ void init_tinytds_client() {
   sym_login_timeout = ID2SYM(rb_intern("login_timeout"));
   sym_timeout = ID2SYM(rb_intern("timeout"));
   sym_encoding = ID2SYM(rb_intern("encoding"));
+  sym_azure = ID2SYM(rb_intern("azure"));
   /* Intern TinyTds::Error Accessors */
   intern_source_eql = rb_intern("source=");
   intern_severity_eql = rb_intern("severity=");

data/lib/tiny_tds.rb

@@ -14,5 +14,5 @@ require 'tiny_tds/tiny_tds'
 #
 # Tiny Ruby Wrapper For FreeTDS Using DB-Library
 module TinyTds
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/lib/tiny_tds/client.rb

@@ -62,6 +62,9 @@ module TinyTds
       "#{info[:name]} - #{info[:description]}" if info
     end
 
+    def active?
+      !closed? && !dead?
+    end
 
     private
     

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tiny_tds
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: 
   segments: 
   - 0
   - 4
-  - 2
-  version: 0.4.2
+  - 3
+  version: 0.4.3
 platform: ruby
 authors: 
 - Ken Collins
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-24 00:00:00 -04:00
+date: 2011-04-01 00:00:00 -04:00
 default_executable: 
 dependencies: []