This is the cl-mongo Reference Manual, version 0.7, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:28:34 2024 GMT+0.
cl-mongo/cl-mongo.asdcl-mongo/src/packages.lispcl-mongo/src/octets.lispcl-mongo/src/pair.lispcl-mongo/src/encode-float.lispcl-mongo/src/bson-oid.lispcl-mongo/src/bson-binary.lispcl-mongo/src/bson-time.lispcl-mongo/src/bson-regex.lispcl-mongo/src/bson-code.lispcl-mongo/src/bson.lispcl-mongo/src/bson-decode.lispcl-mongo/src/bson-array.lispcl-mongo/src/document.lispcl-mongo/src/mongo-syntax.lispcl-mongo/src/java-script.lispcl-mongo/src/bson-encode-container.lispcl-mongo/src/protocol.lispcl-mongo/src/mongo.lispcl-mongo/src/db.lispcl-mongo/src/mem.lispcl-mongo/src/do-query.lispcl-mongo/src/doc.lispcl-mongo/src/map-reduce.lispcl-mongo/src/shell.lispThe main system appears first, followed by any subsystem dependency.
cl-mongolisp system to interact with mongodb, a non-sql db
MIT
0.7
uuid (system).
babel (system).
bordeaux-threads (system).
documentation-template (system).
lisp-unit (system).
parenscript (system).
split-sequence (system).
usocket (system).
Modules are listed depth-first from the system components tree.
cl-mongo/srccl-mongo (system).
packages.lisp (file).
octets.lisp (file).
pair.lisp (file).
encode-float.lisp (file).
bson-oid.lisp (file).
bson-binary.lisp (file).
bson-time.lisp (file).
bson-regex.lisp (file).
bson-code.lisp (file).
bson.lisp (file).
bson-decode.lisp (file).
bson-array.lisp (file).
document.lisp (file).
mongo-syntax.lisp (file).
java-script.lisp (file).
bson-encode-container.lisp (file).
protocol.lisp (file).
mongo.lisp (file).
db.lisp (file).
mem.lisp (file).
do-query.lisp (file).
doc.lisp (file).
map-reduce.lisp (file).
shell.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-mongo/cl-mongo.asdcl-mongo/src/packages.lispcl-mongo/src/octets.lispcl-mongo/src/pair.lispcl-mongo/src/encode-float.lispcl-mongo/src/bson-oid.lispcl-mongo/src/bson-binary.lispcl-mongo/src/bson-time.lispcl-mongo/src/bson-regex.lispcl-mongo/src/bson-code.lispcl-mongo/src/bson.lispcl-mongo/src/bson-decode.lispcl-mongo/src/bson-array.lispcl-mongo/src/document.lispcl-mongo/src/mongo-syntax.lispcl-mongo/src/java-script.lispcl-mongo/src/bson-encode-container.lispcl-mongo/src/protocol.lispcl-mongo/src/mongo.lispcl-mongo/src/db.lispcl-mongo/src/mem.lispcl-mongo/src/do-query.lispcl-mongo/src/doc.lispcl-mongo/src/map-reduce.lispcl-mongo/src/shell.lispcl-mongo/src/octets.lisppackages.lisp (file).
src (module).
+max-uint32+ (constant).
+max-uint64+ (constant).
add-integer (function).
add-octets (function).
add-to-array (function).
append-to-octet-vector (function).
bool-to-byte (function).
byte-to-bool (function).
byte-to-octet (function).
int32-to-octet (function).
int64-to-octet (function).
make-fixed-size-octet-vector (function).
make-octet-vector (function).
null-terminated-octet-to-string (function).
octet-to-byte (function).
octet-to-byte.1 (function).
octet-to-int32 (function).
octet-to-int32.1 (function).
octet-to-int64 (function).
octet-to-int64.1 (function).
octet-to-uint64 (function).
octet-to-uint64.1 (function).
positive (function).
set-octets (function).
string-to-null-terminated-octet (function).
to-octet (function).
to-signed-value (function).
to-val (function).
to-val.1 (function).
cl-mongo/src/pair.lispoctets.lisp (file).
src (module).
kv (generic function).
print-object (method).
container (reader method).
(setf container) (writer method).
copy-pair (function).
kv->doc (generic function).
kv->ht (generic function).
kv-container (class).
kv-container-add (generic function).
kv-container-aref (generic function).
kv-container-kv (generic function).
kv-container-length (generic function).
kv-container-pop (generic function).
kv-container-push (generic function).
make-kv-container (function).
pair (function).
pair (structure).
pair-key (reader).
(setf pair-key) (writer).
pair-p (function).
pair-value (reader).
(setf pair-value) (writer).
cl-mongo/src/encode-float.lisppair.lisp (file).
src (module).
decode-double-float-bits (function).
decode-float-bits (function).
denormalize (function).
encode-double-float-bits (function).
encode-float-bits (function).
scale (function).
scale-integer (function).
cl-mongo/src/bson-oid.lispencode-float.lisp (file).
src (module).
print-object (method).
_id (generic function).
bson-oid (class).
id (reader method).
make-bson-oid (function).
cl-mongo/src/bson-binary.lispbson-oid.lisp (file).
src (module).
print-object (method).
+bson-binary+ (constant).
+bson-binary-function+ (constant).
+bson-binary-generic+ (constant).
+bson-binary-md5+ (constant).
+bson-binary-user+ (constant).
+bson-binary-uuid+ (constant).
bson-binary (generic function).
bson-binary (class).
bson-binary-base (class).
bson-binary-function (class).
bson-binary-md5 (class).
bson-binary-user (class).
bson-binary-uuid (class).
data (reader method).
rep (generic function).
str-md5 (function).
type-id (reader method).
type-id (reader method).
type-id (reader method).
type-id (reader method).
type-id (reader method).
cl-mongo/src/bson-time.lispbson-binary.lisp (file).
src (module).
bson-time-to-ut (function).
print-object (method).
time-zone (function).
*bt-time-zone* (special variable).
+bt-day-names+ (special variable).
+bt-months+ (special variable).
+java-script-epoch+ (constant).
+milliseconds-multiplier+ (constant).
bson-time (class).
decode (generic function).
fmt (generic function).
gmt-to-bson-time (function).
local (reader method).
make-bson-time (function).
raw (reader method).
cl-mongo/src/bson-regex.lispbson-time.lisp (file).
src (module).
print-object (method).
bson-regex (class).
make-bson-regex (function).
options (reader method).
regex (reader method).
cl-mongo/src/bson-code.lispbson-regex.lisp (file).
src (module).
print-object (method).
bson-code (class).
code (reader method).
make-bson-code (function).
cl-mongo/src/bson.lispbson-code.lisp (file).
src (module).
+bson-data-array+ (constant).
+bson-data-binary+ (constant).
+bson-data-boolean+ (constant).
+bson-data-code+ (constant).
+bson-data-code_w_s+ (constant).
+bson-data-date+ (constant).
+bson-data-dbpointer+ (constant).
+bson-data-int32+ (constant).
+bson-data-long+ (constant).
+bson-data-max-key+ (constant).
+bson-data-min-key+ (constant).
+bson-data-null+ (constant).
+bson-data-number+ (constant).
+bson-data-object+ (constant).
+bson-data-oid+ (constant).
+bson-data-regex+ (constant).
+bson-data-string+ (constant).
+bson-data-symbol+ (constant).
+bson-data-timestamp+ (constant).
+bson-data-undefined+ (constant).
+default-array-size+ (constant).
bson-encode (generic function).
bson-encode-array (function).
null-terminate-array (function).
set-array-length (function).
cl-mongo/src/bson-decode.lispbson.lisp (file).
src (module).
bson-decode (function).
end-of-key (function).
ht->list.1 (function).
cl-mongo/src/bson-array.lispbson-decode.lisp (file).
src (module).
print-object (method).
bson-array (class).
bson-array-pop (generic function).
bson-array-pop-element (method).
bson-array-push (generic function).
bson-array-reset (generic function).
bson-encode (method).
bson-encode (method).
bson-encode-cons (function).
data-array (reader method).
(setf data-array) (writer method).
index-array (reader method).
(setf index-array) (writer method).
make-bson-array (function).
make-int-vector (function).
normalize-array (function).
normalize-bson-array (function).
pop-from-array (function).
cl-mongo/src/document.lispbson-array.lisp (file).
src (module).
add-element (generic function).
collect-all-elements (function).
describe-object (method).
doc-id (function).
document (class).
get-element (generic function).
get-keys (generic function).
ht->document (function).
make-document (function).
mapdoc (function).
print-object (method).
rm-element (generic function).
_id (reader method).
_local (reader method).
doc-elements (generic function).
elements (reader method).
(setf elements) (writer method).
get-all-values (function).
get-id (generic function).
hash-keys (function).
ht->document.1 (function).
ht-test (function).
make-elements (function).
print-hash (function).
print-object.1 (method).
print-object.2 (method).
cl-mongo/src/mongo-syntax.lispdocument.lisp (file).
src (module).
$ (macro).
$!= (macro).
$!in (macro).
$+ (macro).
$- (macro).
$/ (macro).
$< (macro).
$<= (macro).
$> (macro).
$>= (macro).
$add-to-set (macro).
$all (macro).
$em (macro).
$exists (macro).
$in (macro).
$inc (macro).
$index (macro).
$mod (macro).
$not (macro).
$pop-back (macro).
$pop-front (macro).
$pull (macro).
$pull-all (macro).
$push (macro).
$push-all (macro).
$set (macro).
$unset (macro).
$where (macro).
$exp+ (macro).
$kv-eval (macro).
$op (macro).
$op* (macro).
$range (macro).
$size (macro).
collect-args (function).
construct-$+- (macro).
construct-container* (macro).
construct-container-lst* (macro).
empty-str (function).
expand-selector (macro).
map-reduce-op (function).
normalize-args (function).
op-split (function).
set-keys (macro).
unwrap (function).
upd (macro).
cl-mongo/src/java-script.lispmongo-syntax.lisp (file).
src (module).
defjs (macro).
defsrvjs (macro).
install-js (macro).
jsdef (macro).
remove-js (macro).
*js-definitions* (special variable).
js-show (function).
jssrvdef (macro).
cl-mongo/src/bson-encode-container.lispjava-script.lisp (file).
src (module).
bson-encode (method).
bson-encode (method).
bson-encode (method).
bson-encode (method).
bson-encode-container (generic function).
cl-mongo/src/protocol.lispbson-encode-container.lisp (file).
src (module).
+mongo-delete+ (constant).
+mongo-get-more+ (constant).
+mongo-insert+ (constant).
+mongo-kill-cursors+ (constant).
+mongo-query+ (constant).
+mongo-update+ (constant).
mongo-delete (generic function).
mongo-get-more (generic function).
mongo-insert (generic function).
mongo-kill-cursors (generic function).
mongo-query (generic function).
mongo-reply (function).
mongo-update (generic function).
update-options (function).
cl-mongo/src/mongo.lispprotocol.lisp (file).
src (module).
*mongo-default-db* (special variable).
*mongo-default-host* (special variable).
*mongo-default-port* (special variable).
cwd (function).
db.use (generic function).
initialize-instance (method).
mongo (generic function).
mongo (class).
mongo-close (generic function).
mongo-registered (generic function).
mongo-show (function).
mongo-swap (generic function).
nwd (function).
print-object (method).
shared-initialize (method).
(setf socket) (writer method).
socket (reader method).
with-mongo-connection (macro).
*db.use-history* (special variable).
*mongo-registry* (special variable).
+mongo-port+ (constant).
add-to-registry (function).
connection? (function).
db (reader method).
(setf db) (writer method).
default? (function).
error-on-key-exists (function).
host (reader method).
id (reader method).
make-mongo (function).
mongo-ids (function).
mongo-message (generic function).
mongo-message* (method).
mongo-registry (function).
mongo-stream (generic function).
name (reader method).
(setf name) (writer method).
port (reader method).
read-back (function).
read-buffer (function).
read-ready (function).
restore-default-connection (function).
switch-default-connection (function).
test-for-readback (function).
test-for-readback* (function).
cl-mongo/src/db.lispmongo.lisp (file).
src (module).
db.add-user (generic function).
db.auth (generic function).
db.collections (method).
db.count (generic function).
db.create-collection (generic function).
db.delete (generic function).
db.distinct (generic function).
db.ensure-index (generic function).
db.eval (generic function).
db.find (generic function).
db.indexes (method).
db.insert (generic function).
db.iter (generic function).
db.iterator (function).
db.next (generic function).
db.run-command (generic function).
db.save (generic function).
db.sort (macro).
db.stop (generic function).
db.update (generic function).
asc/desc->+1/-1 (function).
count-it (function).
full-collection-name (generic function).
header+docsp (function).
headerp (function).
hex-md5 (function).
cl-mongo/src/mem.lispdb.lisp (file).
src (module).
gen-clean (function).
reclaim-memory (function).
cl-mongo/src/do-query.lispmem.lisp (file).
src (module).
do-query (function).
*q* (special variable).
*r* (special variable).
*runners* (special variable).
collect-to-hash (function).
do-reduce (function).
mongodb-reader (function).
perf.db.find (function).
perf.mongo-reply (function).
queue-reader (function).
th-reader (function).
th-status (function).
th-writer (function).
tor (function).
cl-mongo/src/doc.lispdo-query.lisp (file).
src (module).
*repo-root* (special variable).
generate-readme (function).
customize (function).
gendoc (function).
load-file (function).
rebuild* (function).
segment* (function).
select-body (function).
slurp-stream (function).
string-replace (function).
string-replace* (function).
strip-comments (function).
write-file (function).
cl-mongo/src/map-reduce.lispdoc.lisp (file).
src (module).
$map-reduce (macro).
mr.gc (function).
mr.gc.all (function).
mr.p (function).
mr.collections (function).
mr.gc* (function).
cl-mongo/src/shell.lispmap-reduce.lisp (file).
src (module).
*indent* (special variable).
bind-return (function).
elp (generic function).
new-line (function).
pp* (method).
print-doc (function).
rm* (function).
with-indent (macro).
Packages are listed by definition order.
cl-mongobabel.
common-lisp.
usocket.
uuid.
$ (macro).
$!= (macro).
$!in (macro).
$+ (macro).
$- (macro).
$/ (macro).
$< (macro).
$<= (macro).
$> (macro).
$>= (macro).
$add-to-set (macro).
$all (macro).
$em (macro).
$exists (macro).
$in (macro).
$inc (macro).
$index (macro).
$map-reduce (macro).
$mod (macro).
$not (macro).
$pop-back (macro).
$pop-front (macro).
$pull (macro).
$pull-all (macro).
$push (macro).
$push-all (macro).
$set (macro).
$unset (macro).
$where (macro).
*mongo-default-db* (special variable).
*mongo-default-host* (special variable).
*mongo-default-port* (special variable).
*repo-root* (special variable).
add-element (generic function).
bson-time-to-ut (function).
collect-all-elements (function).
cwd (function).
date-time (function).
db.add-user (generic function).
db.auth (generic function).
db.collections (generic function).
db.count (generic function).
db.create-collection (generic function).
db.delete (generic function).
db.distinct (generic function).
db.ensure-index (generic function).
db.eval (generic function).
db.find (generic function).
db.indexes (generic function).
db.insert (generic function).
db.iter (generic function).
db.iterator (function).
db.next (generic function).
db.run-command (generic function).
db.save (generic function).
db.sort (macro).
db.stop (generic function).
db.update (generic function).
db.use (generic function).
defjs (macro).
defsrvjs (macro).
do-query (function).
doc-id (function).
docs (function).
document (class).
generate-readme (function).
get-element (generic function).
get-keys (generic function).
ht->document (function).
install-js (macro).
iter (function).
jsdef (macro).
kv (generic function).
make-document (function).
mapdoc (function).
mongo (generic function).
mongo (class).
mongo-close (generic function).
mongo-registered (generic function).
mongo-show (function).
mongo-swap (generic function).
mr.gc (function).
mr.gc.all (function).
mr.p (function).
nd (function).
now (function).
nwd (function).
pp (generic function).
remove-js (macro).
ret (function).
rm (function).
rm-element (generic function).
show (generic function).
time-zone (function).
with-mongo-connection (macro).
$exp+ (macro).
$kv-eval (macro).
$op (macro).
$op* (macro).
$range (macro).
$size (macro).
*bt-time-zone* (special variable).
*db.use-history* (special variable).
*indent* (special variable).
*js-definitions* (special variable).
*mongo-registry* (special variable).
*q* (special variable).
*r* (special variable).
*runners* (special variable).
+bson-binary+ (constant).
+bson-binary-function+ (constant).
+bson-binary-generic+ (constant).
+bson-binary-md5+ (constant).
+bson-binary-user+ (constant).
+bson-binary-uuid+ (constant).
+bson-data-array+ (constant).
+bson-data-binary+ (constant).
+bson-data-boolean+ (constant).
+bson-data-code+ (constant).
+bson-data-code_w_s+ (constant).
+bson-data-date+ (constant).
+bson-data-dbpointer+ (constant).
+bson-data-int32+ (constant).
+bson-data-long+ (constant).
+bson-data-max-key+ (constant).
+bson-data-min-key+ (constant).
+bson-data-null+ (constant).
+bson-data-number+ (constant).
+bson-data-object+ (constant).
+bson-data-oid+ (constant).
+bson-data-regex+ (constant).
+bson-data-string+ (constant).
+bson-data-symbol+ (constant).
+bson-data-timestamp+ (constant).
+bson-data-undefined+ (constant).
+bt-day-names+ (special variable).
+bt-months+ (special variable).
+default-array-size+ (constant).
+java-script-epoch+ (constant).
+max-uint32+ (constant).
+max-uint64+ (constant).
+milliseconds-multiplier+ (constant).
+mongo-delete+ (constant).
+mongo-get-more+ (constant).
+mongo-insert+ (constant).
+mongo-kill-cursors+ (constant).
+mongo-port+ (constant).
+mongo-query+ (constant).
+mongo-update+ (constant).
_id (generic function).
_local (generic reader).
add-integer (function).
add-octets (function).
add-to-array (function).
add-to-registry (function).
append-to-octet-vector (function).
asc/desc->+1/-1 (function).
bind-return (function).
bool-to-byte (function).
bson-array (class).
bson-array-pop (generic function).
bson-array-pop-element (generic function).
bson-array-push (generic function).
bson-array-reset (generic function).
bson-binary (generic function).
bson-binary (class).
bson-binary-base (class).
bson-binary-function (class).
bson-binary-md5 (class).
bson-binary-user (class).
bson-binary-uuid (class).
bson-code (class).
bson-decode (function).
bson-encode (generic function).
bson-encode-array (function).
bson-encode-cons (function).
bson-encode-container (generic function).
bson-oid (class).
bson-regex (class).
bson-time (class).
byte-to-bool (function).
byte-to-octet (function).
code (generic reader).
collect-args (function).
collect-to-hash (function).
connection? (function).
construct-$+- (macro).
construct-container* (macro).
construct-container-lst* (macro).
container (generic reader).
(setf container) (generic writer).
copy-pair (function).
count-it (function).
customize (function).
data (generic reader).
data-array (generic reader).
(setf data-array) (generic writer).
db (generic reader).
(setf db) (generic writer).
decode (generic function).
decode-double-float-bits (function).
decode-float-bits (function).
default? (function).
denormalize (function).
do-reduce (function).
doc-elements (generic function).
elements (generic reader).
(setf elements) (generic writer).
elp (generic function).
empty-str (function).
encode-double-float-bits (function).
encode-float-bits (function).
end-of-key (function).
error-on-key-exists (function).
expand-selector (macro).
fmt (generic function).
full-collection-name (generic function).
gen-clean (function).
gendoc (function).
get-all-values (function).
get-id (generic function).
gmt-to-bson-time (function).
hash-keys (function).
header+docsp (function).
headerp (function).
hex-md5 (function).
host (generic reader).
ht->document.1 (function).
ht->list.1 (function).
ht-test (function).
id (generic reader).
index-array (generic reader).
(setf index-array) (generic writer).
int32-to-octet (function).
int64-to-octet (function).
js-show (function).
jssrvdef (macro).
kv->doc (generic function).
kv->ht (generic function).
kv-container (class).
kv-container-add (generic function).
kv-container-aref (generic function).
kv-container-kv (generic function).
kv-container-length (generic function).
kv-container-pop (generic function).
kv-container-push (generic function).
load-file (function).
local (generic reader).
make-bson-array (function).
make-bson-code (function).
make-bson-oid (function).
make-bson-regex (function).
make-bson-time (function).
make-elements (function).
make-fixed-size-octet-vector (function).
make-int-vector (function).
make-kv-container (function).
make-mongo (function).
make-octet-vector (function).
map-reduce-op (function).
mongo-delete (generic function).
mongo-get-more (generic function).
mongo-ids (function).
mongo-insert (generic function).
mongo-kill-cursors (generic function).
mongo-message (generic function).
mongo-message* (generic function).
mongo-query (generic function).
mongo-registry (function).
mongo-reply (function).
mongo-stream (generic function).
mongo-update (generic function).
mongodb-reader (function).
mr.collections (function).
mr.gc* (function).
name (generic reader).
(setf name) (generic writer).
new-line (function).
normalize-args (function).
normalize-array (function).
normalize-bson-array (function).
null-terminate-array (function).
null-terminated-octet-to-string (function).
octet-to-byte (function).
octet-to-byte.1 (function).
octet-to-int32 (function).
octet-to-int32.1 (function).
octet-to-int64 (function).
octet-to-int64.1 (function).
octet-to-uint64 (function).
octet-to-uint64.1 (function).
op-split (function).
options (generic reader).
pair (function).
pair (structure).
pair-key (reader).
(setf pair-key) (writer).
pair-p (function).
pair-value (reader).
(setf pair-value) (writer).
perf.db.find (function).
perf.mongo-reply (function).
pop-from-array (function).
port (generic reader).
positive (function).
pp* (generic function).
print-doc (function).
print-hash (function).
print-object.1 (generic function).
print-object.2 (generic function).
queue-reader (function).
raw (generic reader).
read-back (function).
read-buffer (function).
read-ready (function).
rebuild* (function).
reclaim-memory (function).
regex (generic reader).
rep (generic function).
restore-default-connection (function).
rm* (function).
scale (function).
scale-integer (function).
segment* (function).
select-body (function).
set-array-length (function).
set-keys (macro).
set-octets (function).
slurp-stream (function).
str-md5 (function).
string-replace (function).
string-replace* (function).
string-to-null-terminated-octet (function).
strip-comments (function).
switch-default-connection (function).
test-for-readback (function).
test-for-readback* (function).
th-reader (function).
th-status (function).
th-writer (function).
to-octet (function).
to-signed-value (function).
to-val (function).
to-val.1 (function).
tor (function).
type-id (generic reader).
unwrap (function).
upd (macro).
update-options (function).
with-indent (macro).
write-file (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
database opened by the default connection
host for the default connection.
port for the default connection.
root of the repository; used for documentation generation
Run map reduce on the mongo server. map and reduce are either the names of the
javascript functions, created with defjs or defsrvjs or are function definitions in javascript.
The keywords refer to option available for map reduce in mongo. This returns a result summary document.
When using :keeptemp t without specificing :out the collection is mr.<collection>
sort macro : Takes the same arguments and keywords as db.find but converts the query so it works as a sort. use the :field keyword to select the field to sort on. Set :asc to nil to reverse the sort order
Define client side javascript. Works like defun; body is in lisp, with parenscript
additions, like return. So (defjs hello (x y) (return (+ x y))) defines an adder.
macro creates a lisp function which sends the javascript function over to the mongo
server to be evaluated. Result is processed and returned to the reader.
This will execute 10 times on the server :
(mapcar (lambda (x) (hello 10 x)) (list 1 2 3 4 5 6 7 8 9 10))
Creates a function which stores and executes javascript on the server. The first time
the function is called the javascript function is stored on the server. Subsequent calls will
call out to the server.
Works like defun; the function body is defined in lisp, with parenscript additions. Since
the body of the function already resides on the server this should have less impact on
the network. Use :install t to reinstall.
Allows server based javascripts the be installed without being run.
Return the body of the javascript function; otherwise nill.
Creates a connection to a mongodb, makes it the default connection
and evaluates the body form.
args uses the same keyword set as mongo (:db :localhost :port)
args is passed on to make-mongo when the connection is created.
Show the current database.
Generate a time stamp the mongo/bson protocol understands.
Returns the iterator from the result set.
Performs a multi-threaded query on a mongo database. coll is the collection name. The reduce-fn keyword is used to specify a function which
will be called for each member of a batch of data returned from mongodb.
The reduce-fn function is executed while the query for the next batch is in progress. The default for reduce-fn is the identity function.
The reduction keyword is used to specify a function which is executed when the database queries have finished.
It’s default implementation is to return a hash table, with the mongodb id as the hash key. The query, mongo, limit and selector keywords are used in the same way as for db.find.
return the unique document id
Stop the iterator (if any) and return the list of documents returned by the query. Typical ue would be in conjunction with db.find like so (docs (iter (db.find ’foo’ ’ll)))
This function generates a README.md file with the latest api description.
The :path keyword specifies the location. It expects a sub-directory <path>/doc.
Api documentation is generated on the fly, by extracting comments from the classes,
generics and fuctions exported in the packages file.
The resulting file is <path>/doc/index.html. <path>/README.md is generated by
appending the api documentation to <path>/doc/readme-base.md.
:path or *REPO-ROOT* are typically set to the root of the repository.
Convert a hash-table to a document.
Exhaustively iterate through a query. The maximum number of responses per query can be specified using the max-per-call keyword.
Constructor. key ’:oid’ is a user supplied unique id. An internal id will be generated if none is supplied.
Show all registered connections and their session id
remove the temporary collections created by map-reduce
remove the all collections created by map-reduce, temporary as well as permanent
show the contents of the results collection map-reduce created
Pretty-print for non-document responses, like the response to a database command.
Return the current date and time in bson format.
Show the database set by the ‘(db.use -)‘ command
return value bound to retval in a return document. Used for db.count, db.distinct, functions etc..
Delete all the documents returned by a query. This is not an efficient way of deleting documents as it invloves multiple trips to the server. Mongo allows for execution of java-script on the server side, which provides an alternative. Typical use would be (rm (iter (db.find ’foo’ (kv ’key’ 1)))), which deletes all documents in foo, with field key equal to 1.
Set the time zone appropriate for the current environment.
add element with key and value to a document
Add a user to the database.
authenticate a user with a password
Count all the collections satifying the criterion set by the selector.
:all can be used to return a count of
all the documents in the collection.
create a collection
Delete a document from a collection. The *document* field is used to identify the document to
be deleted.
You can enter a list of documents. In that the server will be contacted to delete each one of these.
It may be more efficient to run a delete script on the server side.
string) (document kv-container) &key mongo) ¶string) (documents cons) &key mongo) ¶(eql nil)) &key mongo) ¶Return all the distinct values of this key in the collection
Create an index specified by the keys in a collection
string) (key string) &key mongo unique asc drop-duplicates) ¶string) (index kv-container) &key mongo unique drop-duplicates) ¶string) (index hash-table) &key mongo unique drop-duplicates) ¶run javascript code server side
Find documents in the collection using the selector specified by kv.
Methods take two keywords. ’:limit’ sets the maximum number of documents returned. The default is 1.
’:skip’ sets the number of documents to skip in this query. It’s default is 0.
Since the default value of the limit is one, db.find by default is the equivalant of *findOne* in the
mongo documentation.
string) (kv kv-container) &key mongo options skip limit selector) ¶string) (kv hash-table) &key mongo options skip limit selector) ¶string) (kv integer) &key mongo options skip selector) ¶string) (kv (eql :all)) &key mongo options skip limit selector) ¶symbol) kv &key mongo options skip limit selector) ¶string) kv &key mongo options skip limit selector) ¶Insert a document in a collection. A document is typically generated by ‘(make-document)‘, but it can also be a hash table, a key-value pair or kv list (see the kv functions).
next document iteration
Executes the next call on the iterator identified by cursor-id.
Run a database command on the server. See the mongo documentation for a list of commands. For most commands you can just uses the key-value shown in the mongo documentation.
(eql :drop)) &key mongo collection index) ¶(eql :dropindexes)) &key mongo collection index) ¶(eql :deleteindexes)) &key mongo collection index) ¶(eql :serverstatus)) &key mongo) ¶(eql :listdatabases)) &key mongo) ¶(eql :querytracelevel)) &key mongo arg) ¶string) &key mongo arg) ¶symbol) &key mongo arg) ¶Save a document to the collection. If the document has a unique ‘_id‘ value (i.e. if it’s generated
by ‘(make-document)‘) it will be ’upserted’ (that is: it will be inserted if the document
doesn’t exist). If the document a hash table or a kv set, it will be inserted.
In other words this a a helper-function build around *db.insert* and *db.update*.
Stop iterating and clean up the iterator on the server by making a server call.
In a collection update the document(s) identified by the selector statement.
This method has two keywords. ’:upsert’ : If t insert the document if the document cannot be
found in the collection. ’:multi’ : Update all documents identified by the selector.
Use a database on the mongo server. Opens a connection if one isn’t already established. (db.use -) can be used to go to a previosuly visited database, similar to cd -.
Get an element identified by key from the document. To get the _id use :_id as the key
Gets a list of keys that are in the document
This a helper function for key-value pairs and sets of key-value pairs.
In a key-value pair like (kv key value) the key has to be a string and the
value something which is serializable.
key-value pairs can be combined using kv as well : (kv (kv key1 val1) (kv key2 val2)).
This combination of key-value pairs is equivalent to a document without a unique id.
The server will assign a unique is if a list of key-value pairs is saved.
This method returns the connection referred to by
the name identifier from the connection registry. The connection name is unique.
If no connection with that name exists, a new connection with the supplied or default
host, port and db parameters will be created. The default host is localhost;
the default port is 27017; the default db is admin.
Close the connection to the mongo database.
The name should uniquely identify the connection to close.
This is either a mongo object or the name the object is bound to
in the connection registry. To close all open connections use the special symbol ’all
Return a conection registered by this name or nil..
Swap the names of the left and right connections. Typical use would be
‘(mongo-swap :default :alt)‘. After the function call :default will refer to the connection
previously referred to as :alt. A connection named :default is returned by ‘(mongo)‘ and is the default used in the api. The connections are returned in the order they were passed in (but with the names
swapped between them). To re-open a connection you can say
‘(mongo-close (mongo-swap :default (mongo :host <newhost> :portid <portid> :name :temp)))‘
and a new default connection is registered.
Pretty-print the results returned from a query. To be used on the repl. This will format each server reply as if it were a document. This is obviously ok in mosty cases. See nd for an alternative.
Remove element identified by key from a document
Print a list of things. Things can be users, databases,
collections in the current database,
the profile and more. Things is a keyword so (show :users) will show all users.
(eql :errors)) &key order) ¶(eql :preverror)) &key order) ¶(eql :lasterror)) &key order) ¶(eql :assertinfo)) &key order) ¶(eql :status)) &key order) ¶(eql :users)) &key order) ¶(eql :buildinfo)) &key) ¶(eql :buildinfo)) &key) ¶(eql :buildinfo)) &key order) ¶(eql :databases)) &key) ¶(eql :databases)) &key) ¶(eql :databases)) &key order) ¶(eql :indexes)) &key order) ¶(eql :collections)) &key order) ¶function) &key order nl msg) ¶(eql :connections)) &key) ¶bson-binary-base) stream) ¶bson-array) stream) ¶bson-regex) stream) ¶kv-container) stream) ¶mongo)) ¶automatically generated writer method
usocket.
mongo)) ¶automatically generated reader method
usocket.
document
Document class. A document consists of key/value pairs stored in a internal hash table plus
an internally generated unique id.
Accessors are : ’elements’ which returns the internal hash table;
’_id’ which returns the unique id and ’_local_id’ which if true means that
the document was generated by the client (as opposed to having been read from the server).
| Initarg | Value |
|---|---|
:local | t |
:oid | (make-bson-oid) |
:elements
Encapsulates the connection to the mongo database. Each connection is a added to a global registry.
ordinary binary
function
binary/generic
md5
user defined
uuid
bson db pointer encoding/deprecated
size of default array in the encoder
(encode-universal-time 0 0 0 1 1 1970 0)
max + 1 value of unsigned 32 bit integer
max + 1 value of unsigned 64 bit integer
’convert’ to milliseconds
delete command
request for more docs/next cursor iterator
insert command
kill the cursor/reclaim db resources
query command
update/insert command
the current time zone; 5 -> EST
an attempt to record the history of the shell
hash table containing client side javascript
hash table of all open mongo connections
Return the body of the javascript function as installed on the server; otherwise nill.
return value bound to val in a return document. Used for count etc..
Extract reply parameters
Delete all the documents returned by a query. This is not an efficient way of deleting documents as it invloves multiple trips to the server. Mongo allows for execution of java-script on the server side, which provides an alternative. Typical use would be (rm (iter (db.find ’foo’ (kv ’key’ 1)))), which deletes all documents in foo, with field key equal to 1.
return a 12 byte array, irrespective of the internals of bson-oid, which may have a larger array
pop element from arrray
bson-array)) ¶bson-array)) ¶push element to arrray
bson-array)) ¶bson-array)) ¶Create a bson serializable binary object. type is a keyword; either one of :function :binary :uuid :md5 or :user. data is the data encapsulated by this type.
(eql 128)) data) ¶(eql :user)) data) ¶(eql 3)) data) ¶(eql :uuid)) data) ¶(eql 5)) data) ¶(eql :md5)) data) ¶(eql 2)) data) ¶(eql :binary)) data) ¶(eql 1)) data) ¶(eql :function)) data) ¶encode a bson data element
string) (value kv-container) &key) ¶string) (value hash-table) &key) ¶string) (value cons) &key) ¶string) (value bson-array) &key array size type encoder) ¶string) (value bson-regex) &key array) ¶string) (value float) &key array) ¶string) (value integer) &key array) ¶string) (value string) &key array type) ¶string) (value symbol) &key array) ¶string) (value (eql nil)) &key array) ¶string) (value (eql t)) &key array) ¶string) (value array) &key array type encoder) ¶string) (value bson-binary) &key array type) ¶the ordinary binary type as some structure in that the length of the binary array is encoded
string) (value bson-binary-base) &key array type) ¶integer) value &key) ¶(eql nil)) (value (eql nil)) &key array) ¶string) value &key array type encoder) ¶encode a container of key-value pairs..
kv-container) &key array size) ¶hash-table) &key array size) ¶(eql nil)) &key array) ¶kv-container)) ¶automatically generated reader method
kv-container)) ¶automatically generated writer method
bson-binary-base)) ¶automatically generated reader method
data.
bson-array)) ¶automatically generated reader method
bson-array)) ¶automatically generated writer method
decode the bson-time for human consumption
hash-table)) ¶format bson time to be in human readable form
generate the full collection name
bson-array)) ¶automatically generated reader method
bson-array)) ¶automatically generated writer method
turn a pair of key/value pairs into a document
turn a pair of key/value pairs into a hash table
kv-container) (kv-container kv-container)) ¶pair) (kv-container kv-container)) ¶integer) (kv-container kv-container)) ¶integer) (kv-container kv-container)) ¶kv-container)) ¶kv-container)) ¶pair) (kv-container kv-container)) ¶delete a mongo object
string) (selector array)) ¶iterate the db cursor..
string) (cursor array) &key limit) ¶insert function for mongo
tell the db you’re done with the cursors
array) (count (eql 1))) ¶message to/from mongo..
query a bson database
mongo stream socket..
insert function for mongo
string) (selector array) (document array) &key options) ¶bson-regex)) ¶automatically generated reader method
cons) &key stream nd) ¶bson-regex)) ¶automatically generated reader method
a human-readable representation of the binary data .
bson-binary-md5)) ¶bson-binary-base)) ¶bson-binary-user)) ¶automatically generated reader method
bson-binary-md5)) ¶automatically generated reader method
bson-binary-uuid)) ¶automatically generated reader method
bson-binary)) ¶automatically generated reader method
bson-binary-function)) ¶automatically generated reader method
bson ordinary binary type
bson binary type; this is the base class.
bson function binary type
bson md5 binary type
bson user defined binary type
bson uuid binary type
_id.
bson-encode.
get-id.
id.
print-object.
| Initarg | Value |
|---|---|
:oid | (uuid-to-byte-array (make-v4-uuid)) |
bson-encode.
decode.
fmt.
local.
print-object.
raw.
| Initarg | Value |
|---|---|
:local | t |
:raw | (gmt-to-bson-time (get-universal-time)) |
(make-array 2 :fill-pointer 0 :adjustable t)
| Jump to: | $
(
_
A B C D E F G H I J K L M N O P Q R S T U W |
|---|
| Jump to: | $
(
_
A B C D E F G H I J K L M N O P Q R S T U W |
|---|
| Jump to: | *
+
_
A C D E H I K L N O P R S T V |
|---|
| Jump to: | *
+
_
A C D E H I K L N O P R S T V |
|---|
| Jump to: | B C D E F J K M O P R S |
|---|
| Jump to: | B C D E F J K M O P R S |
|---|