The cl-rethinkdb Reference Manual

This is the cl-rethinkdb Reference Manual, version 0.6.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Jan 15 05:22:32 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 cl-rethinkdb

A RethinkDB driver for Common Lisp

Author

Andrew Danger Lyon <>

License

MIT

Version

0.6.7

Dependencies
  • 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).
Source

cl-rethinkdb.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 cl-rethinkdb/reql

Dependency

config.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 cl-rethinkdb/cl-rethinkdb.asd

Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

ASDF Systems

cl-rethinkdb.


4.1.2 cl-rethinkdb/util.lisp

Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

Packages

cl-rethinkdb-util.

Public Interface

4.1.3 cl-rethinkdb/package.lisp

Dependency

util.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

Packages

4.1.4 cl-rethinkdb/config.lisp

Dependency

package.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

Public Interface

4.1.5 cl-rethinkdb/protocol.lisp

Dependency

package.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

Internals

4.1.6 cl-rethinkdb/reql/types.lisp

Source

cl-rethinkdb.asd.

Parent Component

reql (module).

Internals

4.1.7 cl-rethinkdb/reql/function.lisp

Dependency

types.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

reql (module).

Public Interface

fn (macro).

Internals

4.1.8 cl-rethinkdb/reql/commands.lisp

Dependency

function.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

reql (module).

Public Interface
Internals

4.1.9 cl-rethinkdb/reql/dsl.lisp

Dependency

commands.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

reql (module).

Public Interface

r (macro).


4.1.10 cl-rethinkdb/reql/pseudotypes.lisp

Dependency

dsl.lisp (file).

Source

cl-rethinkdb.asd.

Parent Component

reql (module).

Public Interface
Internals

4.1.11 cl-rethinkdb/connection.lisp

Dependencies
Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

Internals

4.1.12 cl-rethinkdb/query.lisp

Dependencies
Source

cl-rethinkdb.asd.

Parent Component

cl-rethinkdb (system).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 cl-rethinkdb-reql

Source

package.lisp.

Nickname

reql

Use List
Used By List

cl-rethinkdb.

Public Interface
Internals

5.2 cl-rethinkdb

Source

package.lisp.

Nickname

r

Use List
Public Interface
Internals

5.3 cl-rethinkdb-util

Source

util.lisp.

Use List
  • blackbird.
  • common-lisp.
Used By List
Public Interface

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Special variables

Special Variable: *object-type*

Defines whether data returned as an object should be an :alist or :hash.

Package

cl-rethinkdb.

Source

config.lisp.

Special Variable: *sequence-type*

Defines whether data returned as a sequence should be a :list or :array.

Package

cl-rethinkdb.

Source

config.lisp.

Special Variable: *state*

Holds all tracking state for the RethinkDB driver.

Package

cl-rethinkdb.

Source

query.lisp.


6.1.2 Macros

Macro: do-hash/alist (((bind-key bind-val) hash/alist) &body body)

Generifies looping over a hash table or alist.

Package

cl-rethinkdb-util.

Source

util.lisp.

Macro: do-list/vector ((bind-val list/vector) &body body)

Generifies looping over a list OR vector.

Package

cl-rethinkdb-util.

Source

util.lisp.

Macro: fn (args &body body)

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’.

Package

cl-rethinkdb-reql.

Source

function.lisp.

Macro: r (&body query-form)

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.

Package

cl-rethinkdb-reql.

Source

dsl.lisp.


6.1.3 Ordinary functions

Function: connect (host port &key db use-outdated noreply profile read-timeout auth)

Connect to a RethinkDB database, optionally specifying the database.

Package

cl-rethinkdb.

Source

query.lisp.

Function: convert-pseudotypes-recursive (obj)

Recursively handle RethinkDB’s pseudotypes in returned objects.

Package

cl-rethinkdb-reql.

Source

pseudotypes.lisp.

Function: cursorp (cursor)

Determine if the given object is a cursor.

Package

cl-rethinkdb.

Source

query.lisp.

Function: disconnect (sock)

Disconnect a RethinkDB connection.

Package

cl-rethinkdb.

Source

query.lisp.

Function: each (sock cursor function)

Call the given function on every result in the given cursor.

Package

cl-rethinkdb.

Source

query.lisp.

Function: endian (number num-bytes)

Convert a number into N bytes little endian.

Package

cl-rethinkdb-util.

Source

util.lisp.

Function: has-next (cursor)

Determine if a cursor has more results.

Package

cl-rethinkdb.

Source

query.lisp.

Function: jprint (obj &optional stream)
Package

cl-rethinkdb-util.

Source

util.lisp.

Function: next (sock cursor)

Grab the next result from a cursor. Always returns a future since it may have to get more results from the server.

Package

cl-rethinkdb.

Source

query.lisp.

Function: run (sock query-form)

This function runs the given query, and returns a future that’s finished when the query response comes in.

Package

cl-rethinkdb.

Source

query.lisp.

Function: stop (sock cursor)

Cleanup a cursor both locally and in the database. Returns a future that is finished with *no values* once the stop operation has completed.

Package

cl-rethinkdb.

Source

query.lisp.

Function: stop/disconnect (sock cursor)

Call stop on a cursor and disconnect the passed socket.

Package

cl-rethinkdb.

Source

query.lisp.

Function: to-array (sock cursor)

Grab ALL results from a cursor. Returns a future finished with the final array.

Package

cl-rethinkdb.

Source

query.lisp.

Function: to-sequence (sock cursor)

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*)

Package

cl-rethinkdb.

Source

query.lisp.

Function: unendian (bytes num-bytes &key offset)

Turns N number of bytes at offset in bytes into an integer.

Package

cl-rethinkdb-util.

Source

util.lisp.

Function: wait-complete (sock)

Wait for noreply => t queries to come back LOL.

Package

cl-rethinkdb.

Source

query.lisp.


6.1.4 Generic functions

Generic Reader: query-error-msg (condition)
Package

cl-rethinkdb.

Methods
Reader Method: query-error-msg ((condition query-error))
Source

query.lisp.

Target Slot

msg.


6.1.5 Standalone methods

Method: %to-json ((cmd reql-cmd))
Package

jonathan.encode.

Source

commands.lisp.

Method: make-load-form ((cmd reql-cmd) &optional env)
Source

commands.lisp.

Method: print-object ((cmd reql-cmd) s)
Source

commands.lisp.

Method: print-object ((state state) s)
Source

query.lisp.


6.1.6 Conditions

Condition: cursor-error

Describes a general query error.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

simple-error.

Direct subclasses
Direct methods
Direct slots
Slot: token
Initform

(quote nil)

Initargs

:token

Readers

cursor-error-token.

Writers

This slot is read-only.

Slot: cursor
Initform

(quote nil)

Initargs

:cursor

Readers

cursor-error-cursor.

Writers

This slot is read-only.

Condition: cursor-no-more-results

Thrown when a cursor has no more results on it.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

cursor-error.

Condition: cursor-overshot

Thrown when a cursor has no more results on it.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

