jackowayed-rufus-tokyo 0.1.13.1 → 0.1.13.2

data/lib/rufus/tokyo/cabinet/lib.rb

@@ -0,0 +1,231 @@
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+module Rufus::Tokyo
+
+  #
+  # The libtokyocabinet.so methods get bound to this module
+  #
+  module CabinetLib #:nodoc#
+    extend FFI::Library
+
+    #
+    # find Tokyo Cabinet lib
+
+    paths = Array(ENV['TOKYO_CABINET_LIB'] || %w{
+      /usr/lib/libtokyocabinet.so
+      /opt/local/lib/libtokyocabinet.dylib
+      /opt/local/lib/libtokyocabinet.so
+      /usr/local/lib/libtokyocabinet.dylib
+      /usr/local/lib/libtokyocabinet.so
+    })
+
+    begin
+
+      ffi_lib(*paths)
+
+    rescue LoadError => le
+      raise(
+        "didn't find Tokyo Cabinet libs on your system. " +
+        "Please install Tokyo Cabinet (http://tokyocabinet.sf.net) " +
+        "(see also http://openwferu.rubyforge.org/tokyo.html)"
+      )
+    end
+
+    class << self
+      alias :attfunc :attach_function
+    end
+
+    #
+    # maybe put that in a standalone c_lib.rb
+
+    # length of a string
+    #
+    attfunc :strlen, [ :string ], :int
+
+    # frees a mem zone (TC style)
+    #
+    attfunc :tcfree, [ :pointer ], :void
+
+    #
+    # tcadb functions
+    #
+    # http://tokyocabinet.sourceforge.net/spex-en.html#tcadbapi
+
+    attfunc :tcadbnew, [], :pointer
+
+    attfunc :tcadbopen, [ :pointer, :string ], :int
+    attfunc :abs_close, :tcadbclose, [ :pointer ], :int
+
+    attfunc :abs_del, :tcadbdel, [ :pointer ], :void
+
+    attfunc :abs_rnum, :tcadbrnum, [ :pointer ], :uint64
+    attfunc :abs_size, :tcadbsize, [ :pointer ], :uint64
+
+    attfunc :abs_put2, :tcadbput2, [ :pointer, :string, :string ], :int
+    attfunc :abs_get2, :tcadbget2, [ :pointer, :string ], :string
+    attfunc :abs_out2, :tcadbout2, [ :pointer, :string ], :int
+
+    attfunc :abs_iterinit, :tcadbiterinit, [ :pointer ], :int
+    attfunc :abs_iternext2, :tcadbiternext2, [ :pointer ], :string
+
+    attfunc :abs_vanish, :tcadbvanish, [ :pointer ], :int
+
+    attfunc :abs_sync, :tcadbsync, [ :pointer ], :int
+    attfunc :abs_copy, :tcadbcopy, [ :pointer, :string ], :int
+
+    attfunc :abs_fwmkeys2, :tcadbfwmkeys2, [ :pointer, :string, :int ], :pointer
+
+    attfunc :tcadbmisc, [ :pointer, :string, :pointer ], :pointer
+
+    attfunc :addint, :tcadbaddint, [ :pointer, :string, :int, :int ], :int
+    attfunc :adddouble, :tcadbadddouble, [ :pointer, :string, :int, :double ], :double
+
+    begin # since TC 1.4.13
+      attfunc :tcadbtranbegin, [ :pointer ], :int
+      attfunc :tcadbtrancommit, [ :pointer ], :int
+      attfunc :tcadbtranabort, [ :pointer ], :int
+    rescue FFI::NotFoundError => nfe
+    end
+
+    #
+    # tctdb functions
+    #
+    # http://tokyocabinet.sourceforge.net/spex-en.html#tctdbapi
+
+    attfunc :tctdbnew, [], :pointer
+    attfunc :tctdbsetmutex, [ :pointer ], :int
+    attfunc :tctdbtune, [ :pointer, :uint64, :uint8, :uint8, :uint8 ], :int
+    attfunc :tctdbsetcache, [ :pointer, :uint32, :uint32, :uint32 ], :int
+    attfunc :tctdbsetxmsiz, [ :pointer, :uint64 ], :int
+
+    begin # since TC 1.4.21
+      attfunc :tctdbsetdfunit, [ :pointer, :uint32 ], :int
+    rescue FFI::NotFoundError => nfe
+    end
+
+    attfunc :tctdbopen, [ :pointer, :string, :int ], :int
+
+    attfunc :tab_close, :tctdbclose, [ :pointer ], :int
+
+    attfunc :tab_genuid, :tctdbgenuid, [ :pointer ], :int64
+
+    attfunc :tab_get, :tctdbget, [ :pointer, :string, :int ], :pointer
+
+    attfunc :tab_iterinit, :tctdbiterinit, [ :pointer ], :int
+    attfunc :tab_iternext2, :tctdbiternext2, [ :pointer ], :string
+
+    attfunc :tab_put, :tctdbput, [ :pointer, :string, :int, :pointer ], :int
+
+    #attfunc :tctdbput3, [ :pointer, :string, :string ], :int
+      # not using it anymore, Ruby can turn an array into a hash so easily
+
+    attfunc :tab_out, :tctdbout, [ :pointer, :string, :int ], :int
+
+    attfunc :tab_ecode, :tctdbecode, [ :pointer ], :int
+    attfunc :tab_errmsg, :tctdberrmsg, [ :int ], :string
+
+    attfunc :tab_del, :tctdbdel, [ :pointer ], :void
+
+    attfunc :tab_rnum, :tctdbrnum, [ :pointer ], :uint64
+
+    attfunc :tab_vanish, :tctdbvanish, [ :pointer ], :int
+
+    attfunc :tab_setindex, :tctdbsetindex, [ :pointer, :string, :int ], :int
+
+    attfunc :tctdbtranbegin, [ :pointer ], :int
+    attfunc :tctdbtrancommit, [ :pointer ], :int
+    attfunc :tctdbtranabort, [ :pointer ], :int
+
+    attfunc :tab_fwmkeys2, :tctdbfwmkeys2, [ :pointer, :string, :int ], :pointer
+
+    #
+    # tctdbqry functions
+    #
+    # http://tokyocabinet.sourceforge.net/spex-en.html#tctdbapi
+
+    attfunc :qry_new, :tctdbqrynew, [ :pointer ], :pointer
+    attfunc :qry_del, :tctdbqrydel, [ :pointer ], :void
+
+    attfunc :qry_addcond, :tctdbqryaddcond, [ :pointer, :string, :int, :string ], :void
+    attfunc :qry_setorder, :tctdbqrysetorder, [ :pointer, :string, :int ], :void
+
+    begin # since TC 1.4.10
+      attfunc :qry_setmax, :tctdbqrysetmax, [ :pointer, :int ], :void
+    rescue FFI::NotFoundError => nfe
+      attfunc :qry_setlimit, :tctdbqrysetlimit, [ :pointer, :int, :int ], :void
+    end
+
+    attfunc :qry_search, :tctdbqrysearch, [ :pointer ], :pointer
+
+    begin # since TC 1.4.12
+      attfunc :qry_count, :tctdbqrycount, [ :pointer ], :int
+    rescue FFI::NotFoundError => nfe
+    end
+
+    #
+    # tcmap functions
+    #
+    # http://tokyocabinet.sourceforge.net/spex-en.html#tcutilapi
+
+    attfunc :tcmapnew, [], :pointer
+
+    attfunc :tcmapput2, [ :pointer, :string, :string ], :void
+    attfunc :tcmapout2, [ :pointer, :string ], :int
+    attfunc :tcmapclear, [ :pointer ], :void
+
+    attfunc :tcmapdel, [ :pointer ], :void
+
+    attfunc :tcmapget2, [ :pointer, :string ], :string
+
+    attfunc :tcmapiterinit, [ :pointer ], :void
+    attfunc :tcmapiternext2, [ :pointer ], :string
+
+    attfunc :tcmaprnum, [ :pointer ], :uint64
+
+    #
+    # tclist functions
+    #
+    # http://tokyocabinet.sourceforge.net/spex-en.html#tcutilapi
+
+    attfunc :tclistnew, [], :pointer
+
+    attfunc :tclistnum, [ :pointer ], :int
+    attfunc :tclistval2, [ :pointer, :int ], :string
+
+    attfunc :tclistpush2, [ :pointer, :string ], :void
+    attfunc :tclistpop2, [ :pointer ], :string
+    attfunc :tclistshift2, [ :pointer ], :string
+    attfunc :tclistunshift2, [ :pointer, :string ], :void
+    attfunc :tclistover2, [ :pointer, :int, :string ], :void
+
+    attfunc :tclistremove2, [ :pointer, :int ], :string
+    # beware, seems like have to free the return string self
+
+    attfunc :tclistdel, [ :pointer ], :void
+  end
+
+end
+

