Small Kyoto Cabinet and Kyoto Tycoon Notes - Revision history

Admin: /* RPC API Interface */

2013-01-18T08:40:06Z

‎RPC API Interface

Admin: /* RPC API Interface */

2013-01-15T15:42:40Z

‎RPC API Interface

Admin at 14:58, 15 January 2013

2013-01-15T14:58:55Z

Admin at 14:02, 20 December 2012

2012-12-20T14:02:14Z

Admin: Created page with "== Kyoto Cabinet == [http://fallabs.com/kyotocabinet/spex.html Kyoto Cabinet at FAL Labs]

 ./configure --prefix=/home/user make make check make install

== Kyoto Ty..."

2012-12-20T13:52:50Z

Created page with "== Kyoto Cabinet == [http://fallabs.com/kyotocabinet/spex.html Kyoto Cabinet at FAL Labs] <pre> ./configure --prefix=/home/user make make check make install </pre> == Kyoto Ty..."

New page

== Kyoto Cabinet ==

[http://fallabs.com/kyotocabinet/spex.html Kyoto Cabinet at FAL Labs]

<pre>
./configure --prefix=/home/user
make
make check
make install
</pre>

== Kyoto Tycoon ==

[http://fallabs.com/kyototycoon/spex.html Kyoto Tycoon at FAL Labs]

<pre>
./configure --prefix=/home/user --with-kc=/home/user --enable-static
make
make check
make install
</pre>

← Older revision		Revision as of 08:40, 18 January 2013
Line 22:		Line 22:

	== RPC API Interface ==		== RPC API Interface ==
		+
		+	Kyoto Tycoon's RPC API is a lovely example of simplicity - input parameters are consistent with regards to naming, output is '''always''' the same - be it success or error. As usual, this comes at a slightly higher data volume transferred in few cases (the "order" value in ''match_xyz'' calls), but this overhead is minimal and well worth the lowered complexity.
		+
		+	Data are always returned in TSV (tab-separated-values) format, one record per line, two columns per record, where first column is key and second column value. Input and output parameters that are not part of the KT language are always preceded by underscore (_). Parsing the output is then trivial for all calls.

	Further on:		Further on:

@@ Line 38: / Line 38: @@
 < value
 < + xt - absolute expiration time
   get_bulk
@@ Line 46: / Line 51: @@
 < num - number of retrieved records
 < + [output] - data with keys trailing the character '_'
   check
@@ Line 53: / Line 64: @@
 < + vsiz - size of the record's value
 < + xt
   set

← Older revision		Revision as of 14:58, 15 January 2013
Line 20:		Line 20:
	make install		make install
	</pre>		</pre>
		+
		+	== RPC API Interface ==
		+
		+	Further on:
		+	<pre>- short description
		+	> input parameter, required
		+	> + input parameter, optional
		+	< output parameter
		+	< + output parameter, might be omitted if not set</pre>
		+
		+	All calls accept optional <tt>DB</tt> parameter (int) that identifies DB to use.
		+
		+	<pre> get
		+	=====
		+	- retrieve value of a record
		+	> key
		+	< value
		+	< + xt - absolute expiration time
		+
		+	get_bulk
		+	==========
		+	- retrieve multiple records at once
		+	> + atomic - if present, attempt to store the records atomically
		+	> + [input] - arbitrary keys which trail the character '_'
		+	< num - number of retrieved records
		+	< + [output] - data with keys trailing the character '_'
		+
		+	check
		+	=======
		+	- checks whether record exists in DB
		+	> key
		+	< + vsiz - size of the record's value
		+	< + xt
		+
		+	set
		+	=====
		+	- set value of record
		+	> key
		+	> value
		+	> + xt - expiration time as offset in seconds; if negative, the absolute value is epoch time
		+
		+	set_bulk
		+	==========
		+	- store multiple records at once
		+	> + xt
		+	> + atomic - if present, attempt to store the records atomically
		+	> + [input] - arbitrary records whose keys trail the character '_'
		+	< num - number of stored records
		+
		+	add
		+	=====
		+	- add a record only if it does not exist
		+	> key
		+	> value
		+	> + xt
		+
		+	replace
		+	=========
		+	- replace value of a record
		+	> key
		+	> value
		+	> + xt
		+
		+	append
		+	========
		+	- append value to a record
		+	> key
		+	> value
		+	> + xt
		+
		+	increment
		+	===========
		+	- add int value to a record (treated as int)
		+	> key
		+	> num - the number to add
		+	> + orig - origin number, 0 if omitted, 'try' for INT64MIN, 'set' for INT64MAX
		+	> + xt
		+	< num - resulting value
		+
		+	increment_double
		+	==================
		+	- add double value to a record (treated as double)
		+	> key
		+	> num
		+	> + orig - origin number, 0 if omitted, 'try' for negative infinity, 'set' for positive infinity
		+	> + xt
		+
		+	cas
		+	=====
		+	- compare and swap (i.e. set the value of record to new value only if it still has the old value)
		+	> key
		+	> + oval - old value; if omitted, no record is meant
		+	> + nval - new value; if omitted, the record is removed
		+	> + xt
		+
		+	seize
		+	=======
		+	- retrieve value of a record and remove it atomically
		+	> key
		+	< + value
		+	< + xt
		+
		+	remove
		+	========
		+	- remove a record
		+	> key
		+
		+	remove_bulk
		+	=============
		+	- remove multiple records at once
		+	> + atomic - if present, attempt to store the records atomically
		+	> + [input] - arbitrary records whose keys trail the character '_'
		+	< num - number of removed records
		+
		+	clear
		+	==========
		+	- remove all records in DB