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.

Removes all records in this table database

Raises an error if something went wrong

Closes the table (and frees the datastructure allocated for it), raises an exception in case of failure.

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)

Raises an error if something went wrong

Deletes all the entries whose key begin with the given prefix.

Returns the difference of the listed queries

  r = table.intersection(
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'es'
    },
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'li'
    }
  )

will return a hash { primary_key => record } of the values matching the first query OR the second but not both.

If the last element element passed to this method is the value ‘false’, the return value will the array of matching primary keys.

Generates a unique id (in the context of this Table instance)

Returns the intersection of the listed queries

  r = table.intersection(
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'es'
    },
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'li'
    }
  )

will return a hash { primary_key => record } of the values matching the first query AND the second.

If the last element element passed to this method is the value ‘false’, the return value will the array of matching primary keys.

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

Returns a hash { key => record } of all the records matching the given keys.

Returns the underlying ‘native’ Ruby object (of the class devised by Hirabayashi-san)

Prepares a query instance (block is optional)

Prepares and runs a query, returns an array of hashes (all Ruby) (takes care of freeing the query and the result set structures)

Prepares, runs AND delete all the matching records.

A #search a la ruby-tokyotyrant (http://github.com/actsasflinn/ruby-tokyotyrant/tree)

  r = table.search(
    :intersection,
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'es'
    },
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'li'
    }
  )

Accepts the symbols :union, :intersection, :difference or :diff as first parameter.

If the last element element passed to this method is the value ‘false’, the return value will the array of matching primary keys.

Sets an index on a column of the table.

Types maybe be :lexical or :decimal.

Recently (TC 1.4.26 and 1.4.27) inverted indexes have been added, they are :token and :qgram. There is an :opt index as well.

Sorry couldn’t find any good doc about those inverted indexes apart from :

  http://alpha.mixi.co.jp/blog/?p=1147
  http://www.excite-webtl.jp/world/english/web/?wb_url=http%3A%2F%2Falpha.mixi.co.jp%2Fblog%2F%3Fp%3D1147&wb_lp=JAEN&wb_dis=2&wb_submit=<tt>96%7C</tt>%96%F3+

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.

Returns the number of records in this table db

Warning : this method is low-level, you probably only need to use #transaction and a block.

Direct call for ‘transaction abort’.

Warning : this method is low-level, you probably only need to use #transaction and a block.

Direct call for ‘transaction begin’.

Warning : this method is low-level, you probably only need to use #transaction and a block.

Direct call for ‘transaction commit’.

Returns the union of the listed queries

  r = table.union(
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'es'
    },
    @t.prepare_query { |q|
      q.add 'lang', :includes, 'li'
    }
  )

will return a hash { primary_key => record } of the values matching the first query OR the second.

If the last element element passed to this method is the value ‘false’, the return value will the array of matching primary keys.