data/lib/rufus/tokyo/cabinet/table.rb

@@ -0,0 +1,644 @@
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+require 'rufus/tokyo/query'
+require 'rufus/tokyo/config'
+require 'rufus/tokyo/transactions'
+
+
+module Rufus::Tokyo
+
+  #
+  # A 'table' a table database.
+  #
+  #   http://alpha.mixi.co.jp/blog/?p=290
+  #   http://tokyocabinet.sourceforge.net/spex-en.html#tctdbapi
+  #
+  # A short example :
+  #
+  #   require 'rubygems'
+  #   require 'rufus/tokyo/cabinet/table'
+  #
+  #   t = Rufus::Tokyo::Table.new('table.tdb', :create, :write)
+  #     # '.tdb' suffix is a must
+  #
+  #   t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
+  #   t['pk1'] = { 'name' => 'bob', 'age' => '18' }
+  #   t['pk2'] = { 'name' => 'charly', 'age' => '45' }
+  #   t['pk3'] = { 'name' => 'doug', 'age' => '77' }
+  #   t['pk4'] = { 'name' => 'ephrem', 'age' => '32' }
+  #
+  #   p t.query { |q|
+  #     q.add_condition 'age', :numge, '32'
+  #     q.order_by 'age'
+  #     q.limit 2
+  #   }
+  #     # => [ {"name"=>"ephrem", :pk=>"pk4", "age"=>"32"},
+  #     #      {"name"=>"charly", :pk=>"pk2", "age"=>"45"} ]
+  #
+  #   t.close
+  #
+  class Table
+
+    include HashMethods
+    include CabinetConfig
+
+    include Transactions
+      # this class has tranbegin/trancommit/tranabort so let's include the
+      # transaction mixin
+
+    # Creates a Table instance (creates or opens it depending on the args)
+    #
+    # For example,
+    #
+    #   t = Rufus::Tokyo::Table.new('table.tdb')
+    #     # '.tdb' suffix is a must
+    #
+    # will create the table.tdb (or simply open it if already present)
+    # and make sure we have write access to it.
+    #
+    # == parameters
+    #
+    # Parameters can be set in the path or via the optional params hash (like
+    # in Rufus::Tokyo::Cabinet)
+    #
+    #   * :mode    a set of chars ('r'ead, 'w'rite, 'c'reate, 't'runcate,
+    #              'e' non locking, 'f' non blocking lock), default is 'wc'
+    #   * :opts    a set of chars ('l'arge, 'd'eflate, 'b'zip2, 't'cbs)
+    #              (usually empty or something like 'ld' or 'lb')
+    #
+    #   * :bnum    number of elements of the bucket array
+    #   * :apow    size of record alignment by power of 2 (defaults to 4)
+    #   * :fpow    maximum number of elements of the free block pool by
+    #              power of 2 (defaults to 10)
+    #   * :mutex   when set to true, makes sure only 1 thread at a time
+    #              accesses the table (well, Ruby, global thread lock, ...)
+    #
+    #   * :rcnum   specifies the maximum number of records to be cached.
+    #              If it is not more than 0, the record cache is disabled.
+    #              It is disabled by default.
+    #   * :lcnum   specifies the maximum number of leaf nodes to be cached.
+    #              If it is not more than 0, the default value is specified.
+    #              The default value is 2048.
+    #   * :ncnum   specifies the maximum number of non-leaf nodes to be
+    #              cached. If it is not more than 0, the default value is
+    #              specified. The default value is 512.
+    #
+    #   * :xmsiz   specifies the size of the extra mapped memory. If it is
+    #              not more than 0, the extra mapped memory is disabled.
+    #              The default size is 67108864.
+    #
+    #   * :dfunit  unit step number. If it is not more than 0,
+    #              the auto defragmentation is disabled. (Since TC 1.4.21)
+    #
+    # Some examples :
+    #
+    #   t = Rufus::Tokyo::Table.new('table.tdb')
+    #   t = Rufus::Tokyo::Table.new('table.tdb#mode=r')
+    #   t = Rufus::Tokyo::Table.new('table.tdb', :mode => 'r')
+    #   t = Rufus::Tokyo::Table.new('table.tdb#opts=ld#mode=r')
+    #   t = Rufus::Tokyo::Table.new('table.tdb', :opts => 'ld', :mode => 'r')
+    #
+    def initialize (path, params={})
+
+      conf = determine_conf(path, params, :table)
+
+      @db = lib.tctdbnew
+
+      #
+      # tune table
+
+      libcall(:tctdbsetmutex) if conf[:mutex]
+
+      libcall(:tctdbtune, conf[:bnum], conf[:apow], conf[:fpow], conf[:opts])
+
+      # TODO : set indexes here... well, there is already #set_index
+      #conf[:indexes]...
+
+      libcall(:tctdbsetcache, conf[:rcnum], conf[:lcnum], conf[:ncnum])
+
+      libcall(:tctdbsetxmsiz, conf[:xmsiz])
+
+      libcall(:tctdbsetdfunit, conf[:dfunit]) \
+        if lib.respond_to?(:tctdbsetdfunit) # TC >= 1.4.21
+
+      #
+      # open table
+
+      @path = conf[:path]
+
+      libcall(:tctdbopen, @path, conf[:mode])
+    end
+
+    # Using the cabinet lib
+    #
+    def lib
+      CabinetLib
+    end
+
+    # Returns the path to the table.
+    #
+    def path
+
+      @path
+    end
+
+    # Closes the table (and frees the datastructure allocated for it),
+    # returns true in case of success.
+    #
+    def close
+      result = lib.tab_close(@db)
+      lib.tab_del(@db)
+      (result == 1)
+    end
+
+    # Generates a unique id (in the context of this Table instance)
+    #
+    def generate_unique_id
+      lib.tab_genuid(@db)
+    end
+    alias :genuid :generate_unique_id
+
+    INDEX_TYPES = {
+      :lexical => 0,
+      :decimal => 1,
+      :void => 9999,
+      :remove => 9999,
+      :keep => 1 << 24
+    }
+
+    # Sets an index on a column of the table.
+    #
+    # Types maybe be :lexical or :decimal, use :keep to "add" and
+    # :remove (or :void) to "remove" an index.
+    #
+    # If column_name is :pk or "", the index will be set on the primary key.
+    #
+    # Returns true in case of success.
+    #
+    def set_index (column_name, *types)
+
+      column_name = '' if column_name == :pk
+
+      i = types.inject(0) { |i, t| i = i | INDEX_TYPES[t]; i }
+
+      (lib.tab_setindex(@db, column_name, i) == 1)
+    end
+
+    # Inserts a record in the table db
+    #
+    #   table['pk0'] = [ 'name', 'fred', 'age', '45' ]
+    #   table['pk1'] = { 'name' => 'jeff', 'age' => '46' }
+    #
+    # Accepts both a hash or an array (expects the array to be of the
+    # form [ key, value, key, value, ... ] else it will raise
+    # an ArgumentError)
+    #
+    # Raises an error in case of failure.
+    #
+    def []= (pk, h_or_a)
+
+      m = Rufus::Tokyo::Map[h_or_a]
+
+      r = lib.tab_put(@db, pk, CabinetLib.strlen(pk), m.pointer)
+
+      m.free
+
+      (r == 1) || raise_error # raising potential error after freeing map
+
+      h_or_a
+    end
+
+    # Removes an entry in the table
+    #
+    # (might raise an error if the delete itself failed, but returns nil
+    # if there was no entry for the given key)
+    #
+    def delete (k)
+      v = self[k]
+      return nil unless v
+      libcall(:tab_out, k, CabinetLib.strlen(k))
+      v
+    end
+
+    # Removes all records in this table database
+    #
+    def clear
+      libcall(:tab_vanish)
+    end
+
+    # Returns an array of all the primary keys in the table
+    #
+    # With no options given, this method will return all the keys (strings)
+    # in a Ruby array.
+    #
+    #   :prefix --> returns only the keys who match a given string prefix
+    #
+    #   :limit --> returns a limited number of keys
+    #
+    #   :native --> returns an instance of Rufus::Tokyo::List instead of
+    #     a Ruby Hash, you have to call #free on that List when done with it !
+    #     Else you're exposing yourself to a memory leak.
+    #
+    def keys (options={})
+
+      if pref = options[:prefix]
+
+        l = lib.tab_fwmkeys2(@db, pref, options[:limit] || -1)
+        l = Rufus::Tokyo::List.new(l)
+        options[:native] ? l : l.release
+
+      else
+
+        limit = options[:limit] || -1
+        limit = nil if limit < 1
+
+        l = options[:native] ? Rufus::Tokyo::List.new : []
+
+        lib.tab_iterinit(@db)
+
+        while (k = (lib.tab_iternext2(@db) rescue nil))
+          break if limit and l.size >= limit
+          l << k
+        end
+
+        l
+      end
+    end
+
+    # Deletes all the entries whose key begin with the given prefix.
+    #
+    def delete_keys_with_prefix (prefix)
+
+      # TODO : use ...searchout
+
+      ks = lib.tab_fwmkeys2(@db, prefix, -1) # -1 for no limit
+      #Rufus::Tokyo::List.new(ks).release.each { |k| self.delete(k) }
+      begin
+        ks = Rufus::Tokyo::List.new(ks)
+        ks.each { |k| self.delete(k) }
+      ensure
+        ks.free
+      end
+    end
+
+    # No 'misc' methods for the table library, so this lget is equivalent
+    # to calling get for each key. Hoping later versions of TC will provide
+    # a mget method.
+    #
+    def lget (keys)
+
+      # TODO : maybe investigate a query on the column 'primary_key' ?
+
+      keys.inject({}) { |h, k| v = self[k]; h[k] = v if v; h }
+    end
+
+    # Returns the number of records in this table db
+    #
+    def size
+
+      lib.tab_rnum(@db)
+    end
+
+    # Prepares a query instance (block is optional)
+    #
+    def prepare_query (&block)
+
+      q = TableQuery.new(self)
+      block.call(q) if block
+      q
+    end
+
+    # Prepares and runs a query, returns a ResultSet instance
+    # (takes care of freeing the query structure)
+    #
+    def do_query (&block)
+      q = prepare_query(&block)
+      rs = q.run
+      q.free
+      rs
+    end
+
+    # Prepares and runs a query, returns an array of hashes (all Ruby)
+    # (takes care of freeing the query and the result set structures)
+    #
+    def query (&block)
+      rs = do_query(&block)
+      a = rs.to_a
+      rs.free
+      a
+    end
+
+    # Warning : this method is low-level, you probably only need
+    # to use #transaction and a block.
+    #
+    # Direct call for 'transaction begin'.
+    #
+    def tranbegin
+      libcall(:tctdbtranbegin)
+    end
+
+    # Warning : this method is low-level, you probably only need
+    # to use #transaction and a block.
+    #
+    # Direct call for 'transaction commit'.
+    #
+    def trancommit
+      libcall(:tctdbtrancommit)
+    end
+
+    # Warning : this method is low-level, you probably only need
+    # to use #transaction and a block.
+    #
+    # Direct call for 'transaction abort'.
+    #
+    def tranabort
+      libcall(:tctdbtranabort)
+    end
+
+    # Returns the actual pointer to the Tokyo Cabinet table
+    #
+    def pointer
+      @db
+    end
+
+    protected
+
+    # Returns the value (as a Ruby Hash) else nil
+    #
+    # (the actual #[] method is provided by HashMethods)
+    #
+    def get (k)
+      m = lib.tab_get(@db, k, CabinetLib.strlen(k))
+      return nil if m.address == 0 # :( too bad, but it works
+      Map.to_h(m) # which frees the map
+    end
+
+    def libcall (lib_method, *args)
+
+      #(lib.send(lib_method, @db, *args) == 1) or raise_error
+        # stack level too deep with JRuby 1.1.6 :(
+
+      (eval(%{ lib.#{lib_method}(@db, *args) }) == 1) or raise_error
+        # works with JRuby 1.1.6
+    end
+
+    # Obviously something got wrong, let's ask the db about it and raise
+    # a TokyoError
+    #
+    def raise_error
+
+      err_code = lib.tab_ecode(@db)
+      err_msg = lib.tab_errmsg(err_code)
+
+      raise TokyoError.new("(err #{err_code}) #{err_msg}")
+    end
+  end
+
+  #
+  # A query on a Tokyo Cabinet table db
+  #
+  class TableQuery
+
+    include QueryConstants
+
+    # Creates a query for a given Rufus::Tokyo::Table
+    #
+    # Queries are usually created via the #query (#prepare_query #do_query)
+    # of the Table instance.
+    #
+    # Methods of interest here are :
+    #
+    #   * #add (or #add_condition)
+    #   * #order_by
+    #   * #limit
+    #
+    # also
+    #
+    #   * #pk_only
+    #   * #no_pk
+    #
+    def initialize (table)
+      @table = table
+      @query = @table.lib.qry_new(@table.pointer)
+      @opts = {}
+    end
+
+    def lib
+      @table.lib
+    end
+
+    # Adds a condition
+    #
+    #   table.query { |q|
+    #     q.add 'name', :equals, 'Oppenheimer'
+    #     q.add 'age', :numgt, 35
+    #   }
+    #
+    # Understood 'operators' :
+    #
+    #   :streq # string equality
+    #   :eq
+    #   :eql
+    #   :equals
+    #
+    #   :strinc # string include
+    #   :inc # string include
+    #   :includes # string include
+    #
+    #   :strbw # string begins with
+    #   :bw
+    #   :starts_with
+    #   :strew # string ends with
+    #   :ew
+    #   :ends_with
+    #
+    #   :strand # string which include all the tokens in the given exp
+    #   :and
+    #
+    #   :stror # string which include at least one of the tokens
+    #   :or
+    #
+    #   :stroreq # string which is equal to at least one token
+    #
+    #   :strorrx # string which matches the given regex
+    #   :regex
+    #   :matches
+    #
+    #   # numbers...
+    #
+    #   :numeq # equal
+    #   :numequals
+    #   :numgt # greater than
+    #   :gt
+    #   :numge # greater or equal
+    #   :ge
+    #   :gte
+    #   :numlt # greater or equal
+    #   :lt
+    #   :numle # greater or equal
+    #   :le
+    #   :lte
+    #   :numbt # a number between two tokens in the given exp
+    #   :bt
+    #   :between
+    #
+    #   :numoreq # number which is equal to at least one token
+    #
+    def add (colname, operator, val, affirmative=true, no_index=true)
+
+      op = operator.is_a?(Fixnum) ? operator : OPERATORS[operator]
+      op = op | TDBQCNEGATE unless affirmative
+      op = op | TDBQCNOIDX if no_index
+      lib.qry_addcond(@query, colname, op, val)
+    end
+    alias :add_condition :add
+
+    # Sets the max number of records to return for this query.
+    #
+    # (If you're using TC >= 1.4.10 the optional 'offset' (skip) parameter
+    # is accepted)
+    #
+    def limit (i, offset=-1)
+
+      lib.respond_to?(:qry_setlimit) ?
+        lib.qry_setlimit(@query, i, offset) :
+        lib.qry_setmax(@query, i)
+    end
+
+    # Sets the sort order for the result of the query
+    #
+    # The 'direction' may be :
+    #
+    #   :strasc # string ascending
+    #   :strdesc
+    #   :asc # string ascending
+    #   :desc
+    #   :numasc # number ascending
+    #   :numdesc
+    #
+    def order_by (colname, direction=:strasc)
+      lib.qry_setorder(@query, colname, DIRECTIONS[direction])
+    end
+
+    # When set to true, only the primary keys of the matching records will
+    # be returned.
+    #
+    def pk_only (on=true)
+      @opts[:pk_only] = on
+    end
+
+    # When set to true, the :pk (primary key) is not inserted in the record
+    # (hashes) returned
+    #
+    def no_pk (on=true)
+      @opts[:no_pk] = on
+    end
+
+    # Runs this query (returns a TableResultSet instance)
+    #
+    def run
+
+      @last_resultset =
+        TableResultSet.new(@table, lib.qry_search(@query), @opts)
+    end
+
+    # Gets the count of records returned by this query.
+    #
+    # Note : the 'real' impl is only available since TokyoCabinet 1.4.12.
+    #
+    def count
+
+      if lib.respond_to?(:qry_count)
+        lib.qry_count(@query)
+      else
+        @last_resultset ? @last_resultset.size : 0
+      end
+    end
+
+    # Frees this data structure
+    #
+    def free
+      lib.qry_del(@query)
+      @query = nil
+    end
+
+    alias :close :free
+    alias :destroy :free
+  end
+
+  #
+  # The thing queries return
+  #
+  class TableResultSet
+    include Enumerable
+
+    def initialize (table, list_pointer, query_opts)
+      @table = table
+      @list = list_pointer
+      @opts = query_opts
+    end
+
+    # Returns the count of element in this result set
+    #
+    def size
+      CabinetLib.tclistnum(@list)
+    end
+
+    alias :length :size
+
+    # The classical each
+    #
+    def each
+      (0..size-1).each do |i|
+        pk = CabinetLib.tclistval2(@list, i)
+        if @opts[:pk_only]
+          yield(pk)
+        else
+          val = @table[pk]
+          val[:pk] = pk unless @opts[:no_pk]
+          yield(val)
+        end
+      end
+    end
+
+    # Returns an array of hashes
+    #
+    def to_a
+      collect { |m| m }
+    end
+
+    # Frees this query (the underlying Tokyo Cabinet list structure)
+    #
+    def free
+      CabinetLib.tclistdel(@list)
+      @list = nil
+    end
+
+    alias :close :free
+    alias :destroy :free
+  end
+end
+