Module: Informix::Cursor

Defined in:: lib/informix.rb,
ext/informixc.c

Overview

class Slob

Class Method Summary collapse

.new(db, query, options = nil) ⇒ Object

Shortcut to create a cursor object based on query using options.
.new0(*args) ⇒ Object

The underlying class method that prepares a cursor and creates the respective cursor object.
.open(db, query, options = nil) ⇒ Object

Shortcut to create and open a cursor object based on query using options in a single step.

Class Method Details

.new(db, query, options = nil) ⇒ `Object`

Shortcut to create a cursor object based on query using options.

The cursor object is passed to the block if it’s given, and automatically released when the block terminates, returning the value of the block.

options can be a Hash object with the following possible keys:

:scroll => true or false
:hold   => true or false

# File 'lib/informix.rb', line 338

def self.new(db, query, options = nil)
  if options
    Hash === options||raise(TypeError,"options must be supplied as a Hash")
  end
  cur = new0(db, query, options)
  return cur unless block_given?
  begin
    yield cur
  ensure
    cur.free
  end
end

.new0(*args) ⇒ `Object`

The underlying class method that prepares a cursor and creates the respective cursor object.

# File 'ext/informixc.c', line 4113

static VALUE
rb_cursor_s_new0(int argc, VALUE *argv, VALUE self)
{
  VALUE db, query, options, ret;
  VALUE scroll, hold;
  struct sqlda *output;
  cursor_t c, *cur;
  database_t *dbt;
  long id;
/*
 *  EXEC SQL begin declare section;
 */
#line 3096 "informixc.ec"
#line 3097 "informixc.ec"
  char *c_query;
  char *cid, *sid, *did;
/*
 *  EXEC SQL end   declare section;
 */
#line 3099 "informixc.ec"


  memset(&c, 0, sizeof(c));
  rb_scan_args(argc, argv, "21", &db, &query, &options);
  Data_Get_Struct(db, database_t, dbt);
  did = dbt->database_id;
/*
 *  EXEC SQL set connection :did;
 */
#line 3105 "informixc.ec"
  {
#line 3105 "informixc.ec"
  sqli_connect_set(0, did, 0);
#line 3105 "informixc.ec"
  }

  if (SQLCODE < 0)
    raise_ifx_extended();

  c.db = db;
  c.database_id = did;
  scroll = hold = Qfalse;
  id = dbt->idcount++;
  snprintf(c.cursor_id, sizeof(c.cursor_id), "CUR%lX", id);
  snprintf(c.stmt_id, sizeof(c.stmt_id), "STMT%lX", id);
  cid = c.cursor_id; sid = c.stmt_id;
  c_query = StringValueCStr(query);

  if (!NIL_P(options)) {
    Check_Type(options, T_HASH);
    scroll = rb_hash_aref(options, sym_scroll);
    hold = rb_hash_aref(options, sym_hold);
  }

/*
 *  EXEC SQL prepare :sid from :c_query;
 */
#line 3125 "informixc.ec"
  {
#line 3125 "informixc.ec"
  sqli_prep(ESQLINTVERSION, sid, c_query,(ifx_literal_t *)0, (ifx_namelist_t *)0, -1, 0, 0 ); 
#line 3125 "informixc.ec"
  }
  if (SQLCODE < 0)
    raise_ifx_extended();

  if (RTEST(scroll) && RTEST(hold))
/*
 *    EXEC SQL declare :cid scroll cursor with hold for :sid;
 */
#line 3130 "informixc.ec"
  {
#line 3130 "informixc.ec"
  sqli_curs_decl_dynm(ESQLINTVERSION, sqli_curs_locate(ESQLINTVERSION, cid, 0), cid, sqli_curs_locate(ESQLINTVERSION, sid, 1), 4128, 0);
#line 3130 "informixc.ec"
  }
  else if (RTEST(hold))
/*
 *    EXEC SQL declare :cid cursor with hold for :sid;
 */
#line 3132 "informixc.ec"
  {
#line 3132 "informixc.ec"
  sqli_curs_decl_dynm(ESQLINTVERSION, sqli_curs_locate(ESQLINTVERSION, cid, 0), cid, sqli_curs_locate(ESQLINTVERSION, sid, 1), 4096, 0);
#line 3132 "informixc.ec"
  }
  else if (RTEST(scroll))
/*
 *    EXEC SQL declare :cid scroll cursor for :sid;
 */
#line 3134 "informixc.ec"
  {
#line 3134 "informixc.ec"
  sqli_curs_decl_dynm(ESQLINTVERSION, sqli_curs_locate(ESQLINTVERSION, cid, 0), cid, sqli_curs_locate(ESQLINTVERSION, sid, 1), 32, 0);
#line 3134 "informixc.ec"
  }
  else
/*
 *    EXEC SQL declare :cid cursor for :sid;
 */
#line 3136 "informixc.ec"
  {
#line 3136 "informixc.ec"
  sqli_curs_decl_dynm(ESQLINTVERSION, sqli_curs_locate(ESQLINTVERSION, cid, 0), cid, sqli_curs_locate(ESQLINTVERSION, sid, 1), 0, 0);
#line 3136 "informixc.ec"
  }

  if (SQLCODE < 0)
    raise_ifx_extended();

  alloc_input_slots(&c, c_query);
/*
 *  EXEC SQL describe :sid into output;
 */
#line 3142 "informixc.ec"
  {
#line 3142 "informixc.ec"
  sqli_describe_stmt(ESQLINTVERSION, sqli_curs_locate(ESQLINTVERSION, sid, 257), &output, 0);
#line 3142 "informixc.ec"
  }
  c.daOutput = output;

  c.is_select = (SQLCODE == 0 || SQLCODE == SQ_EXECPROC);

  if (c.is_select) {
    alloc_output_slots(&c);
    if (scroll)
      ret = cursorbase_alloc(rb_cScrollCursor);
    else
      ret = cursorbase_alloc(rb_cSequentialCursor);
  }
  else {
    xfree(c.daOutput);
    c.daOutput = NULL;
    ret = cursorbase_alloc(rb_cInsertCursor);
  }
  Data_Get_Struct(ret, cursor_t, cur);
  memcpy(cur, &c, sizeof(cursor_t));

  return ret;
}

.open(db, query, options = nil) ⇒ `Object`

Shortcut to create and open a cursor object based on query using options in a single step.