cursor-error.

Condition: cursor-stopped

Thrown when a cursor that has a pending operation is stopped.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

cursor-error.

Condition: query-client-error

A client error condition.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

query-error.

Condition: query-compile-error

A query compile error condition.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

query-error.

Condition: query-error

A general query failure condition.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

simple-error.

Direct subclasses
Direct methods
Direct slots
Slot: token
Initform

(quote nil)

Initargs

:token

Readers

query-error-token.

Writers

This slot is read-only.

Slot: query
Initform

(quote nil)

Initargs

:query

Readers

query-error-query.

Writers

This slot is read-only.

Slot: backtrace
Initform

(quote nil)

Initargs

:backtrace

Readers

query-error-backtrace.

Writers

This slot is read-only.

Slot: msg
Initform

(quote "")

Initargs

:msg

Readers

query-error-msg.

Writers

This slot is read-only.

Condition: query-runtime-error

A query runtime error condition.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

query-error.

Condition: reql-error

A general reql error

Package

cl-rethinkdb-reql.

Source

pseudotypes.lisp.

Direct superclasses

simple-error.

Direct methods

reql-error-msg.

Direct slots
Slot: msg
Initform

(quote "")

Initargs

:msg

Readers

reql-error-msg.

Writers

This slot is read-only.


6.1.7 Classes

Class: cursor

The query class holds the state of a query, as well as the future that will be finished when the query returns results.

Package

cl-rethinkdb.

Source

query.lisp.

Direct superclasses

dispatch.

Direct methods
Direct slots
Slot: state

Describes the current state of the query (new, complete, etc).

Initform

:new

Initargs

:state

Readers

cursor-state.

Writers

(setf cursor-state).

Slot: future

Holds the future that will be finished with the results from this query.

Initargs

:future

Readers

cursor-future.

Writers

(setf cursor-future).

Slot: token

Holds the token for this query.

Initargs

:token

Readers

cursor-token.

Writers

(setf cursor-token).

Slot: last-change

Tracks the last time the query changed state.

Initform

0

Readers

cursor-last-change.

Writers

(setf cursor-last-change).

Slot: results

Holds the current result set from the query.

Readers

cursor-results.

Writers

(setf cursor-results).

Slot: current-result

Tracks which record the cursor points to.

Initform

0

Readers

cursor-current-result.

Writers

(setf cursor-current-result).

Slot: debug

Holds freeform debug info for this cursor.

Package

common-lisp.

Initargs

:debug

Readers

cursor-debug.

Writers

(setf cursor-debug).

Class: state

Tracks all state for the driver.

Package

cl-rethinkdb.

Source

query.lisp.

Direct methods
Direct slots
Slot: token
Initform

0

Readers

state-token.

Writers

(setf state-token).

Slot: active-queries
Initform

(make-hash-table :test (function eq))

Readers

active-queries.

Writers

(setf active-queries).


6.2 Internals


6.2.1 Constants

Constant: +datum-type-array+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +datum-type-bool+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +datum-type-json+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +datum-type-null+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +datum-type-num+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +datum-type-object+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +datum-type-str+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +proto-json+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +proto-query-continue+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +proto-query-start+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +proto-query-stop+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +proto-query-wait+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +proto-version+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-atom+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-client-error+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-compile-error+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-feed+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-partial+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-runtime-error+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-sequence+
Package

cl-rethinkdb.

Source

protocol.lisp.

Constant: +rdb-response-wait-complete+
Package

cl-rethinkdb.

Source

protocol.lisp.


6.2.2 Special variables

Special Variable: *commands*

Holds name -> lambda mappings for our commands.

Package

cl-rethinkdb-reql.

Source

commands.lisp.

Special Variable: *empty*

An empty data set for setting callbacks. Perhaps a cl-async API for this is in order??

Package

cl-rethinkdb.

Source

connection.lisp.

Special Variable: *varnum*

Used to track lambda variables in functions.

Package

cl-rethinkdb-reql.

Source

function.lisp.


6.2.3 Macros

Macro: defcommand ((termval name &key defun) all-args &key docstr arrays)

Wraps creation of commands.

Package

cl-rethinkdb-reql.

Source

commands.lisp.

Macro: socket-data (socket)

Allow storing of arbitrary data with a socket.

Package

cl-rethinkdb.

Source

connection.lisp.

Macro: with-query ((sock cursor token query state &key reject-on-stop) resolve reject)
Package

cl-rethinkdb.

Source

query.lisp.


6.2.4 Ordinary functions

