Skip to content

v4: Refactor #new and #connect #596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 10, 2025
Merged

v4: Refactor #new and #connect #596

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cd7c774
`TinyTds::Client.new` now accepts keyword arguments instead of a hash
andyundso Sep 9, 2025
206898d
Separate `#new` and `#connect`
andyundso Sep 9, 2025
321c66a
Rename `encoding` keyword argument to `charset`
andyundso Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@
* `TinyTds::Result` is now a pure Ruby class
* `#execute`: Replaced `opts` hash with keyword arguments
* Removed `symbolize_keys` and `cache_rows` from `#default_query_options`
* `TinyTds::Client.new` now accepts keyword arguments instead of a hash
* Renamed `tds_version` and `tds_version_info` to `server_version` and `server_version_info`
* Separate `#new` and `#connect`
* Instead, before running `#do`, `#execute` or `#insert`, `tiny_tds` will check if the connection is active and re-connect if needed.

## 3.3.0

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,15 +98,15 @@ Connect to a database.
client = TinyTds::Client.new username: 'sa', password: 'secret', host: 'mydb.host.net'
```

Creating a new client takes a hash of options. For valid iconv encoding options, see the output of `iconv -l`. Only a few have been tested, and are highly recommended to leave blank for the UTF-8 default.
Creating a new client takes keyword arguments. For valid iconv encoding options, see the output of `iconv -l`. Only a few have been tested, and are highly recommended to leave blank for the UTF-8 default.

* :username - The database server user.
* :password - The user password.
* :dataserver - Can be the name for your data server as defined in freetds.conf. Raw hostname or hostname:port will work here too. FreeTDS says that a named instance like 'localhost\SQLEXPRESS' will work too, but I highly suggest that you use the :host and :port options below. [Google how to find your host port if you are using named instances](http://bit.ly/xAf2jm) or [go here](http://msdn.microsoft.com/en-us/library/ms181087.aspx).
* :host - Used if :dataserver blank. Can be an host name or IP.
* :port - Defaults to 1433. Only used if :host is used.
* :database - The default database to use.
* :appname - Short string seen in SQL Servers process/activity window.
* :app_name - Short string seen in SQL Servers process/activity window.
* :tds_version - TDS version. Defaults to "7.3".
* :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. Timeouts caused by network failure will raise a timeout error 1 second after the configured timeout limit is hit (see [#481](https://github.com/rails-sqlserver/tiny_tds/pull/481) for details).
Expand Down
139 changes: 56 additions & 83 deletions ext/tiny_tds/client.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@

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, sym_azure, sym_contained, sym_use_utf16, sym_message_handler;
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, intern_call;
static ID intern_new, intern_dup, intern_local_offset, intern_gsub, intern_call, intern_active, intern_connect;
VALUE opt_escape_regex, opt_escape_dblquote;

static ID id_ivar_fields, id_ivar_rows, id_ivar_return_code, id_ivar_affected_rows, id_ivar_default_query_options, intern_bigd, intern_divide;
Expand All @@ -16,15 +15,6 @@ static VALUE cTinyTdsResult, cKernel, cDate;
rb_encoding *binaryEncoding;
VALUE opt_onek, opt_onebil, opt_float_zero, opt_four, opt_tenk;

static void rb_tinytds_client_mark(void *ptr)
{
tinytds_client_wrapper *cwrap = (tinytds_client_wrapper *)ptr;

if (cwrap) {
rb_gc_mark(cwrap->charset);
}
}

static void rb_tinytds_client_free(void *ptr)
{
tinytds_client_wrapper *cwrap = (tinytds_client_wrapper *)ptr;
Expand Down Expand Up @@ -52,7 +42,7 @@ static size_t tinytds_client_wrapper_size(const void* data)
static const rb_data_type_t tinytds_client_wrapper_type = {
.wrap_struct_name = "tinytds_client_wrapper",
.function = {
.dmark = rb_tinytds_client_mark,
.dmark = NULL,
.dfree = rb_tinytds_client_free,
.dsize = tinytds_client_wrapper_size,
},
Expand Down Expand Up @@ -460,7 +450,6 @@ static VALUE allocate(VALUE klass)
tinytds_client_wrapper *cwrap;
obj = TypedData_Make_Struct(klass, tinytds_client_wrapper, &tinytds_client_wrapper_type, cwrap);
cwrap->closed = 1;
cwrap->charset = Qnil;
cwrap->userdata = malloc(sizeof(tinytds_client_userdata));
cwrap->userdata->closed = 1;
rb_tinytds_client_reset_userdata(cwrap->userdata);
Expand All @@ -469,11 +458,15 @@ static VALUE allocate(VALUE klass)


// TinyTds::Client (public)

static VALUE rb_tinytds_tds_version(VALUE self)
static VALUE rb_tinytds_server_version(VALUE self)
{
GET_CLIENT_WRAPPER(self);
return INT2FIX(dbtds(cwrap->client));

if (rb_funcall(self, intern_active, 0) == Qtrue) {
return INT2FIX(dbtds(cwrap->client));
} else {
return Qnil;
}
}

static VALUE rb_tinytds_close(VALUE self)
Expand Down Expand Up @@ -746,6 +739,11 @@ static VALUE rb_tinytds_execute(int argc, VALUE *argv, VALUE self)
}

GET_CLIENT_WRAPPER(self);

if (rb_funcall(self, intern_active, 0) == Qfalse) {
rb_funcall(self, intern_connect, 0);
}

rb_tinytds_send_sql_to_server(cwrap, sql);

VALUE result = rb_obj_alloc(cTinyTdsResult);
Expand Down Expand Up @@ -857,6 +855,11 @@ static VALUE rb_tiny_tds_insert(VALUE self, VALUE sql)
{
VALUE identity = Qnil;
GET_CLIENT_WRAPPER(self);

if (rb_funcall(self, intern_active, 0) == Qfalse) {
rb_funcall(self, intern_connect, 0);
}

rb_tinytds_send_sql_to_server(cwrap, sql);
rb_tinytds_result_exec_helper(cwrap->client);

Expand Down Expand Up @@ -886,18 +889,17 @@ static VALUE rb_tiny_tds_insert(VALUE self, VALUE sql)
static VALUE rb_tiny_tds_do(VALUE self, VALUE sql)
{
GET_CLIENT_WRAPPER(self);

if (rb_funcall(self, intern_active, 0) == Qfalse) {
rb_funcall(self, intern_connect, 0);
}

rb_tinytds_send_sql_to_server(cwrap, sql);
rb_tinytds_result_exec_helper(cwrap->client);

return rb_tinytds_affected_rows(cwrap->client);
}

static VALUE rb_tinytds_charset(VALUE self)
{
GET_CLIENT_WRAPPER(self);
return cwrap->charset;
}

static VALUE rb_tinytds_encoding(VALUE self)
{
GET_CLIENT_WRAPPER(self);
Expand Down Expand Up @@ -925,25 +927,25 @@ static VALUE rb_tinytds_identity_sql(VALUE self)

// TinyTds::Client (protected)

static VALUE rb_tinytds_connect(VALUE self, VALUE opts)
static VALUE rb_tinytds_connect(VALUE self)
{
/* Parsing options hash to local vars. */
VALUE user, pass, dataserver, database, app, version, ltimeout, timeout, charset, azure, contained, use_utf16;
VALUE username, password, dataserver, database, app_name, tds_version, login_timeout, timeout, charset, azure, contained, use_utf16;
GET_CLIENT_WRAPPER(self);

user = rb_hash_aref(opts, sym_username);
pass = rb_hash_aref(opts, sym_password);
dataserver = rb_hash_aref(opts, sym_dataserver);
database = rb_hash_aref(opts, sym_database);
app = rb_hash_aref(opts, sym_appname);
version = rb_hash_aref(opts, sym_tds_version);
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);
contained = rb_hash_aref(opts, sym_contained);
use_utf16 = rb_hash_aref(opts, sym_use_utf16);
cwrap->userdata->message_handler = rb_hash_aref(opts, sym_message_handler);
app_name = rb_iv_get(self, "@app_name");
azure = rb_iv_get(self, "@azure");
contained = rb_iv_get(self, "@contained");
database = rb_iv_get(self, "@database");
dataserver = rb_iv_get(self, "@dataserver");
charset = rb_iv_get(self, "@charset");
login_timeout = rb_iv_get(self, "@login_timeout");
password = rb_iv_get(self, "@password");
tds_version = rb_iv_get(self, "@tds_version");
timeout = rb_iv_get(self, "@timeout");
username = rb_iv_get(self, "@username");
use_utf16 = rb_iv_get(self, "@use_utf16");
cwrap->userdata->message_handler = rb_iv_get(self, "@message_handler");

/* Dealing with options. */
if (dbinit() == FAIL) {
Expand All @@ -955,24 +957,24 @@ static VALUE rb_tinytds_connect(VALUE self, VALUE opts)
dbmsghandle(tinytds_msg_handler);
cwrap->login = dblogin();

if (!NIL_P(version)) {
dbsetlversion(cwrap->login, NUM2INT(version));
if (!NIL_P(tds_version)) {
dbsetlversion(cwrap->login, NUM2INT(tds_version));
}

if (!NIL_P(user)) {
dbsetluser(cwrap->login, StringValueCStr(user));
if (!NIL_P(username)) {
dbsetluser(cwrap->login, StringValueCStr(username));
}

if (!NIL_P(pass)) {
dbsetlpwd(cwrap->login, StringValueCStr(pass));
if (!NIL_P(password)) {
dbsetlpwd(cwrap->login, StringValueCStr(password));
}

if (!NIL_P(app)) {
dbsetlapp(cwrap->login, StringValueCStr(app));
if (!NIL_P(app_name)) {
dbsetlapp(cwrap->login, StringValueCStr(app_name));
}

if (!NIL_P(ltimeout)) {
dbsetlogintime(NUM2INT(ltimeout));
if (!NIL_P(login_timeout)) {
dbsetlogintime(NUM2INT(login_timeout));
}

if (!NIL_P(charset)) {
Expand All @@ -981,19 +983,7 @@ static VALUE rb_tinytds_connect(VALUE self, VALUE opts)

if (!NIL_P(database)) {
if (azure == Qtrue || contained == Qtrue) {
#ifdef DBSETLDBNAME
DBSETLDBNAME(cwrap->login, StringValueCStr(database));
Comment on lines 985 to 986
Copy link

Copilot AI Sep 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The removal of the #ifdef DBSETLDBNAME guard makes this code dependent on a specific FreeTDS version without fallback handling. Consider adding version checks or error handling for systems where DBSETLDBNAME is not available.

Copilot uses AI. Check for mistakes.
#else

if (azure == Qtrue) {
rb_warn("TinyTds: :azure option is not supported in this version of FreeTDS.\n");
}

if (contained == Qtrue) {
rb_warn("TinyTds: :contained option is not supported in this version of FreeTDS.\n");
}

#endif
}
}

Expand All @@ -1015,10 +1005,9 @@ static VALUE rb_tinytds_connect(VALUE self, VALUE opts)
VALUE transposed_encoding, timeout_string;

cwrap->closed = 0;
cwrap->charset = charset;

if (!NIL_P(version)) {
dbsetversion(NUM2INT(version));
if (!NIL_P(tds_version)) {
dbsetversion(NUM2INT(tds_version));
}

if (!NIL_P(timeout)) {
Expand All @@ -1037,8 +1026,7 @@ static VALUE rb_tinytds_connect(VALUE self, VALUE opts)
dbuse(cwrap->client, StringValueCStr(database));
}

transposed_encoding = rb_funcall(cTinyTdsClient, intern_transpose_iconv_encoding, 1, charset);
cwrap->encoding = rb_enc_find(StringValueCStr(transposed_encoding));
cwrap->encoding = rb_enc_find(StringValueCStr(charset));
cwrap->identity_insert_sql = "SELECT CAST(SCOPE_IDENTITY() AS bigint) AS Ident";
}

Expand All @@ -1053,7 +1041,7 @@ void init_tinytds_client()
cTinyTdsClient = rb_define_class_under(mTinyTds, "Client", rb_cObject);
rb_define_alloc_func(cTinyTdsClient, allocate);
/* Define TinyTds::Client Public Methods */
rb_define_method(cTinyTdsClient, "tds_version", rb_tinytds_tds_version, 0);
rb_define_method(cTinyTdsClient, "server_version", rb_tinytds_server_version, 0);
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);
Expand All @@ -1062,27 +1050,11 @@ void init_tinytds_client()
rb_define_method(cTinyTdsClient, "execute", rb_tinytds_execute, -1);
rb_define_method(cTinyTdsClient, "insert", rb_tiny_tds_insert, 1);
rb_define_method(cTinyTdsClient, "do", rb_tiny_tds_do, 1);
rb_define_method(cTinyTdsClient, "charset", rb_tinytds_charset, 0);
rb_define_method(cTinyTdsClient, "encoding", rb_tinytds_encoding, 0);
rb_define_method(cTinyTdsClient, "escape", rb_tinytds_escape, 1);
rb_define_method(cTinyTdsClient, "return_code", rb_tinytds_return_code, 0);
rb_define_method(cTinyTdsClient, "identity_sql", rb_tinytds_identity_sql, 0);
/* Define TinyTds::Client Protected Methods */
rb_define_protected_method(cTinyTdsClient, "connect", rb_tinytds_connect, 1);
/* Symbols For Connect */
sym_username = ID2SYM(rb_intern("username"));
sym_password = ID2SYM(rb_intern("password"));
sym_dataserver = ID2SYM(rb_intern("dataserver"));
sym_database = ID2SYM(rb_intern("database"));
sym_appname = ID2SYM(rb_intern("appname"));
sym_tds_version = ID2SYM(rb_intern("tds_version"));
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"));
sym_contained = ID2SYM(rb_intern("contained"));
sym_use_utf16 = ID2SYM(rb_intern("use_utf16"));
sym_message_handler = ID2SYM(rb_intern("message_handler"));
rb_define_method(cTinyTdsClient, "connect", rb_tinytds_connect, 0);
/* Intern TinyTds::Error Accessors */
intern_source_eql = rb_intern("source=");
intern_severity_eql = rb_intern("severity=");
Expand All @@ -1091,7 +1063,6 @@ void init_tinytds_client()
/* Intern Misc */
intern_new = rb_intern("new");
intern_dup = rb_intern("dup");
intern_transpose_iconv_encoding = rb_intern("transpose_iconv_encoding");
intern_local_offset = rb_intern("local_offset");
intern_gsub = rb_intern("gsub");
intern_call = rb_intern("call");
Expand All @@ -1115,6 +1086,8 @@ void init_tinytds_client()
intern_timezone = rb_intern("timezone");
intern_utc = rb_intern("utc");
intern_local = rb_intern("local");
intern_active = rb_intern("active?");
intern_connect = rb_intern("connect");

cTinyTdsClient = rb_const_get(mTinyTds, rb_intern("Client"));
cTinyTdsResult = rb_const_get(mTinyTds, rb_intern("Result"));
Expand Down
Loading
Loading