This is the cl-rethinkdb Reference Manual, version 0.6.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Jul 15 04:16:40 2025 GMT+0.
cl-rethinkdb/cl-rethinkdb.asdcl-rethinkdb/util.lispcl-rethinkdb/package.lispcl-rethinkdb/config.lispcl-rethinkdb/protocol.lispcl-rethinkdb/reql/types.lispcl-rethinkdb/reql/function.lispcl-rethinkdb/reql/commands.lispcl-rethinkdb/reql/dsl.lispcl-rethinkdb/reql/pseudotypes.lispcl-rethinkdb/connection.lispcl-rethinkdb/query.lispThe main system appears first, followed by any subsystem dependency.
cl-rethinkdbA RethinkDB driver for Common Lisp
Andrew Danger Lyon <orthecreedence@gmail.com>
MIT
0.6.7
blackbird (system).
vom (system).
local-time (system).
event-glue (system).
cl-async (system).
fast-io (system).
jonathan (system).
cl-base64 (system).
cl-hash-util (system).
cl-ppcre (system).
util.lisp (file).
package.lisp (file).
config.lisp (file).
protocol.lisp (file).
reql (module).
connection.lisp (file).
query.lisp (file).
Modules are listed depth-first from the system components tree.
cl-rethinkdb/reqlconfig.lisp (file).
cl-rethinkdb (system).
types.lisp (file).
function.lisp (file).
commands.lisp (file).
dsl.lisp (file).
pseudotypes.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-rethinkdb/cl-rethinkdb.asdcl-rethinkdb/util.lispcl-rethinkdb/package.lispcl-rethinkdb/config.lispcl-rethinkdb/protocol.lispcl-rethinkdb/reql/types.lispcl-rethinkdb/reql/function.lispcl-rethinkdb/reql/commands.lispcl-rethinkdb/reql/dsl.lispcl-rethinkdb/reql/pseudotypes.lispcl-rethinkdb/connection.lispcl-rethinkdb/query.lispcl-rethinkdb/util.lispcl-rethinkdb (system).
do-hash/alist (macro).
do-list/vector (macro).
endian (function).
jprint (function).
unendian (function).
cl-rethinkdb/package.lisputil.lisp (file).
cl-rethinkdb (system).
cl-rethinkdb/config.lisppackage.lisp (file).
cl-rethinkdb (system).
*object-type* (special variable).
*sequence-type* (special variable).
cl-rethinkdb/protocol.lisppackage.lisp (file).
cl-rethinkdb (system).
+datum-type-array+ (constant).
+datum-type-bool+ (constant).
+datum-type-json+ (constant).
+datum-type-null+ (constant).
+datum-type-num+ (constant).
+datum-type-object+ (constant).
+datum-type-str+ (constant).
+proto-json+ (constant).
+proto-query-continue+ (constant).
+proto-query-start+ (constant).
+proto-query-stop+ (constant).
+proto-query-wait+ (constant).
+proto-version+ (constant).
+rdb-response-atom+ (constant).
+rdb-response-client-error+ (constant).
+rdb-response-compile-error+ (constant).
+rdb-response-feed+ (constant).
+rdb-response-partial+ (constant).
+rdb-response-runtime-error+ (constant).
+rdb-response-sequence+ (constant).
+rdb-response-wait-complete+ (constant).
cl-rethinkdb/reql/function.lisptypes.lisp (file).
reql (module).
fn (macro).
*varnum* (special variable).
generate-fn-var (function).
cl-rethinkdb/reql/commands.lispfunction.lisp (file).
reql (module).
%to-json (method).
make-load-form (method).
print-object (method).
∅ (function).
!= (function).
% (function).
&& (function).
* (function).
*commands* (special variable).
+ (function).
- (function).
/ (function).
< (function).
<= (function).
== (function).
> (function).
>= (function).
append (function).
april (function).
args (function).
asc (function).
attr (function).
august (function).
avg (function).
between (function).
between-dep (function).
binary (function).
bracket (function).
branch (function).
call (function).
change-at (function).
changes (function).
circle (function).
cmd-arg (function).
cmd-args (reader method).
(setf cmd-args) (writer method).
cmd-name (reader method).
(setf cmd-name) (writer method).
cmd-op (reader method).
(setf cmd-op) (writer method).
cmd-options (reader method).
(setf cmd-options) (writer method).
coerce-to (function).
concat-map (function).
config (function).
contains (function).
count (function).
date (function).
day (function).
day-of-week (function).
day-of-year (function).
db (function).
db-create (function).
db-drop (function).
db-list (function).
december (function).
default (function).
defcommand (macro).
delete (function).
delete-at (function).
desc (function).
difference (function).
distance (function).
distinct (function).
do (function).
downcase (function).
during (function).
epoch-time (function).
eq-join (function).
error (function).
expr (function).
february (function).
fill (function).
filter (function).
for-each (function).
friday (function).
func (function).
geojson (function).
get (function).
get-all (function).
get-intersecting (function).
get-nearest (function).
group (function).
has-fields (function).
hours (function).
http (function).
in-timezone (function).
includes (function).
index-create (function).
index-drop (function).
index-list (function).
index-rename (function).
index-status (function).
index-wait (function).
info (function).
inner-join (function).
insert (function).
insert-at (function).
intersects (function).
is-empty (function).
iso8601 (function).
january (function).
javascript (function).
json (function).
july (function).
june (function).
keys (function).
limit (function).
line (function).
literal (function).
make-array (function).
make-obj (function).
map (function).
march (function).
match (function).
max (function).
maxval (function).
may (function).
merge (function).
min (function).
minutes (function).
minval (function).
monday (function).
month (function).
november (function).
now (function).
nth (function).
object (function).
october (function).
offsets-of (function).
order-by (function).
outer-join (function).
pluck (function).
point (function).
polygon (function).
polygon-sub (function).
prepend (function).
random (function).
range (function).
rebalance (function).
reconfigure (function).
reduce (function).
replace (function).
reql-cmd (class).
row (function).
sample (function).
saturday (function).
seconds (function).
september (function).
set-difference (function).
set-insert (function).
set-intersection (function).
set-union (function).
skip (function).
slice (function).
splice-at (function).
split (function).
status (function).
sum (function).
sunday (function).
sync (function).
table (function).
table-create (function).
table-drop (function).
table-list (function).
thursday (function).
time (function).
time-of-day (function).
timezone (function).
to-epoch-time (function).
to-geojson (function).
to-iso8601 (function).
to-json-string (function).
tuesday (function).
type-of (function).
ungroup (function).
union (function).
upcase (function).
update (function).
uuid (function).
var (function).
wait (function).
wednesday (function).
with-fields (function).
without (function).
year (function).
zip (function).
~ (function).
cl-rethinkdb/reql/dsl.lispcommands.lisp (file).
reql (module).
r (macro).
cl-rethinkdb/reql/pseudotypes.lispdsl.lisp (file).
reql (module).
convert-pseudotypes-recursive (function).
reql-error (condition).
convert-pseudotypes (function).
reql-error-msg (reader method).
cl-rethinkdb/connection.lispreql (module).
config.lisp (file).
cl-rethinkdb (system).
*empty* (special variable).
connect-error (condition).
connect-error-msg (reader method).
do-close (function).
do-connect (function).
finalize-connect (function).
finalize-query (function).
set-callbacks (function).
sock-write (function).
socket-data (macro).
cl-rethinkdb/query.lispreql (module).
protocol.lisp (file).
config.lisp (file).
connection.lisp (file).
cl-rethinkdb (system).
*state* (special variable).
connect (function).
cursor (class).
cursor-error (condition).
cursor-no-more-results (condition).
cursor-overshot (condition).
cursor-stopped (condition).
cursorp (function).
disconnect (function).
each (function).
has-next (function).
next (function).
print-object (method).
query-client-error (condition).
query-compile-error (condition).
query-error (condition).
query-error-msg (reader method).
query-runtime-error (condition).
run (function).
state (class).
stop (function).
stop/disconnect (function).
to-array (function).
to-sequence (function).
wait-complete (function).
active-queries (reader method).
(setf active-queries) (writer method).
conn-kv (reader method).
(setf conn-kv) (writer method).
connection-options (class).
cursor-current-result (reader method).
(setf cursor-current-result) (writer method).
cursor-debug (reader method).
(setf cursor-debug) (writer method).
cursor-error-cursor (reader method).
cursor-error-token (reader method).
cursor-future (reader method).
(setf cursor-future) (writer method).
cursor-last-change (reader method).
(setf cursor-last-change) (writer method).
cursor-results (reader method).
(setf cursor-results) (writer method).
(setf cursor-results) (method).
cursor-state (reader method).
(setf cursor-state) (writer method).
(setf cursor-state) (method).
cursor-token (reader method).
(setf cursor-token) (writer method).
generate-token (function).
get-cursor (function).
json-to-response (function).
make-response-handler (function).
more (function).
parse-response (function).
query-error-backtrace (reader method).
query-error-query (reader method).
query-error-token (reader method).
remove-cursor (function).
save-cursor (function).
serialize-query (function).
state-token (reader method).
(setf state-token) (writer method).
with-query (macro).
Packages are listed by definition order.
cl-rethinkdb-utilblackbird.
common-lisp.
do-hash/alist (macro).
do-list/vector (macro).
endian (function).
jprint (function).
unendian (function).
cl-rethinkdbr
blackbird.
cl-rethinkdb-reql.
cl-rethinkdb-util.
common-lisp.
*object-type* (special variable).
*sequence-type* (special variable).
*state* (special variable).
connect (function).
cursor (class).
cursor-error (condition).
cursor-no-more-results (condition).
cursor-overshot (condition).
cursor-stopped (condition).
cursorp (function).
disconnect (function).
each (function).
has-next (function).
next (function).
query-client-error (condition).
query-compile-error (condition).
query-error (condition).
query-error-msg (generic reader).
query-runtime-error (condition).
run (function).
state (class).
stop (function).
stop/disconnect (function).
to-array (function).
to-sequence (function).
wait-complete (function).
*empty* (special variable).
+datum-type-array+ (constant).
+datum-type-bool+ (constant).
+datum-type-json+ (constant).
+datum-type-null+ (constant).
+datum-type-num+ (constant).
+datum-type-object+ (constant).
+datum-type-str+ (constant).
+proto-json+ (constant).
+proto-query-continue+ (constant).
+proto-query-start+ (constant).
+proto-query-stop+ (constant).
+proto-query-wait+ (constant).
+proto-version+ (constant).
+rdb-response-atom+ (constant).
+rdb-response-client-error+ (constant).
+rdb-response-compile-error+ (constant).
+rdb-response-feed+ (constant).
+rdb-response-partial+ (constant).
+rdb-response-runtime-error+ (constant).
+rdb-response-sequence+ (constant).
+rdb-response-wait-complete+ (constant).
active-queries (generic reader).
(setf active-queries) (generic writer).
conn-kv (generic reader).
(setf conn-kv) (generic writer).
connect-error (condition).
connect-error-msg (generic reader).
connection-options (class).
cursor-current-result (generic reader).
(setf cursor-current-result) (generic writer).
cursor-debug (generic reader).
(setf cursor-debug) (generic writer).
cursor-error-cursor (generic reader).
cursor-error-token (generic reader).
cursor-future (generic reader).
(setf cursor-future) (generic writer).
cursor-last-change (generic reader).
(setf cursor-last-change) (generic writer).
cursor-results (generic reader).
(setf cursor-results) (generic function).
cursor-state (generic reader).
(setf cursor-state) (generic function).
cursor-token (generic reader).
(setf cursor-token) (generic writer).
do-close (function).
do-connect (function).
finalize-connect (function).
finalize-query (function).
generate-token (function).
get-cursor (function).
json-to-response (function).
make-response-handler (function).
more (function).
parse-response (function).
query-error-backtrace (generic reader).
query-error-query (generic reader).
query-error-token (generic reader).
remove-cursor (function).
save-cursor (function).
serialize-query (function).
set-callbacks (function).
sock-write (function).
socket-data (macro).
state-token (generic reader).
(setf state-token) (generic writer).
with-query (macro).
cl-rethinkdb-reqlreql
cl-rethinkdb-util.
common-lisp.
convert-pseudotypes-recursive (function).
fn (macro).
r (macro).
reql-error (condition).
∅ (function).
!= (function).
% (function).
&& (function).
* (function).
*commands* (special variable).
*varnum* (special variable).
+ (function).
- (function).
/ (function).
< (function).
<= (function).
== (function).
> (function).
>= (function).
alist (type).
alistp (function).
append (function).
april (function).
args (function).
asc (function).
attr (function).
august (function).
avg (function).
between (function).
between-dep (function).
binary (function).
bracket (function).
branch (function).
call (function).
change-at (function).
changes (function).
circle (function).
cmd-arg (function).
cmd-args (generic reader).
(setf cmd-args) (generic writer).
cmd-name (generic reader).
(setf cmd-name) (generic writer).
cmd-op (generic reader).
(setf cmd-op) (generic writer).
cmd-options (generic reader).
(setf cmd-options) (generic writer).
coerce-to (function).
concat-map (function).
config (function).
contains (function).
convert-pseudotypes (function).
count (function).
date (function).
day (function).
day-of-week (function).
day-of-year (function).
db (function).
db-create (function).
db-drop (function).
db-list (function).
december (function).
default (function).
defcommand (macro).
delete (function).
delete-at (function).
desc (function).
difference (function).
distance (function).
distinct (function).
do (function).
downcase (function).
during (function).
epoch-time (function).
eq-join (function).
error (function).
expr (function).
february (function).
fill (function).
filter (function).
for-each (function).
friday (function).
func (function).
generate-fn-var (function).
geojson (function).
get (function).
get-all (function).
get-intersecting (function).
get-nearest (function).
group (function).
has-fields (function).
hours (function).
http (function).
in-timezone (function).
includes (function).
index-create (function).
index-drop (function).
index-list (function).
index-rename (function).
index-status (function).
index-wait (function).
info (function).
inner-join (function).
insert (function).
insert-at (function).
intersects (function).
is-empty (function).
iso8601 (function).
january (function).
javascript (function).
json (function).
july (function).
june (function).
keys (function).
limit (function).
line (function).
literal (function).
make-array (function).
make-obj (function).
map (function).
march (function).
match (function).
max (function).
maxval (function).
may (function).
merge (function).
min (function).
minutes (function).
minval (function).
monday (function).
month (function).
november (function).
now (function).
nth (function).
object (function).
october (function).
offsets-of (function).
order-by (function).
outer-join (function).
pluck (function).
point (function).
polygon (function).
polygon-sub (function).
prepend (function).
random (function).
range (function).
rebalance (function).
reconfigure (function).
reduce (function).
replace (function).
reql-cmd (class).
reql-error-msg (generic reader).
row (function).
sample (function).
saturday (function).
seconds (function).
september (function).
set-difference (function).
set-insert (function).
set-intersection (function).
set-union (function).
skip (function).
slice (function).
splice-at (function).
split (function).
status (function).
sum (function).
sunday (function).
sync (function).
table (function).
table-create (function).
table-drop (function).
table-list (function).
thursday (function).
time (function).
time-of-day (function).
timezone (function).
to-epoch-time (function).
to-geojson (function).
to-iso8601 (function).
to-json-string (function).
tuesday (function).
type-of (function).
ungroup (function).
union (function).
upcase (function).
update (function).
uuid (function).
var (function).
wait (function).
wednesday (function).
with-fields (function).
without (function).
year (function).
zip (function).
~ (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Defines whether data returned as an object should be an :alist or :hash.
Defines whether data returned as a sequence should be a :list or :array.
Holds all tracking state for the RethinkDB driver.
Generifies looping over a hash table or alist.
Generifies looping over a list OR vector.
Makes creating anonymous REQL functions easy. Takes a list of arguments (this is not a real lambda list, just a flat list of args) and wraps the body in the REQL-generating form ’r’.
Wraps query generation in a macro that takes care of pesky function naming
issues. For instance, the function ‘count‘ is reserved in CL, so importing
cl-rethinkdb-reql:count into your app might mess a lot of things up.
Instead, you can wrap your queries in (r ...) and use *keywords* for function
names, and all will be well. For instance:
(r::insert (r::table "users") ’(("name" . "larry")))
becomes:
(r (:insert (:table "users") ’(("name" . "larry"))))
This allows you to separate CL functions from query functions both logically
and visually.
Connect to a RethinkDB database, optionally specifying the database.
Recursively handle RethinkDB’s pseudotypes in returned objects.
Determine if the given object is a cursor.
Disconnect a RethinkDB connection.
Call the given function on every result in the given cursor.
Convert a number into N bytes little endian.
Determine if a cursor has more results.
Grab the next result from a cursor. Always returns a future since it may have to get more results from the server.
This function runs the given query, and returns a future that’s finished when the query response comes in.
Cleanup a cursor both locally and in the database. Returns a future that is finished with *no values* once the stop operation has completed.
Call stop on a cursor and disconnect the passed socket.
Grab ALL results from a cursor. Returns a future finished with the final array.
Takes a socket and a cursor an returns a sequence of all the items that cursor points to (the type of sequence returned depends on *sequence-type*)
Turns N number of bytes at offset in bytes into an integer.
Wait for noreply => t queries to come back LOL.
query-error)) ¶msg.
Describes a general query error.
Thrown when a cursor has no more results on it.
Thrown when a cursor has no more results on it.
Thrown when a cursor that has a pending operation is stopped.
A client error condition.
A query compile error condition.
A general query failure condition.
simple-error.
(quote nil)
:token
This slot is read-only.
(quote nil)
:query
This slot is read-only.
(quote nil)
:backtrace
This slot is read-only.
(quote "")
:msg
This slot is read-only.
A query runtime error condition.
A general reql error
simple-error.
(quote "")
:msg
This slot is read-only.
The query class holds the state of a query, as well as the future that will be finished when the query returns results.
dispatch.
(setf cursor-current-result).
cursor-current-result.
(setf cursor-debug).
cursor-debug.
(setf cursor-future).
cursor-future.
(setf cursor-last-change).
cursor-last-change.
(setf cursor-results).
(setf cursor-results).
cursor-results.
(setf cursor-state).
(setf cursor-state).
cursor-state.
(setf cursor-token).
cursor-token.
Describes the current state of the query (new, complete, etc).
:new
:state
Holds the future that will be finished with the results from this query.
:future
Holds the token for this query.
:token
Tracks the last time the query changed state.
0
Holds the current result set from the query.
Tracks which record the cursor points to.
0
Holds freeform debug info for this cursor.
common-lisp.
:debug
Tracks all state for the driver.
Holds name -> lambda mappings for our commands.
An empty data set for setting callbacks. Perhaps a cl-async API for this is in order??
Used to track lambda variables in functions.
Wraps creation of commands.
Allow storing of arbitrary data with a socket.
Determine if the given object is an alist.
Call a command by name.
Makes sure all DATA (not command) arrays are wrapped in a make-array cmd.
Handle pseudotypes.
Close the given socket.
Create a connection to the given host/port, and optionally db.
Make sure a connection to the DB was successful.
Make sure a socket that just had query data sent over it is ready to handle the response.
Returns ’unique’ variable ’names’ for ’anonymous’ ’functions’ ;) ;) if you know what I mean heh heh ;) ;) ;).
Generates a new token value for a query.
Grab a cursor associated with a token. Returns nil if no cursor exists for that token
This function returns a closure that can be called multiple times with data from a RethinkDB response. If a full response is received (over one or more calls) it returns the *full byte array of the response*, otherwise nil.
Note that the response chunks MUST be passed in in the order received.
Continue a query.
Given a full response byte array, parse it, find the attached cursor (by token), and either resolve/reject the cursor’s promise with the return of the query.
Remove a cursor/token from state tracking.
Associate a cursor with a token. Retrievable through get-cursor.
Turn a query into a byte array.
Wraps setting socket callbacks.
Send data on a rethinkdb connection.
connection-options)) ¶automatically generated reader method
kv.
connection-options)) ¶automatically generated writer method
kv.
connect-error)) ¶msg.
cursor-error)) ¶cursor-error)) ¶query-error)) ¶query-error)) ¶query-error)) ¶reql-error)) ¶msg.
A general connection error condition.
simple-error.
(quote "")
:msg
This slot is read-only.
Holds per-connection options.
:kv
Describes a REQL command.
| Jump to: | !
%
&
(
*
+
-
/
<
=
>
~
∅
A B C D E F G H I J K L M N O P Q R S T U V W Y Z |
|---|
| Jump to: | !
%
&
(
*
+
-
/
<
=
>
~
∅
A B C D E F G H I J K L M N O P Q R S T U V W Y Z |
|---|
| Jump to: | *
+
A B C D F K L M N O Q R S T |
|---|
| Jump to: | *
+
A B C D F K L M N O Q R S T |
|---|
| Jump to: | A C D F M P Q R S T U |
|---|
| Jump to: | A C D F M P Q R S T U |
|---|