Function: (&rest bools)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: != (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: % (number mod)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: && (&rest bools)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: * (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: + (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: - (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: / (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: < (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: <= (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: == (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: > (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: >= (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: alistp (alist)

Determine if the given object is an alist.

Package

cl-rethinkdb-reql.

Source

types.lisp.

Function: append (array object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: april ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: args (array)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: asc (string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: attr (object key)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: august ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: avg (sequence field/function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: between (stream left right &key index right-bound left-bound)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: between-dep (stream left right &key index right-bound left-bound)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: binary (base64-string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: bracket (sequence/object number/string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: branch (bool true-expr false-expr)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: call (fn &rest all-args)

Call a command by name.

Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: change-at (array index object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: changes (table &key squash include-states)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: circle (geo radius &key num-vertices geo-system unit fill)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: cmd-arg (x)

Makes sure all DATA (not command) arrays are wrapped in a make-array cmd.

Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: coerce-to (val string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: concat-map (sequence function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: config (db/table)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: contains (sequence object/function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: convert-pseudotypes (obj)

Handle pseudotypes.

Package

cl-rethinkdb-reql.

Source

pseudotypes.lisp.

Function: count (sequence)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: date (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: day (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: day-of-week (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: day-of-year (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: db (dbname)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: db-create (name)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: db-drop (name)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: db-list ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: december ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: default (object default)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: delete (selection &key durability return-changes)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: delete-at (array index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: desc (string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: difference (array1 array2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: distance (geo-from geo-to &key geo-system unit)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: distinct (sequence &key index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: do (function &rest args)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: do-close (sock)

Close the given socket.

Package

cl-rethinkdb.

Source

connection.lisp.

Function: do-connect (host port &key read-timeout)

Create a connection to the given host/port, and optionally db.

Package

cl-rethinkdb.

Source

connection.lisp.

Function: downcase (string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: during (time start end)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: epoch-time (number)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: eq-join (sequence1 field sequence2 &key index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: error (errstr)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: expr (lisp-obj)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: february ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: fill (geo)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: filter (sequence function &key default)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: finalize-connect (sock)

Make sure a connection to the DB was successful.

Package

cl-rethinkdb.

Source

connection.lisp.

Function: finalize-query (sock)

Make sure a socket that just had query data sent over it is ready to handle the response.

Package

cl-rethinkdb.

Source

connection.lisp.

Function: for-each (sequence function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: friday ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: func (args body)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: generate-fn-var ()

Returns ’unique’ variable ’names’ for ’anonymous’ ’functions’ ;) ;) if you know what I mean heh heh ;) ;) ;).

Package

cl-rethinkdb-reql.

Source

function.lisp.

Function: generate-token (&key state)

Generates a new token value for a query.

Package

cl-rethinkdb.

Source

query.lisp.

Function: geojson (object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: get (table id)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: get-all (table ids &key index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: get-cursor (token &key state)

Grab a cursor associated with a token. Returns nil if no cursor exists for that token

Package

cl-rethinkdb.

Source

query.lisp.

Function: get-intersecting (table geo &key index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: get-nearest (table geo &key index max-results max-dist geo-system unit)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: group (sequence field/function &key index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: has-fields (object &rest pathspec)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: hours (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: http (url &key data timeout method params header attemps redirects verify page page-limit auth result-format)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: in-timezone (time string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: includes (geo1 geo2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: index-create (table name function &key multi geo)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: index-drop (table name)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: index-list (table)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: index-rename (table from to &key overwrite)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: index-status (table &rest names)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: index-wait (table &rest names)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: info (object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: inner-join (sequence1 sequence2 function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: insert (table object &key conflict durability return-changes)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: insert-at (array index val)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: intersects (geo1 geo2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: is-empty (sequence)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: iso8601 (string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: january ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: javascript (string &key timeout)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: json (string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: json-to-response (json)
Package

cl-rethinkdb.

Source

query.lisp.

Function: july ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: june ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: keys (object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: limit (sequence number)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: line (&rest array/geo)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: literal (object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: make-array (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: make-obj (hash)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: make-response-handler ()

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.

Package

cl-rethinkdb.

Source

query.lisp.

Function: map (sequence function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: march ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: match (string regex)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: max (sequence field/function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: maxval ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: may ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: merge (&rest objects)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: min (sequence field/function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: minutes (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: minval ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: monday ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: month (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: more (sock token)

Continue a query.

Package

cl-rethinkdb.

Source

query.lisp.

Function: november ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: now ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: nth (sequence index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: object (&rest pairs)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: october ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: offsets-of (sequence object/function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: order-by (sequence fields &key index)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: outer-join (sequence1 sequence2 function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: parse-response (response-bytes)

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.

Package

cl-rethinkdb.

Source

query.lisp.

Function: pluck (sequence &rest pathspec)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: point (lat long)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: polygon (&rest array/geo)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: polygon-sub (geo1 geo2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: prepend (array object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: random (lower-bound upper-bound &key float)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: range (lower upper)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: rebalance (db/table)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: reconfigure (db/table &key shards replicas primary-replica-tag dry-run)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: reduce (sequence function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: remove-cursor (cursor &key state)

Remove a cursor/token from state tracking.

Package

cl-rethinkdb.

Source

query.lisp.

Function: replace (selection function &key non-atomic durability return-changes)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: row ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: sample (sequence number)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: saturday ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: save-cursor (token cursor &key state)

Associate a cursor with a token. Retrievable through get-cursor.

Package

cl-rethinkdb.

Source

query.lisp.

Function: seconds (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: september ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: serialize-query (query)

Turn a query into a byte array.

Package

cl-rethinkdb.

Source

query.lisp.

Function: set-callbacks (sock &key read-cb write-cb event-cb)

Wraps setting socket callbacks.

Package

cl-rethinkdb.

Source

connection.lisp.

Function: set-difference (array1 array2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: set-insert (array object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: set-intersection (array1 array2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: set-union (array1 array2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: skip (sequence number)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: slice (sequence start end)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: sock-write (sock bytes)

Send data on a rethinkdb connection.

Package

cl-rethinkdb.

Source

connection.lisp.

Function: splice-at (array1 index array2)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: split (string &rest args)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: status (table)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: sum (sequence field/function)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: sunday ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: sync (table)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: table (db tablename &key read-mode identifier-format)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: table-create (db name &key primary-key shards replicas primary-replica-tag)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: table-drop (db name)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: table-list (db)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: thursday ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: time (year month day hour minute second timezone)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: time-of-day (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: timezone (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: to-epoch-time (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: to-geojson (geo)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: to-iso8601 (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: to-json-string (object)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: tuesday ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: type-of (val)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: ungroup (grouped)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: union (&rest sequences)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: upcase (string)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: update (selection object/function &key non-atomic durability return-changes)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: uuid ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: var (varnumber)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: wait (db/table)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: wednesday ()
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: with-fields (sequence &rest pathspec)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: without (sequence &rest pathspec)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: year (time)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: zip (sequence)
Package

cl-rethinkdb-reql.

Source

commands.lisp.

Function: ~ (bool)
Package

cl-rethinkdb-reql.

Source

commands.lisp.


6.2.5 Generic functions

Generic Reader: active-queries (object)
Package

cl-rethinkdb.

Methods
Reader Method: active-queries ((state state))

automatically generated reader method

Source

query.lisp.

Target Slot

active-queries.

Generic Writer: (setf active-queries) (object)
Package

cl-rethinkdb.

Methods
Writer Method: (setf active-queries) ((state state))

automatically generated writer method

Source

query.lisp.

Target Slot

active-queries.

Generic Reader: cmd-args (object)
Package

cl-rethinkdb-reql.

Methods
Reader Method: cmd-args ((reql-cmd reql-cmd))

automatically generated reader method

Source

commands.lisp.

Target Slot

args.

Generic Writer: (setf cmd-args) (object)
Package

cl-rethinkdb-reql.

Methods
Writer Method: (setf cmd-args) ((reql-cmd reql-cmd))

automatically generated writer method

Source

commands.lisp.

Target Slot

args.

Generic Reader: cmd-name (object)
Package

cl-rethinkdb-reql.

Methods
Reader Method: cmd-name ((reql-cmd reql-cmd))

automatically generated reader method

Source

commands.lisp.

Target Slot

name.

Generic Writer: (setf cmd-name) (object)
Package

cl-rethinkdb-reql.

Methods
Writer Method: (setf cmd-name) ((reql-cmd reql-cmd))

automatically generated writer method

Source

commands.lisp.

Target Slot

name.

Generic Reader: cmd-op (object)
Package

cl-rethinkdb-reql.

Methods
Reader Method: cmd-op ((reql-cmd reql-cmd))

automatically generated reader method

Source

commands.lisp.

Target Slot

op.

Generic Writer: (setf cmd-op) (object)
Package

cl-rethinkdb-reql.

Methods
Writer Method: (setf cmd-op) ((reql-cmd reql-cmd))

automatically generated writer method

Source

commands.lisp.

Target Slot

op.

Generic Reader: cmd-options (object)
Package

cl-rethinkdb-reql.

Methods
Reader Method: cmd-options ((reql-cmd reql-cmd))

automatically generated reader method

Source

commands.lisp.

Target Slot

options.

Generic Writer: (setf cmd-options) (object)
Package

cl-rethinkdb-reql.

Methods
Writer Method: (setf cmd-options) ((reql-cmd reql-cmd))

automatically generated writer method

Source

commands.lisp.

Target Slot

options.

Generic Reader: conn-kv (object)
Package

cl-rethinkdb.

Methods
Reader Method: conn-kv ((connection-options connection-options))

automatically generated reader method

Source

query.lisp.

Target Slot

kv.

Generic Writer: (setf conn-kv) (object)
Package

cl-rethinkdb.

Methods
Writer Method: (setf conn-kv) ((connection-options connection-options))

automatically generated writer method

Source

query.lisp.

Target Slot

kv.

Generic Reader: connect-error-msg (condition)
Package

cl-rethinkdb.

Methods
Reader Method: connect-error-msg ((condition connect-error))
Source

connection.lisp.

Target Slot

msg.

Generic Reader: cursor-current-result (object)
Generic Writer: (setf cursor-current-result) (object)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-current-result ((cursor cursor))
Writer Method: (setf cursor-current-result) ((cursor cursor))

Tracks which record the cursor points to.

Source

query.lisp.

Target Slot

current-result.

Generic Reader: cursor-debug (object)
Generic Writer: (setf cursor-debug) (object)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-debug ((cursor cursor))
Writer Method: (setf cursor-debug) ((cursor cursor))

Holds freeform debug info for this cursor.

Source

query.lisp.

Target Slot

debug.

Generic Reader: cursor-error-cursor (condition)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-error-cursor ((condition cursor-error))
Source

query.lisp.

Target Slot

cursor.

Generic Reader: cursor-error-token (condition)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-error-token ((condition cursor-error))
Source

query.lisp.

Target Slot

token.

Generic Reader: cursor-future (object)
Generic Writer: (setf cursor-future) (object)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-future ((cursor cursor))
Writer Method: (setf cursor-future) ((cursor cursor))

Holds the future that will be finished with the results from this query.

Source

query.lisp.

Target Slot

future.

Generic Reader: cursor-last-change (object)
Generic Writer: (setf cursor-last-change) (object)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-last-change ((cursor cursor))
Writer Method: (setf cursor-last-change) ((cursor cursor))

Tracks the last time the query changed state.

Source

query.lisp.

Target Slot

last-change.

Generic Reader: cursor-results (object)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-results ((cursor cursor))

Holds the current result set from the query.

Source

query.lisp.

Target Slot

results.

Generic Function: (setf cursor-results) (object)
Package

cl-rethinkdb.

Methods
Writer Method: (setf cursor-results) :after ((cursor cursor))

Make sure to reset the curr-result pointer when setting in new results.

Source

query.lisp.

Target Slot

results.

Method: (setf cursor-results) ((cursor cursor))

Holds the current result set from the query.

Source

query.lisp.

Generic Reader: cursor-state (object)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-state ((cursor cursor))

Describes the current state of the query (new, complete, etc).

Source

query.lisp.

Target Slot

state.

Generic Function: (setf cursor-state) (object)
Package

cl-rethinkdb.

Methods
Writer Method: (setf cursor-state) :after ((cursor cursor))

Track whenever the state changes in a query.

Source

query.lisp.

Target Slot

state.

Method: (setf cursor-state) ((cursor cursor))

Describes the current state of the query (new, complete, etc).

Source

query.lisp.

Generic Reader: cursor-token (object)
Generic Writer: (setf cursor-token) (object)
Package

cl-rethinkdb.

Methods
Reader Method: cursor-token ((cursor cursor))
Writer Method: (setf cursor-token) ((cursor cursor))

Holds the token for this query.

Source

query.lisp.

Target Slot

token.

Generic Reader: query-error-backtrace (condition)
Package

cl-rethinkdb.

Methods
Reader Method: query-error-backtrace ((condition query-error))
Source

query.lisp.

Target Slot

backtrace.

Generic Reader: query-error-query (condition)
Package

cl-rethinkdb.

Methods
Reader Method: query-error-query ((condition query-error))
Source

query.lisp.

Target Slot

query.

Generic Reader: query-error-token (condition)
Package

cl-rethinkdb.

Methods
Reader Method: query-error-token ((condition query-error))
Source

query.lisp.

Target Slot

token.

Generic Reader: reql-error-msg (condition)
Package

cl-rethinkdb-reql.

Methods
Reader Method: reql-error-msg ((condition reql-error))
Source

pseudotypes.lisp.

Target Slot

msg.

Generic Reader: state-token (object)
Package

cl-rethinkdb.

Methods
Reader Method: state-token ((state state))

automatically generated reader method

Source

query.lisp.

Target Slot

token.

Generic Writer: (setf state-token) (object)
Package

cl-rethinkdb.

Methods
Writer Method: (setf state-token) ((state state))

automatically generated writer method

Source

query.lisp.

Target Slot

token.


6.2.6 Conditions

Condition: connect-error

A general connection error condition.

Package

cl-rethinkdb.

Source

connection.lisp.

Direct superclasses

simple-error.

Direct methods

connect-error-msg.

Direct slots
Slot: msg
Initform

(quote "")

Initargs

:msg

Readers

connect-error-msg.

Writers

This slot is read-only.


6.2.7 Classes

Class: connection-options

Holds per-connection options.

Package

cl-rethinkdb.

Source

query.lisp.

Direct methods
Direct slots
Slot: kv
Initargs

:kv

Readers

conn-kv.

Writers

(setf conn-kv).

Class: reql-cmd

Describes a REQL command.

Package

cl-rethinkdb-reql.

Source

commands.lisp.

Direct methods
Direct slots
Slot: name
Initform

""

Initargs

:name

Readers

cmd-name.

Writers

(setf cmd-name).

Slot: op
Initform

0

Initargs

:op

Readers

cmd-op.

Writers

(setf cmd-op).

Slot: args
Initargs

:args

Readers

cmd-args.

Writers

(setf cmd-args).

Slot: options
Initform

(cl-hash-util:hash)

Initargs

:options

Readers

cmd-options.

Writers

(setf cmd-options).


6.2.8 Types

Type: alist ()
Package

cl-rethinkdb-reql.

Source

types.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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  
Index Entry  Section

!
!=: Private ordinary functions

%
%: Private ordinary functions
%to-json: Public standalone methods

&
&&: Private ordinary functions

(
(setf active-queries): Private generic functions
(setf active-queries): Private generic functions
(setf cmd-args): Private generic functions
(setf cmd-args): Private generic functions
(setf cmd-name): Private generic functions
(setf cmd-name): Private generic functions
(setf cmd-op): Private generic functions
(setf cmd-op): Private generic functions
(setf cmd-options): Private generic functions
(setf cmd-options): Private generic functions
(setf conn-kv): Private generic functions
(setf conn-kv): Private generic functions
(setf cursor-current-result): Private generic functions
(setf cursor-current-result): Private generic functions
(setf cursor-debug): Private generic functions
(setf cursor-debug): Private generic functions
(setf cursor-future): Private generic functions
(setf cursor-future): Private generic functions
(setf cursor-last-change): Private generic functions
(setf cursor-last-change): Private generic functions
(setf cursor-results): Private generic functions
(setf cursor-results): Private generic functions
(setf cursor-results): Private generic functions
(setf cursor-state): Private generic functions
(setf cursor-state): Private generic functions
(setf cursor-state): Private generic functions
(setf cursor-token): Private generic functions
(setf cursor-token): Private generic functions
(setf state-token): Private generic functions
(setf state-token): Private generic functions

*
*: Private ordinary functions

+
+: Private ordinary functions

-
-: Private ordinary functions

/
/: Private ordinary functions

<
<: Private ordinary functions
<=: Private ordinary functions

=
==: Private ordinary functions

>
>: Private ordinary functions
>=: Private ordinary functions

~
~: Private ordinary functions

: Private ordinary functions

A
active-queries: Private generic functions
active-queries: Private generic functions
alistp: Private ordinary functions
append: Private ordinary functions
april: Private ordinary functions
args: Private ordinary functions
asc: Private ordinary functions
attr: Private ordinary functions
august: Private ordinary functions
avg: Private ordinary functions

B
between: Private ordinary functions
between-dep: Private ordinary functions
binary: Private ordinary functions
bracket: Private ordinary functions
branch: Private ordinary functions

C
call: Private ordinary functions
change-at: Private ordinary functions
changes: Private ordinary functions
circle: Private ordinary functions
cmd-arg: Private ordinary functions
cmd-args: Private generic functions
cmd-args: Private generic functions
cmd-name: Private generic functions
cmd-name: Private generic functions
cmd-op: Private generic functions
cmd-op: Private generic functions
cmd-options: Private generic functions
cmd-options: Private generic functions
coerce-to: Private ordinary functions
concat-map: Private ordinary functions
config: Private ordinary functions
conn-kv: Private generic functions
conn-kv: Private generic functions
connect: Public ordinary functions
connect-error-msg: Private generic functions
connect-error-msg: Private generic functions
contains: Private ordinary functions
convert-pseudotypes: Private ordinary functions
convert-pseudotypes-recursive: Public ordinary functions
count: Private ordinary functions
cursor-current-result: Private generic functions
cursor-current-result: Private generic functions
cursor-debug: Private generic functions
cursor-debug: Private generic functions
cursor-error-cursor: Private generic functions
cursor-error-cursor: Private generic functions
cursor-error-token: Private generic functions
cursor-error-token: Private generic functions
cursor-future: Private generic functions
cursor-future: Private generic functions
cursor-last-change: Private generic functions
cursor-last-change: Private generic functions
cursor-results: Private generic functions
cursor-results: Private generic functions
cursor-state: Private generic functions
cursor-state: Private generic functions
cursor-token: Private generic functions
cursor-token: Private generic functions
cursorp: Public ordinary functions

D
date: Private ordinary functions
day: Private ordinary functions
day-of-week: Private ordinary functions
day-of-year: Private ordinary functions
db: Private ordinary functions
db-create: Private ordinary functions
db-drop: Private ordinary functions
db-list: Private ordinary functions
december: Private ordinary functions
default: Private ordinary functions
defcommand: Private macros
delete: Private ordinary functions
delete-at: Private ordinary functions
desc: Private ordinary functions
difference: Private ordinary functions
disconnect: Public ordinary functions
distance: Private ordinary functions
distinct: Private ordinary functions
do: Private ordinary functions
do-close: Private ordinary functions
do-connect: Private ordinary functions
do-hash/alist: Public macros
do-list/vector: Public macros
downcase: Private ordinary functions
during: Private ordinary functions

E
each: Public ordinary functions
endian: Public ordinary functions
epoch-time: Private ordinary functions
eq-join: Private ordinary functions
error: Private ordinary functions
expr: Private ordinary functions

F
february: Private ordinary functions
fill: Private ordinary functions
filter: Private ordinary functions
finalize-connect: Private ordinary functions
finalize-query: Private ordinary functions
fn: Public macros
for-each: Private ordinary functions
friday: Private ordinary functions
func: Private ordinary functions
Function, !=: Private ordinary functions
Function, %: Private ordinary functions
Function, &&: Private ordinary functions
Function, *: Private ordinary functions
Function, +: Private ordinary functions
Function, -: Private ordinary functions
Function, /: Private ordinary functions
Function, <: Private ordinary functions
Function, <=: Private ordinary functions
Function, ==: Private ordinary functions
Function, >: Private ordinary functions
Function, >=: Private ordinary functions
Function, alistp: Private ordinary functions
Function, append: Private ordinary functions
Function, april: Private ordinary functions
Function, args: Private ordinary functions
Function, asc: Private ordinary functions
Function, attr: Private ordinary functions
Function, august: Private ordinary functions
Function, avg: Private ordinary functions
Function, between: Private ordinary functions
Function, between-dep: Private ordinary functions
Function, binary: Private ordinary functions
Function, bracket: Private ordinary functions
Function, branch: Private ordinary functions
Function, call: Private ordinary functions
Function, change-at: Private ordinary functions
Function, changes: Private ordinary functions
Function, circle: Private ordinary functions
Function, cmd-arg: Private ordinary functions
Function, coerce-to: Private ordinary functions
Function, concat-map: Private ordinary functions
Function, config: Private ordinary functions
Function, connect: Public ordinary functions
Function, contains: Private ordinary functions
Function, convert-pseudotypes: Private ordinary functions
Function, convert-pseudotypes-recursive: Public ordinary functions
Function, count: Private ordinary functions
Function, cursorp: Public ordinary functions
Function, date: Private ordinary functions
Function, day: Private ordinary functions
Function, day-of-week: Private ordinary functions
Function, day-of-year: Private ordinary functions
Function, db: Private ordinary functions
Function, db-create: Private ordinary functions
Function, db-drop: Private ordinary functions
Function, db-list: Private ordinary functions
Function, december: Private ordinary functions
Function, default: Private ordinary functions
Function, delete: Private ordinary functions
Function, delete-at: Private ordinary functions
Function, desc: Private ordinary functions
Function, difference: Private ordinary functions
Function, disconnect: Public ordinary functions
Function, distance: Private ordinary functions
Function, distinct: Private ordinary functions
Function, do: Private ordinary functions
Function, do-close: Private ordinary functions
Function, do-connect: Private ordinary functions
Function, downcase: Private ordinary functions
Function, during: Private ordinary functions
Function, each: Public ordinary functions
Function, endian: Public ordinary functions
Function, epoch-time: Private ordinary functions
Function, eq-join: Private ordinary functions
Function, error: Private ordinary functions
Function, expr: Private ordinary functions
Function, february: Private ordinary functions
Function, fill: Private ordinary functions
Function, filter: Private ordinary functions
Function, finalize-connect: Private ordinary functions
Function, finalize-query: Private ordinary functions
Function, for-each: Private ordinary functions
Function, friday: Private ordinary functions
Function, func: Private ordinary functions
Function, generate-fn-var: Private ordinary functions
Function, generate-token: Private ordinary functions
Function, geojson: Private ordinary functions
Function, get: Private ordinary functions
Function, get-all: Private ordinary functions
Function, get-cursor: Private ordinary functions
Function, get-intersecting: Private ordinary functions
Function, get-nearest: Private ordinary functions
Function, group: Private ordinary functions
Function, has-fields: Private ordinary functions
Function, has-next: Public ordinary functions
Function, hours: Private ordinary functions
Function, http: Private ordinary functions
Function, in-timezone: Private ordinary functions
Function, includes: Private ordinary functions
Function, index-create: Private ordinary functions
Function, index-drop: Private ordinary functions
Function, index-list: Private ordinary functions
Function, index-rename: Private ordinary functions
Function, index-status: Private ordinary functions
Function, index-wait: Private ordinary functions
Function, info: Private ordinary functions
Function, inner-join: Private ordinary functions
Function, insert: Private ordinary functions
Function, insert-at: Private ordinary functions
Function, intersects: Private ordinary functions
Function, is-empty: Private ordinary functions
Function, iso8601: Private ordinary functions
Function, january: Private ordinary functions
Function, javascript: Private ordinary functions
Function, jprint: Public ordinary functions
Function, json: Private ordinary functions
Function, json-to-response: Private ordinary functions
Function, july: Private ordinary functions
Function, june: Private ordinary functions
Function, keys: Private ordinary functions
Function, limit: Private ordinary functions
Function, line: Private ordinary functions
Function, literal: Private ordinary functions
Function, make-array: Private ordinary functions
Function, make-obj: Private ordinary functions
Function, make-response-handler: Private ordinary functions
Function, map: Private ordinary functions
Function, march: Private ordinary functions
Function, match: Private ordinary functions
Function, max: Private ordinary functions
Function, maxval: Private ordinary functions
Function, may: Private ordinary functions
Function, merge: Private ordinary functions
Function, min: Private ordinary functions
Function, minutes: Private ordinary functions
Function, minval: Private ordinary functions
Function, monday: Private ordinary functions
Function, month: Private ordinary functions
Function, more: Private ordinary functions
Function, next: Public ordinary functions
Function, november: Private ordinary functions
Function, now: Private ordinary functions
Function, nth: Private ordinary functions
Function, object: Private ordinary functions
Function, october: Private ordinary functions
Function, offsets-of: Private ordinary functions
Function, order-by: Private ordinary functions
Function, outer-join: Private ordinary functions
Function, parse-response: Private ordinary functions
Function, pluck: Private ordinary functions
Function, point: Private ordinary functions
Function, polygon: Private ordinary functions
Function, polygon-sub: Private ordinary functions
Function, prepend: Private ordinary functions
Function, random: Private ordinary functions
Function, range: Private ordinary functions
Function, rebalance: Private ordinary functions
Function, reconfigure: Private ordinary functions
Function, reduce: Private ordinary functions
Function, remove-cursor: Private ordinary functions
Function, replace: Private ordinary functions
Function, row: Private ordinary functions
Function, run: Public ordinary functions
Function, sample: Private ordinary functions
Function, saturday: Private ordinary functions
Function, save-cursor: Private ordinary functions
Function, seconds: Private ordinary functions
Function, september: Private ordinary functions
Function, serialize-query: Private ordinary functions
Function, set-callbacks: Private ordinary functions
Function, set-difference: Private ordinary functions
Function, set-insert: Private ordinary functions
Function, set-intersection: Private ordinary functions
Function, set-union: Private ordinary functions
Function, skip: Private ordinary functions
Function, slice: Private ordinary functions
Function, sock-write: Private ordinary functions
Function, splice-at: Private ordinary functions
Function, split: Private ordinary functions
Function, status: Private ordinary functions
Function, stop: Public ordinary functions
Function, stop/disconnect: Public ordinary functions
Function, sum: Private ordinary functions
Function, sunday: Private ordinary functions
Function, sync: Private ordinary functions
Function, table: Private ordinary functions
Function, table-create: Private ordinary functions
Function, table-drop: Private ordinary functions
Function, table-list: Private ordinary functions
Function, thursday: Private ordinary functions
Function, time: Private ordinary functions
Function, time-of-day: Private ordinary functions
Function, timezone: Private ordinary functions
Function, to-array: Public ordinary functions
Function, to-epoch-time: Private ordinary functions
Function, to-geojson: Private ordinary functions
Function, to-iso8601: Private ordinary functions
Function, to-json-string: Private ordinary functions
Function, to-sequence: Public ordinary functions
Function, tuesday: Private ordinary functions
Function, type-of: Private ordinary functions
Function, unendian: Public ordinary functions
Function, ungroup: Private ordinary functions
Function, union: Private ordinary functions
Function, upcase: Private ordinary functions
Function, update: Private ordinary functions
Function, uuid: Private ordinary functions
Function, var: Private ordinary functions
Function, wait: Private ordinary functions
Function, wait-complete: Public ordinary functions
Function, wednesday: Private ordinary functions
Function, with-fields: Private ordinary functions
Function, without: Private ordinary functions
Function, year: Private ordinary functions
Function, zip: Private ordinary functions
Function, ~: Private ordinary functions
Function, : Private ordinary functions

G
generate-fn-var: Private ordinary functions
generate-token: Private ordinary functions
Generic Function, (setf active-queries): Private generic functions
Generic Function, (setf cmd-args): Private generic functions
Generic Function, (setf cmd-name): Private generic functions
Generic Function, (setf cmd-op): Private generic functions
Generic Function, (setf cmd-options): Private generic functions
Generic Function, (setf conn-kv): Private generic functions
Generic Function, (setf cursor-current-result): Private generic functions
Generic Function, (setf cursor-debug): Private generic functions
Generic Function, (setf cursor-future): Private generic functions
Generic Function, (setf cursor-last-change): Private generic functions
Generic Function, (setf cursor-results): Private generic functions
Generic Function, (setf cursor-state): Private generic functions
Generic Function, (setf cursor-token): Private generic functions
Generic Function, (setf state-token): Private generic functions
Generic Function, active-queries: Private generic functions
Generic Function, cmd-args: Private generic functions
Generic Function, cmd-name: Private generic functions
Generic Function, cmd-op: Private generic functions
Generic Function, cmd-options: Private generic functions
Generic Function, conn-kv: Private generic functions
Generic Function, connect-error-msg: Private generic functions
Generic Function, cursor-current-result: Private generic functions
Generic Function, cursor-debug: Private generic functions
Generic Function, cursor-error-cursor: Private generic functions
Generic Function, cursor-error-token: Private generic functions
Generic Function, cursor-future: Private generic functions
Generic Function, cursor-last-change: Private generic functions
Generic Function, cursor-results: Private generic functions
Generic Function, cursor-state: Private generic functions
Generic Function, cursor-token: Private generic functions
Generic Function, query-error-backtrace: Private generic functions
Generic Function, query-error-msg: Public generic functions
Generic Function, query-error-query: Private generic functions
Generic Function, query-error-token: Private generic functions
Generic Function, reql-error-msg: Private generic functions
Generic Function, state-token: Private generic functions
geojson: Private ordinary functions
get: Private ordinary functions
get-all: Private ordinary functions
get-cursor: Private ordinary functions
get-intersecting: Private ordinary functions
get-nearest: Private ordinary functions
group: Private ordinary functions

H
has-fields: Private ordinary functions
has-next: Public ordinary functions
hours: Private ordinary functions
http: Private ordinary functions

I
in-timezone: Private ordinary functions
includes: Private ordinary functions
index-create: Private ordinary functions
index-drop: Private ordinary functions
index-list: Private ordinary functions
index-rename: Private ordinary functions
index-status: Private ordinary functions
index-wait: Private ordinary functions
info: Private ordinary functions
inner-join: Private ordinary functions
insert: Private ordinary functions
insert-at: Private ordinary functions
intersects: Private ordinary functions
is-empty: Private ordinary functions
iso8601: Private ordinary functions

J
january: Private ordinary functions
javascript: Private ordinary functions
jprint: Public ordinary functions
json: Private ordinary functions
json-to-response: Private ordinary functions
july: Private ordinary functions
june: Private ordinary functions

K
keys: Private ordinary functions

L
limit: Private ordinary functions
line: Private ordinary functions
literal: Private ordinary functions

M
Macro, defcommand: Private macros
Macro, do-hash/alist: Public macros
Macro, do-list/vector: Public macros
Macro, fn: Public macros
Macro, r: Public macros
Macro, socket-data: Private macros
Macro, with-query: Private macros
make-array: Private ordinary functions
make-load-form: Public standalone methods
make-obj: Private ordinary functions
make-response-handler: Private ordinary functions
map: Private ordinary functions
march: Private ordinary functions
match: Private ordinary functions
max: Private ordinary functions
maxval: Private ordinary functions
may: Private ordinary functions
merge: Private ordinary functions
Method, %to-json: Public standalone methods
Method, (setf active-queries): Private generic functions
Method, (setf cmd-args): Private generic functions
Method, (setf cmd-name): Private generic functions
Method, (setf cmd-op): Private generic functions
Method, (setf cmd-options): Private generic functions
Method, (setf conn-kv): Private generic functions
Method, (setf cursor-current-result): Private generic functions
Method, (setf cursor-debug): Private generic functions
Method, (setf cursor-future): Private generic functions
Method, (setf cursor-last-change): Private generic functions
Method, (setf cursor-results): Private generic functions
Method, (setf cursor-results): Private generic functions
Method, (setf cursor-state): Private generic functions
Method, (setf cursor-state): Private generic functions
Method, (setf cursor-token): Private generic functions
Method, (setf state-token): Private generic functions
Method, active-queries: Private generic functions
Method, cmd-args: Private generic functions
Method, cmd-name: Private generic functions
Method, cmd-op: Private generic functions
Method, cmd-options: Private generic functions
Method, conn-kv: Private generic functions
Method, connect-error-msg: Private generic functions
Method, cursor-current-result: Private generic functions
Method, cursor-debug: Private generic functions
Method, cursor-error-cursor: Private generic functions
Method, cursor-error-token: Private generic functions
Method, cursor-future: Private generic functions
Method, cursor-last-change: Private generic functions
Method, cursor-results: Private generic functions
Method, cursor-state: Private generic functions
Method, cursor-token: Private generic functions
Method, make-load-form: Public standalone methods
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods
Method, query-error-backtrace: Private generic functions
Method, query-error-msg: Public generic functions
Method, query-error-query: Private generic functions
Method, query-error-token: Private generic functions
Method, reql-error-msg: Private generic functions
Method, state-token: Private generic functions
min: Private ordinary functions
minutes: Private ordinary functions
minval: Private ordinary functions
monday: Private ordinary functions
month: Private ordinary functions
more: Private ordinary functions

N
next: Public ordinary functions
november: Private ordinary functions
now: Private ordinary functions
nth: Private ordinary functions

O
object: Private ordinary functions
october: Private ordinary functions
offsets-of: Private ordinary functions
order-by: Private ordinary functions
outer-join: Private ordinary functions

P
parse-response: Private ordinary functions
pluck: Private ordinary functions
point: Private ordinary functions
polygon: Private ordinary functions
polygon-sub: Private ordinary functions
prepend: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods

Q
query-error-backtrace: Private generic functions
query-error-backtrace: Private generic functions
query-error-msg: Public generic functions
query-error-msg: Public generic functions
query-error-query: Private generic functions
query-error-query: Private generic functions
query-error-token: Private generic functions
query-error-token: Private generic functions

R
r: Public macros
random: Private ordinary functions
range: Private ordinary functions
rebalance: Private ordinary functions
reconfigure: Private ordinary functions
reduce: Private ordinary functions
remove-cursor: Private ordinary functions
replace: Private ordinary functions
reql-error-msg: Private generic functions
reql-error-msg: Private generic functions
row: Private ordinary functions
run: Public ordinary functions

S
sample: Private ordinary functions
saturday: Private ordinary functions
save-cursor: Private ordinary functions
seconds: Private ordinary functions
september: Private ordinary functions
serialize-query: Private ordinary functions
set-callbacks: Private ordinary functions
set-difference: Private ordinary functions
set-insert: Private ordinary functions
set-intersection: Private ordinary functions
set-union: Private ordinary functions
skip: Private ordinary functions
slice: Private ordinary functions
sock-write: Private ordinary functions
socket-data: Private macros
splice-at: Private ordinary functions
split: Private ordinary functions
state-token: Private generic functions
state-token: Private generic functions
status: Private ordinary functions
stop: Public ordinary functions
stop/disconnect: Public ordinary functions
sum: Private ordinary functions
sunday: Private ordinary functions
sync: Private ordinary functions

T
table: Private ordinary functions
table-create: Private ordinary functions
table-drop: Private ordinary functions
table-list: Private ordinary functions
thursday: Private ordinary functions
time: Private ordinary functions
time-of-day: Private ordinary functions
timezone: Private ordinary functions
to-array: Public ordinary functions
to-epoch-time: Private ordinary functions
to-geojson: Private ordinary functions
to-iso8601: Private ordinary functions
to-json-string: Private ordinary functions
to-sequence: Public ordinary functions
tuesday: Private ordinary functions
type-of: Private ordinary functions

U
unendian: Public ordinary functions
ungroup: Private ordinary functions
union: Private ordinary functions
upcase: Private ordinary functions
update: Private ordinary functions
uuid: Private ordinary functions

V
var: Private ordinary functions

W
wait: Private ordinary functions
wait-complete: Public ordinary functions
wednesday: Private ordinary functions
with-fields: Private ordinary functions
with-query: Private macros
without: Private ordinary functions

Y
year: Private ordinary functions

Z
zip: Private ordinary functions


A.3 Variables

Jump to:   *   +  
A   B   C   D   F   K   L   M   N   O   Q   R   S   T  
Index Entry  Section

*
*commands*: Private special variables
*empty*: Private special variables
*object-type*: Public special variables
*sequence-type*: Public special variables
*state*: Public special variables
*varnum*: Private special variables

+
+datum-type-array+: Private constants
+datum-type-bool+: Private constants
+datum-type-json+: Private constants
+datum-type-null+: Private constants
+datum-type-num+: Private constants
+datum-type-object+: Private constants
+datum-type-str+: Private constants
+proto-json+: Private constants
+proto-query-continue+: Private constants
+proto-query-start+: Private constants
+proto-query-stop+: Private constants
+proto-query-wait+: Private constants
+proto-version+: Private constants
+rdb-response-atom+: Private constants
+rdb-response-client-error+: Private constants
+rdb-response-compile-error+: Private constants
+rdb-response-feed+: Private constants
+rdb-response-partial+: Private constants
+rdb-response-runtime-error+: Private constants
+rdb-response-sequence+: Private constants
+rdb-response-wait-complete+: Private constants

A
active-queries: Public classes
args: Private classes

B
backtrace: Public conditions

C
Constant, +datum-type-array+: Private constants
Constant, +datum-type-bool+: Private constants
Constant, +datum-type-json+: Private constants
Constant, +datum-type-null+: Private constants
Constant, +datum-type-num+: Private constants
Constant, +datum-type-object+: Private constants
Constant, +datum-type-str+: Private constants
Constant, +proto-json+: Private constants
Constant, +proto-query-continue+: Private constants
Constant, +proto-query-start+: Private constants
Constant, +proto-query-stop+: Private constants
Constant, +proto-query-wait+: Private constants
Constant, +proto-version+: Private constants
Constant, +rdb-response-atom+: Private constants
Constant, +rdb-response-client-error+: Private constants
Constant, +rdb-response-compile-error+: Private constants
Constant, +rdb-response-feed+: Private constants
Constant, +rdb-response-partial+: Private constants
Constant, +rdb-response-runtime-error+: Private constants
Constant, +rdb-response-sequence+: Private constants
Constant, +rdb-response-wait-complete+: Private constants
current-result: Public classes
cursor: Public conditions

D
debug: Public classes

F
future: Public classes

K
kv: Private classes

L
last-change: Public classes

M
msg: Public conditions
msg: Public conditions
msg: Private conditions

N
name: Private classes

O
op: Private classes
options: Private classes

Q
query: Public conditions

R
results: Public classes

S
Slot, active-queries: Public classes
Slot, args: Private classes
Slot, backtrace: Public conditions
Slot, current-result: Public classes
Slot, cursor: Public conditions
Slot, debug: Public classes
Slot, future: Public classes
Slot, kv: Private classes
Slot, last-change: Public classes
Slot, msg: Public conditions
Slot, msg: Public conditions
Slot, msg: Private conditions
Slot, name: Private classes
Slot, op: Private classes
Slot, options: Private classes
Slot, query: Public conditions
Slot, results: Public classes
Slot, state: Public classes
Slot, token: Public conditions
Slot, token: Public conditions
Slot, token: Public classes
Slot, token: Public classes
Special Variable, *commands*: Private special variables
Special Variable, *empty*: Private special variables
Special Variable, *object-type*: Public special variables
Special Variable, *sequence-type*: Public special variables
Special Variable, *state*: Public special variables
Special Variable, *varnum*: Private special variables
state: Public classes

T
token: Public conditions
token: Public conditions
token: Public classes
token: Public classes


A.4 Data types

Jump to:   A   C   D   F   M   P   Q   R   S   T   U  
Index Entry  Section

A
alist: Private types

C
cl-rethinkdb: The cl-rethinkdb system
cl-rethinkdb: The cl-rethinkdb package
cl-rethinkdb-reql: The cl-rethinkdb-reql package
cl-rethinkdb-util: The cl-rethinkdb-util package
cl-rethinkdb.asd: The cl-rethinkdb/cl-rethinkdb․asd file
Class, connection-options: Private classes
Class, cursor: Public classes
Class, reql-cmd: Private classes
Class, state: Public classes
commands.lisp: The cl-rethinkdb/reql/commands․lisp file
Condition, connect-error: Private conditions
Condition, cursor-error: Public conditions
Condition, cursor-no-more-results: Public conditions
Condition, cursor-overshot: Public conditions
Condition, cursor-stopped: Public conditions
Condition, query-client-error: Public conditions
Condition, query-compile-error: Public conditions
Condition, query-error: Public conditions
Condition, query-runtime-error: Public conditions
Condition, reql-error: Public conditions
config.lisp: The cl-rethinkdb/config․lisp file
connect-error: Private conditions
connection-options: Private classes
connection.lisp: The cl-rethinkdb/connection․lisp file
cursor: Public classes
cursor-error: Public conditions
cursor-no-more-results: Public conditions
cursor-overshot: Public conditions
cursor-stopped: Public conditions

D
dsl.lisp: The cl-rethinkdb/reql/dsl․lisp file

F
File, cl-rethinkdb.asd: The cl-rethinkdb/cl-rethinkdb․asd file
File, commands.lisp: The cl-rethinkdb/reql/commands․lisp file
File, config.lisp: The cl-rethinkdb/config․lisp file
File, connection.lisp: The cl-rethinkdb/connection․lisp file
File, dsl.lisp: The cl-rethinkdb/reql/dsl․lisp file
File, function.lisp: The cl-rethinkdb/reql/function․lisp file
File, package.lisp: The cl-rethinkdb/package․lisp file
File, protocol.lisp: The cl-rethinkdb/protocol․lisp file
File, pseudotypes.lisp: The cl-rethinkdb/reql/pseudotypes․lisp file
File, query.lisp: The cl-rethinkdb/query․lisp file
File, types.lisp: The cl-rethinkdb/reql/types․lisp file
File, util.lisp: The cl-rethinkdb/util․lisp file
function.lisp: The cl-rethinkdb/reql/function․lisp file

M
Module, reql: The cl-rethinkdb/reql module

P
Package, cl-rethinkdb: The cl-rethinkdb package
Package, cl-rethinkdb-reql: The cl-rethinkdb-reql package
Package, cl-rethinkdb-util: The cl-rethinkdb-util package
package.lisp: The cl-rethinkdb/package․lisp file
protocol.lisp: The cl-rethinkdb/protocol․lisp file
pseudotypes.lisp: The cl-rethinkdb/reql/pseudotypes․lisp file

Q
query-client-error: Public conditions
query-compile-error: Public conditions
query-error: Public conditions
query-runtime-error: Public conditions
query.lisp: The cl-rethinkdb/query․lisp file

R
reql: The cl-rethinkdb/reql module
reql-cmd: Private classes
reql-error: Public conditions

S
state: Public classes
System, cl-rethinkdb: The cl-rethinkdb system

T
Type, alist: Private types
types.lisp: The cl-rethinkdb/reql/types․lisp file

U
util.lisp: The cl-rethinkdb/util․lisp file