# tokyo_tyrant

- Introduction
- Installing/Configuring
  - Requirements
  - Installation
  - Runtime Configuration
  - Resource Types
- Predefined Constants
- Examples
- TokyoTyrant — The TokyoTyrant class
  - TokyoTyrant::add — Adds to a numeric key
  - TokyoTyrant::connect — Connect to a database
  - TokyoTyrant::connectUri — Connects to a database
  - TokyoTyrant::__construct — Construct a new TokyoTyrant object
  - TokyoTyrant::copy — Copies the database
  - TokyoTyrant::ext — Execute a remote script
  - TokyoTyrant::fwmKeys — Returns the forward matching keys
  - TokyoTyrant::get — The get purpose
  - TokyoTyrant::getIterator — Get an iterator
  - TokyoTyrant::num — Number of records in the database
  - TokyoTyrant::out — Removes records
  - TokyoTyrant::put — Puts values
  - TokyoTyrant::putCat — Concatenates to a record
  - TokyoTyrant::putKeep — Puts a record
  - TokyoTyrant::putNr — Puts value
  - TokyoTyrant::putShl — Concatenates to a record
  - TokyoTyrant::restore — Restore the database
  - TokyoTyrant::setMaster — Set the replication master
  - TokyoTyrant::size — Returns the size of the value
  - TokyoTyrant::stat — Get statistics
  - TokyoTyrant::sync — Synchronize the database
  - TokyoTyrant::tune — Tunes connection values
  - TokyoTyrant::vanish — Empties the database
- TokyoTyrantTable — The TokyoTyrantTable class
  - TokyoTyrantTable::add — Adds a record
  - TokyoTyrantTable::genUid — Generate unique id
  - TokyoTyrantTable::get — Get a row
  - TokyoTyrantTable::getIterator — Get an iterator
  - TokyoTyrantTable::getQuery — Get a query object
  - TokyoTyrantTable::out — Remove records
  - TokyoTyrantTable::put — Store a row
  - TokyoTyrantTable::putCat — Concatenates to a row
  - TokyoTyrantTable::putKeep — Put a new record
  - TokyoTyrantTable::putNr — Puts value
  - TokyoTyrantTable::putShl — Concatenates to a record
  - TokyoTyrantTable::setIndex — Sets index
- TokyoTyrantQuery — The TokyoTyrantQuery class
  - TokyoTyrantQuery::addCond — Adds a condition to the query
  - TokyoTyrantQuery::__construct — Construct a new query
  - TokyoTyrantQuery::count — Counts records
  - TokyoTyrantQuery::current — Returns the current element
  - TokyoTyrantQuery::hint — Get the hint string of the query
  - TokyoTyrantQuery::key — Returns the current key
  - TokyoTyrantQuery::metaSearch — Retrieve records with multiple queries
  - TokyoTyrantQuery::next — Moves the iterator to next entry
  - TokyoTyrantQuery::out — Removes records based on query
  - TokyoTyrantQuery::rewind — Rewinds the iterator
  - TokyoTyrantQuery::search — Searches records
  - TokyoTyrantQuery::setLimit — Limit results
  - TokyoTyrantQuery::setOrder — Orders results
  - TokyoTyrantQuery::valid — Checks the validity of current item
- TokyoTyrantIterator — The TokyoTyrantIterator class
  - TokyoTyrantIterator::__construct — Construct an iterator
  - TokyoTyrantIterator::current — Get the current value
  - TokyoTyrantIterator::key — Returns the current key
  - TokyoTyrantIterator::next — Move to next key
  - TokyoTyrantIterator::rewind — Rewinds the iterator
  - TokyoTyrantIterator::valid — Rewinds the iterator
- TokyoTyrantException — The TokyoTyrantException class