The cl-mongo Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-mongo Reference Manual

This is the cl-mongo Reference Manual, version 0.7, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:50:25 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-mongo

Join the chat at https://gitter.im/fons/cl-mongo

Intro

mongo is a scalable, high-performance, open source, schema-free, document-oriented database..

This is a common lisp interface that allows you to work with a mongo document database. This is not a driver (yet) as specified in the mongo documents; There is still some functionality I need to implement.

Except for gridfs most features have been implemented.

cl-mongo provides the ability to insert, update and delete documents, indexing, searching using regexs etc. In addition it supports javascript in the repl (using a commonly available lisp to javascript compiler). This allows you to do use mongodb's map-reduce from the lisp repl.

I developed this primarily using sbcl and to some extend clozure common lisp on the linux and mac osx platforms.

This should also work on clisp and allegro common lisp and windows.

multi-threading

The do-query function uses multithreading to process the results of a batch as a query is in progress. This obviously requires that multi-threading is supported. I've found that as of now (2010-10-23) sbcl on mac osx doesn't support multithreading out of the box. So you'd need to compile a new sbcl with multithreading enabled, which is easy to do.

Version

Version 0.9.0

I've added regression testing for all features currently supported by cl-mongo.

Installation

Use asdf to install cl-mongo. cl-mongo depends on many other lisp libraries (which in turn have their own dependecies). asdf is not a dependency manager, so you would need to install all dependencies as they come up as unavailable when you try to install cl-mongo.

On the other hand, cl-mongo is included in quicklisp, which should make life easier.

Testing

The cl-mongo-test package contains regression tests for all the features currently supported. cl-mongo-test is asdf-installable, but does not export it's tests. To run the quick test, do this : (use-package :cl-mongo-test) (quick-test)

Quick test will connected to a locally running mongodb instance. It uses the "foo" collection in the "test" database.

A sample session

This connects to the test database on the local mongo server listening on its default port.

(use-package :cl-mongo)
(db.use "test")

Insert a key-value pair as the first document into collection "foo".

(db.insert "foo" (kv "document" "one") )

Pretty-print the documents returned by the find command. iter will ensure that the cursor is fully iterated over.

(pp (iter (db.find "foo" :all)))`

 {
    "_id" -> objectid(4B5CF28970DFF196A75FE1F0)
    "document"  ->  one
 }

Create a document. A document is collection of key-value pairs and a unique identifier called "_id".

(defvar *DOC* (make-document))

Add various elements to the document.

   (add-element "tag" "key" *DOC*)`


   {  DOCUMENT 

   {
   tag  -> key 
   }
   }


(add-element "array" (list 1 2 3 "hello") *DOC*)

{  DOCUMENT 

{
tag  -> key 
	 1 
	 2 
	 3 
	 hello 
 array  -> NIL 
 }
 }

Insert document into the database.

(db.insert "foo" *DOC*)

Print the current contents.

   (pp (iter (db.find "foo" 'all)))

   {
   "_id" -> objectid(4B5CF28970DFF196A75FE1F0)
   "document"  ->  one
   }

   {
   "_id" -> objectid(8B508D5CBB5D451D961F046D)
   "array"  -> [ 1, 2, 3, hello,]
   "tag"  ->  key
   }

Bind variable *DOC* to the second document returned by the find command, add an other element and save back to the collection.

  (defvar *DOC* (cadr (docs (db.find "foo" :all))))`
  (add-element "tags" (list 'good 'bad 'ugly) *DOC*)
  (db.save "foo" *DOC*)
  (pp (db.find "foo" :all))

  {
"_id" -> objectid(4B5CF28970DFF196A75FE1F0)
  	"document"  ->  one
  }

  {
    "_id" -> objectid(8B508D5CBB5D451D961F046D)
  	"tags"  -> [ GOOD, BAD, UGLY,]
 	"tag"  ->  key
 	"array"  -> [ 1, 2, 3, hello,]
  }

Check the status of the server.

  (db.use "admin")
  (nd (db.run-command :serverstatus))

    "ok"  ->  1.0d0
  "mem"  -> 
    "mapped"  ->  80
    "virtual"  ->  177
        "resident"  ->  3
    "globalLock"  -> 
      "ratio"  ->  4.644753171959394d-5
      "lockTime"  ->  6493354.0d0
    "totalTime"  ->  1.39799764586d11
    "uptime"  ->  139799.0d0

$ syntax

I've added various $.. macros which allow for a more declarative programming style. In stead of doing something like :

(db.find "foo" (kv "k" (kv "$lte" 3)))

you can use :

(db.find "foo" ($<= "k" 3))

To declare a unique ascending index on "k" in collection "foo" , you can say :

($index "foo" :unique :asc "k")

What's missing

At least the following is missing :

API documentation

I use Edi Weitz's documentation template to generate an api description based on embedded comments.

News

2010-10-23 I've improved the read performance several orders of magnitude. This also reduces the memory foot pront quite a bit.

In addition I've added a multi-threaded reader called do-query.

CL-MONGO - api reference


 

Abstract

The code comes with a MIT-style license so you can basically do with it whatever you want.

Download shortcut: http://github.com/fons/cl-mongo.


 

Contents

  1. Download
  2. The CL-MONGO dictionary
    1. $
    2. $!=
    3. $!in
    4. $+
    5. $-
    6. $/
    7. $<
    8. $<=
    9. $>
    10. $>=
    11. $add-to-set
    12. $all
    13. $em
    14. $exists
    15. $in
    16. $inc
    17. $index
    18. $map-reduce
    19. $mod
    20. $not
    21. $pop-back
    22. $pop-front
    23. $pull
    24. $pull-all
    25. $push
    26. $push-all
    27. $set
    28. $unset
    29. $where
    30. *mongo-default-db*
    31. *mongo-default-host*
    32. *mongo-default-port*
    33. *repo-root*
    34. add-element
    35. cwd
    36. date-time
    37. db.add-user
    38. db.auth
    39. db.collections
    40. db.collections
    41. db.count
    42. db.create-collection
    43. db.delete
    44. db.distinct
    45. db.ensure-index
    46. db.eval
    47. db.find
    48. db.indexes
    49. db.indexes
    50. db.insert
    51. db.iter
    52. db.next
    53. db.run-command
    54. db.save
    55. db.sort
    56. db.stop
    57. db.update
    58. db.use
    59. defjs
    60. defsrvjs
    61. do-query
    62. doc-id
    63. docs
    64. document
    65. generate-readme
    66. get-element
    67. ht->document
    68. install-js
    69. iter
    70. jsdef
    71. kv
    72. make-document
    73. mapdoc
    74. mongo
    75. mongo
    76. mongo-close
    77. mongo-registered
    78. mongo-show
    79. mongo-swap
    80. mr.gc
    81. mr.gc.all
    82. mr.p
    83. nd
    84. now
    85. nwd
    86. pp
    87. remove-js
    88. ret
    89. rm
    90. rm-element
    91. show
    92. time-zone
    93. with-mongo-connection
  3. Acknowledgements


 

Download

CL-MONGO together with this documentation can be downloaded from http://github.com/fons/cl-mongo. The current version is 0.1.0.


 

The CL-MONGO dictionary


[Macro]
$ &rest args => result



[Macro]
$!= &rest args => result



[Macro]
$!in &rest args => result



[Macro]
$+ arg &rest args => result



[Macro]
$- arg &rest args => result



[Macro]
$/ regex options => result



[Macro]
$< &rest args => result



[Macro]
$<= &rest args => result



[Macro]
$> &rest args => result



[Macro]
$>= &rest args => result



[Macro]
$add-to-set &rest args => result



[Macro]
$all &rest args => result



[Macro]
$em array &rest args => result



[Macro]
$exists &rest args => result



[Macro]
$in &rest args => result



[Macro]
$inc &rest args => result



[Macro]
$index collection &rest args => result



[Macro]
$map-reduce collection map reduce &key query limit out keeptemp finalize verbose => result


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>


[Macro]
$mod &rest args => result



[Macro]
$not &rest args => result



[Macro]
$pop-back &rest args => result



[Macro]
$pop-front &rest args => result



[Macro]
$pull &rest args => result



[Macro]
$pull-all &rest args => result



[Macro]
$push &rest args => result



[Macro]
$push-all &rest args => result



[Macro]
$set &rest args => result



[Macro]
$unset &rest args => result



[Macro]
$where &rest args => result



[Special variable]
*mongo-default-db*


database opened by the default connection


[Special variable]
*mongo-default-host*


host for the default connection.


[Special variable]
*mongo-default-port*


port for the default connection.


[Special variable]
*repo-root*


root of the repository; used for documentation generation


[Generic function]
add-element key value document => result


add element with key and value to a document


[Function]
cwd &key mongo => result


Show the current database.


[Function]
date-time second minute hour day month year &optional time-zone => result


Generate a time stamp the mongo/bson protocol understands.


[Generic function]
db.add-user username password &key mongo readonly => result


Add a user to the database.


[Generic function]
db.auth username password &key mongo => result


authenticate a user with a password


[Generic function]
db.collections &key mongo => result



[Function]
db.collections &key mongo => result


Show all the collections in the current database.


[Generic function]
db.count collection selector &key mongo => result


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.


[Generic function]
db.create-collection collection &key => result


create a collection


[Generic function]
db.delete collection object &key mongo => result


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.


[Generic function]
db.distinct collection key &key mongo => result


Return all the distinct values of this key in the collection


[Generic function]
db.ensure-index collection keys &key drop-duplicates unique mongo asc => result


Create an index specified by the keys in a collection


[Generic function]
db.eval code &rest rest => result


run javascript code server side


[Generic function]
db.find collection kv &key selector limit skip options mongo => result


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.


[Generic function]
db.indexes &key mongo => result



[Function]
db.indexes &key mongo => result


Return all indexes in the database.


[Generic function]
db.insert collection document &key mongo => result


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


[Generic function]
db.iter result &key limit mongo => result


next document iteration


[Generic function]
db.next collection cursor-id &key limit mongo => result


Executes the next call on the iterator identified by cursor-id.


[Generic function]
db.run-command cmd &key arg mongo collection index => result


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.


[Generic function]
db.save collection document &key mongo => result


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.


[Macro]
db.sort collection query &rest args => result


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


[Generic function]
db.stop cursor &key mongo => result


Stop iterating and clean up the iterator on the server by making a server call.


[Generic function]
db.update collection selector new-document &key mongo upsert multi => result


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.


[Generic function]
db.use db &key mongo => result


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


[Macro]
defjs name args declaration* statement* => result


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


[Macro]
defsrvjs name args declaration* statement* => result


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.


[Function]
do-query coll &key map-fn reduce-fn initial-value query mongo limit selector => result


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.


[Function]
doc-id doc => result


return the unique document id


[Function]
docs result => result


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


[Standard class]
document


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


[Function]
generate-readme &key path => result


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.


[Generic function]
get-element key document => result


Get an element identified by key from the document.


[Function]
ht->document ht => result


Convert a hash-table to a document.


[Macro]
install-js name => result


Allows server based javascripts the be installed without being run.


[Function]
iter result &key mongo max-per-call => result


Exhaustively iterate through a query. The maximum number of responses per query can be specified using the max-per-call keyword.


[Macro]
jsdef name => result


Return the body of the javascript function; otherwise nill.


[Generic function]
kv a &rest rest => result


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.


[Function]
make-document &key oid size => result


Constructor. key ':oid' is a user supplied unique id. An internal id will be generated if none is supplied.


[Function]
mapdoc fn document => result



[Standard class]
mongo


Encapsulates the connection to the mongo database. Each connection is a added to a global registry.


[Generic function]
mongo &key host port db name host port db name => result


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.


[Generic function]
mongo-close name => result


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


[Generic function]
mongo-registered name => result


Return a conection registered by this name or nil..


[Function]
mongo-show => result


Show all registered connections and their session id


[Generic function]
mongo-swap left right => result


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 &lt;newhost&gt; :portid &lt;portid&gt; :name :temp))) and a new default connection is registered.


[Function]
mr.gc &key mongo => result


remove the temporary collections created by map-reduce


[Function]
mr.gc.all &key mongo => result


remove the all collections created by map-reduce, temporary as well as permanent


[Function]
mr.p results => result


show the contents of the results collection map-reduce created


[Function]
nd result &key stream => result


Pretty-print for non-document responses, like the response to a database command.


[Function]
now => result


Return the current date and time in bson format.


[Function]
nwd => result


Show the database set by the (db.use -) command


[Generic function]
pp result &key nd stream => result


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.


[Macro]
remove-js name => result



[Function]
ret result => result


return value bound to retval in a return document. Used for db.count, db.distinct, functions etc..


[Function]
rm collection query &key mongo => result


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.


[Generic function]
rm-element key document => result


Remove element identified by key from a document


[Generic function]
show things &key msg nl order => result


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.


[Function]
time-zone => result


Set the time zone appropriate for the current environment.


[Macro]
with-mongo-connection args &rest body => result


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.


 

Acknowledgements

This documentation was prepared with DOCUMENTATION-TEMPLATE.

$Header: /usr/local/cvsrep/documentation-template/output.lisp,v 1.14 2008/05/29 08:23:37 edi Exp $

BACK TO MY HOMEPAGE


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 cl-mongo

Author

Fons Haffmans; fons.haffmans@gmail.com

License

MIT

Description

lisp system to interact with mongodb, a non-sql db

Version

0.7

Dependencies
Source

cl-mongo.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 cl-mongo/src

Parent

cl-mongo (system)

Location

src/

Components

Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Next: , Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 cl-mongo.asd

Location

cl-mongo.asd

Systems

cl-mongo (system)

Packages

cl-mongo-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.2 cl-mongo/src/packages.lisp

Parent

src (module)

Location

src/packages.lisp

Packages

cl-mongo


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.3 cl-mongo/src/octets.lisp

Dependency

packages.lisp (file)

Parent

src (module)

Location

src/octets.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.4 cl-mongo/src/pair.lisp

Dependency

octets.lisp (file)

Parent

src (module)

Location

src/pair.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.5 cl-mongo/src/encode-float.lisp

Dependency

pair.lisp (file)

Parent

src (module)

Location

src/encode-float.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.6 cl-mongo/src/bson-oid.lisp

Dependency

encode-float.lisp (file)

Parent

src (module)

Location

src/bson-oid.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.7 cl-mongo/src/bson-binary.lisp

Dependency

bson-oid.lisp (file)

Parent

src (module)

Location

src/bson-binary.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.8 cl-mongo/src/bson-time.lisp

Dependency

bson-binary.lisp (file)

Parent

src (module)

Location

src/bson-time.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.9 cl-mongo/src/bson-regex.lisp

Dependency

bson-time.lisp (file)

Parent

src (module)

Location

src/bson-regex.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.10 cl-mongo/src/bson-code.lisp

Dependency

bson-regex.lisp (file)

Parent

src (module)

Location

src/bson-code.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.11 cl-mongo/src/bson.lisp

Dependency

bson-code.lisp (file)

Parent

src (module)

Location

src/bson.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.12 cl-mongo/src/bson-decode.lisp

Dependency

bson.lisp (file)

Parent

src (module)

Location

src/bson-decode.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.13 cl-mongo/src/bson-array.lisp

Dependency

bson-decode.lisp (file)

Parent

src (module)

Location

src/bson-array.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.14 cl-mongo/src/document.lisp

Dependency

bson-array.lisp (file)

Parent

src (module)

Location

src/document.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.15 cl-mongo/src/mongo-syntax.lisp

Dependency

document.lisp (file)

Parent

src (module)

Location

src/mongo-syntax.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.16 cl-mongo/src/java-script.lisp

Dependency

mongo-syntax.lisp (file)

Parent

src (module)

Location

src/java-script.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.17 cl-mongo/src/bson-encode-container.lisp

Dependency

java-script.lisp (file)

Parent

src (module)

Location

src/bson-encode-container.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.18 cl-mongo/src/protocol.lisp

Dependency

bson-encode-container.lisp (file)

Parent

src (module)

Location

src/protocol.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.19 cl-mongo/src/mongo.lisp

Dependency

protocol.lisp (file)

Parent

src (module)

Location

src/mongo.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.20 cl-mongo/src/db.lisp

Dependency

mongo.lisp (file)

Parent

src (module)

Location

src/db.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.21 cl-mongo/src/mem.lisp

Dependency

db.lisp (file)

Parent

src (module)

Location

src/mem.lisp

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.22 cl-mongo/src/do-query.lisp

Dependency

mem.lisp (file)

Parent

src (module)

Location

src/do-query.lisp

Exported Definitions

do-query (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.23 cl-mongo/src/doc.lisp

Dependency

do-query.lisp (file)

Parent

src (module)

Location

src/doc.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.24 cl-mongo/src/map-reduce.lisp

Dependency

doc.lisp (file)

Parent

src (module)

Location

src/map-reduce.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

4.1.25 cl-mongo/src/shell.lisp

Dependency

map-reduce.lisp (file)

Parent

src (module)

Location

src/shell.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Files   [Contents][Index]

4.2 Other


Next: , Previous: , Up: Other files   [Contents][Index]

4.2.1 cl-mongo/README.md

Dependency

src (module)

Parent

cl-mongo (system)

Location

README.md


Previous: , Up: Other files   [Contents][Index]

4.2.2 cl-mongo/COPYING

Dependency

readme.md (file)

Parent

cl-mongo (system)

Location

COPYING


Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 cl-mongo-system

Source

cl-mongo.asd

Use List

Previous: , Up: Packages   [Contents][Index]

5.2 cl-mongo

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: *mongo-default-db*

database opened by the default connection

Package

cl-mongo

Source

mongo.lisp (file)

Special Variable: *mongo-default-host*

host for the default connection.

Package

cl-mongo

Source

mongo.lisp (file)

Special Variable: *mongo-default-port*

port for the default connection.

Package

cl-mongo

Source

mongo.lisp (file)

Special Variable: *repo-root*

root of the repository; used for documentation generation

Package

cl-mongo

Source

doc.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Macros

Macro: $ &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $!= &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $!in &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $+ ARG &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $- ARG &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $/ REGEX OPTIONS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $< &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $<= &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $> &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $>= &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $add-to-set &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $all &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $em ARRAY &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $exists &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $in &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $inc &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $index COLLECTION &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $map-reduce COLLECTION MAP REDUCE &key QUERY LIMIT OUT KEEPTEMP FINALIZE VERBOSE

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>

Package

cl-mongo

Source

map-reduce.lisp (file)

Macro: $mod &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $not &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $pop-back &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $pop-front &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $pull &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $pull-all &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $push &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $push-all &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $set &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $unset &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $where &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: db.sort COLLECTION QUERY &rest ARGS

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

Package

cl-mongo

Source

db.lisp (file)

Macro: defjs NAME ARGS &body BODY

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

Package

cl-mongo

Source

java-script.lisp (file)

Macro: defsrvjs NAME ARGS &body BODY

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.

Package

cl-mongo

Source

java-script.lisp (file)

Macro: install-js NAME

Allows server based javascripts the be installed without being run.

Package

cl-mongo

Source

java-script.lisp (file)

Macro: jsdef NAME

Return the body of the javascript function; otherwise nill.

Package

cl-mongo

Source

java-script.lisp (file)

Macro: remove-js NAME
Package

cl-mongo

Source

java-script.lisp (file)

Macro: with-mongo-connection ARGS &rest BODY

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.

Package

cl-mongo

Source

mongo.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.3 Functions

Function: bson-time-to-ut BSON-TIME
Package

cl-mongo

Source

bson-time.lisp (file)

Function: collect-all-elements KEY-LIST DOCUMENT-LIST
Package

cl-mongo

Source

document.lisp (file)

Function: cwd &key MONGO

Show the current database.

Package

cl-mongo

Source

mongo.lisp (file)

Function: date-time SECOND MINUTE HOUR DAY MONTH YEAR &optional TIME-ZONE

Generate a time stamp the mongo/bson protocol understands.

Package

cl-mongo

Source

shell.lisp (file)

Function: db.iterator RESULT

Returns the iterator from the result set.

Package

cl-mongo

Source

db.lisp (file)

Function: do-query COLL &key MAP-FN REDUCE-FN INITIAL-VALUE QUERY MONGO LIMIT SELECTOR

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.

Package

cl-mongo

Source

do-query.lisp (file)

Function: doc-id DOC

return the unique document id

Package

cl-mongo

Source

document.lisp (file)

Function: docs RESULT

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

Package

cl-mongo

Source

shell.lisp (file)

Function: generate-readme &key PATH

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.

Package

cl-mongo

Source

doc.lisp (file)

Function: ht->document HT

Convert a hash-table to a document.

Package

cl-mongo

Source

document.lisp (file)

Function: iter RESULT &key MONGO MAX-PER-CALL

Exhaustively iterate through a query. The maximum number of responses per query can be specified using the max-per-call keyword.

Package

cl-mongo

Source

shell.lisp (file)

Function: make-document &key OID SIZE

Constructor. key ’:oid’ is a user supplied unique id. An internal id will be generated if none is supplied.

Package

cl-mongo

Source

document.lisp (file)

Function: mapdoc FN DOCUMENT
Package

cl-mongo

Source

document.lisp (file)

Function: mongo-show ()

Show all registered connections and their session id

Package

cl-mongo

Source

mongo.lisp (file)

Function: mr.gc &key MONGO

remove the temporary collections created by map-reduce

Package

cl-mongo

Source

map-reduce.lisp (file)

Function: mr.gc.all &key MONGO

remove the all collections created by map-reduce, temporary as well as permanent

Package

cl-mongo

Source

map-reduce.lisp (file)

Function: mr.p RESULTS

show the contents of the results collection map-reduce created

Package

cl-mongo

Source

map-reduce.lisp (file)

Function: nd RESULT &key STREAM

Pretty-print for non-document responses, like the response to a database command.

Package

cl-mongo

Source

shell.lisp (file)

Function: now ()

Return the current date and time in bson format.

Package

cl-mongo

Source

shell.lisp (file)

Function: nwd ()

Show the database set by the ‘(db.use -)‘ command

Package

cl-mongo

Source

mongo.lisp (file)

Function: ret RESULT

return value bound to retval in a return document. Used for db.count, db.distinct, functions etc..

Package

cl-mongo

Source

shell.lisp (file)

Function: rm COLLECTION QUERY &key MONGO

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.

Package

cl-mongo

Source

shell.lisp (file)

Function: time-zone ()

Set the time zone appropriate for the current environment.

Package

cl-mongo

Source

bson-time.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.4 Generic functions

Generic Function: add-element KEY VALUE DOCUMENT

add element with key and value to a document

Package

cl-mongo

Source

document.lisp (file)

Methods
Method: add-element (KEY string) VALUE (DOCUMENT document)
Method: add-element KEY VALUE DOCUMENT
Generic Function: db.add-user USERNAME PASSWORD &key MONGO READONLY

Add a user to the database.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.add-user (USERNAME string) (PASSWORD string) &key MONGO READONLY
Generic Function: db.auth USERNAME PASSWORD &key MONGO

authenticate a user with a password

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.auth (USERNAME string) (PASSWORD string) &key MONGO
Generic Function: db.collections &key MONGO
Package

cl-mongo

Methods
Method: db.collections &key MONGO

Show all the collections in the current database.

Source

db.lisp (file)

Generic Function: db.count COLLECTION SELECTOR &key MONGO

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.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.count COLLECTION (SELECTOR pair) &key MONGO
Method: db.count COLLECTION (SELECTOR (eql all)) &key MONGO
Method: db.count COLLECTION SELECTOR &key MONGO
Generic Function: db.create-collection COLLECTION &key

create a collection

Package

cl-mongo

Source

db.lisp (file)

Generic Function: db.delete COLLECTION OBJECT &key MONGO

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.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.delete (COLLECTION string) (KV pair) &key MONGO
Method: db.delete (COLLECTION string) (DOCUMENT kv-container) &key MONGO
Method: db.delete (COLLECTION string) (DOCUMENTS cons) &key MONGO
Method: db.delete (COLLECTION string) (DOCUMENT document) &key MONGO
Method: db.delete COLLECTION (DOCUMENT (eql nil)) &key MONGO
Generic Function: db.distinct COLLECTION KEY &key MONGO

Return all the distinct values of this key in the collection

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.distinct (COLLECTION string) (KEY string) &key MONGO
Generic Function: db.ensure-index COLLECTION KEYS &key MONGO UNIQUE DROP-DUPLICATES ASC

Create an index specified by the keys in a collection

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.ensure-index (COLLECTION string) (KEY pair) &key MONGO UNIQUE DROP-DUPLICATES
Method: db.ensure-index (COLLECTION string) (KEY string) &key MONGO UNIQUE ASC DROP-DUPLICATES
Method: db.ensure-index (COLLECTION string) (INDEX kv-container) &key MONGO UNIQUE DROP-DUPLICATES
Method: db.ensure-index (COLLECTION string) (INDEX hash-table) &key MONGO UNIQUE DROP-DUPLICATES
Generic Function: db.eval CODE &rest REST

run javascript code server side

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.eval (CODE string) &rest ARGS
Generic Function: db.find COLLECTION KV &key MONGO OPTIONS SKIP LIMIT SELECTOR

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.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.find (COLLECTION string) (KV kv-container) &key MONGO OPTIONS SKIP LIMIT SELECTOR
Method: db.find (COLLECTION string) (KV hash-table) &key MONGO OPTIONS SKIP LIMIT SELECTOR
Method: db.find (COLLECTION string) (KV pair) &key MONGO OPTIONS SKIP LIMIT SELECTOR
Method: db.find (COLLECTION string) (KV integer) &key MONGO OPTIONS SKIP SELECTOR
Method: db.find (COLLECTION string) (KV (eql all)) &key MONGO OPTIONS SKIP LIMIT SELECTOR
Method: db.find (COLLECTION symbol) KV &key MONGO OPTIONS SKIP LIMIT SELECTOR
Method: db.find (COLLECTION string) KV &key MONGO OPTIONS SKIP LIMIT SELECTOR
Generic Function: db.indexes &key MONGO
Package

cl-mongo

Methods
Method: db.indexes &key MONGO

Return all indexes in the database.

Source

db.lisp (file)

Generic Function: db.insert COLLECTION DOCUMENT &key MONGO

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

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.insert (COLLECTION string) DOCUMENT &key MONGO
Generic Function: db.iter RESULT &key MONGO LIMIT

next document iteration

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.iter (RESULT cons) &key MONGO LIMIT
Method: db.iter (RESULT (eql nil)) &key
Generic Function: db.next COLLECTION CURSOR-ID &key MONGO LIMIT

Executes the next call on the iterator identified by cursor-id.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.next (COLLECTION string) (CURSOR-ID integer) &key MONGO LIMIT
Method: db.next (COLLECTION (eql nil)) (CURSOR-ID (eql 0)) &key MONGO LIMIT
Method: db.next (COLLECTION (eql nil)) (CURSOR-ID (eql nil)) &key MONGO LIMIT
Generic Function: db.run-command CMD &key MONGO COLLECTION INDEX ARG

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.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.run-command (CMD (eql drop)) &key MONGO COLLECTION INDEX
Method: db.run-command (CMD (eql dropindexes)) &key MONGO COLLECTION INDEX
Method: db.run-command (CMD (eql deleteindexes)) &key MONGO COLLECTION INDEX
Method: db.run-command (CMD (eql serverstatus)) &key MONGO
Method: db.run-command (CMD (eql listdatabases)) &key MONGO
Method: db.run-command (CMD (eql querytracelevel)) &key MONGO ARG
Method: db.run-command (CMD string) &key MONGO ARG
Method: db.run-command (CMD symbol) &key MONGO ARG
Generic Function: db.save COLLECTION DOCUMENT &key MONGO

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

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.save (COLLECTION string) (DOCUMENT kv-container) &key MONGO
Method: db.save (COLLECTION string) (DOCUMENT hash-table) &key MONGO
Method: db.save (COLLECTION string) (DOCUMENT document) &key MONGO
Generic Function: db.stop CURSOR &key MONGO

Stop iterating and clean up the iterator on the server by making a server call.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.stop (RESULT cons) &key MONGO
Method: db.stop (CURSOR integer) &key MONGO
Method: db.stop (CURSOR (eql 0)) &key MONGO
Method: db.stop (CURSOR (eql nil)) &key MONGO
Generic Function: db.update COLLECTION SELECTOR NEW-DOCUMENT &key MONGO UPSERT MULTI

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.

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: db.update (COLLECTION string) SELECTOR NEW-DOCUMENT &key MONGO UPSERT MULTI
Generic Function: db.use DB &key MONGO

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

Package

cl-mongo

Source

mongo.lisp (file)

Methods
Method: db.use (DB cons) &key MONGO
Method: db.use (DB string) &key MONGO
Generic Function: get-element KEY DOCUMENT

Get an element identified by key from the document. To get the _id use :_id as the key

Package

cl-mongo

Source

document.lisp (file)

Methods
Method: get-element (KEY string) (DOCUMENT cons)
Method: get-element (KEY string) (DOCUMENT document)
Method: get-element (KEY-LIST cons) (DOCUMENT document)
Method: get-element (KEY (eql _id)) (DOCS cons)
Method: get-element (KEY (eql _id)) (DOCUMENT document)
Method: get-element (KEY string) (DOCUMENT (eql nil))
Generic Function: get-keys DOCUMENT

Gets a list of keys that are in the document

Package

cl-mongo

Source

document.lisp (file)

Methods
Method: get-keys (DOCUMENT document)
Generic Function: kv A &rest REST

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.

Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv (A pair) &rest REST
Method: kv (KV-CONTAINER kv-container) &rest REST
Method: kv (A symbol) &rest REST
Method: kv (A string) &rest REST
Method: kv (A (eql nil)) &rest REST
Generic Function: mongo &key HOST PORT DB NAME

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.

Package

cl-mongo

Source

mongo.lisp (file)

Methods
Method: mongo &key HOST PORT DB NAME
Generic Function: mongo-close NAME

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

Package

cl-mongo

Source

mongo.lisp (file)

Methods
Method: mongo-close (NAME (eql all))
Method: mongo-close NAME
Method: mongo-close (MONGO mongo)
Generic Function: mongo-registered NAME

Return a conection registered by this name or nil..

Package

cl-mongo

Source

mongo.lisp (file)

Methods
Method: mongo-registered NAME
Generic Function: mongo-swap LEFT RIGHT

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.

Package

cl-mongo

Source

mongo.lisp (file)

Methods
Method: mongo-swap (LEFT (eql default)) (RIGHT mongo)
Method: mongo-swap LEFT RIGHT
Method: mongo-swap (LEFT mongo) (RIGHT mongo)
Generic Function: pp RESULT &key STREAM ND

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.

Package

cl-mongo

Source

shell.lisp (file)

Methods
Method: pp (RESULT cons) &key STREAM ND
Method: pp (RESULT (eql nil)) &key
Generic Function: rm-element KEY DOCUMENT

Remove element identified by key from a document

Package

cl-mongo

Source

document.lisp (file)

Methods
Method: rm-element (KEY string) (DOCUMENT document)
Generic Function: show THINGS &key ORDER NL MSG

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.

Package

cl-mongo

Source

shell.lisp (file)

Methods
Method: show (THINGS (eql errors)) &key ORDER
Method: show (THINGS (eql preverror)) &key ORDER
Method: show (THINGS (eql lasterror)) &key ORDER
Method: show (THINGS (eql assertinfo)) &key ORDER
Method: show (THINGS (eql status)) &key ORDER
Method: show (THINGS (eql users)) &key ORDER
Method: show (THINGS (eql buildinfo)) &key after
Method: show (THINGS (eql buildinfo)) &key before
Method: show (THINGS (eql buildinfo)) &key ORDER
Method: show (THINGS (eql databases)) &key after
Method: show (THINGS (eql databases)) &key before
Method: show (THINGS (eql databases)) &key ORDER
Method: show (THINGS (eql indexes)) &key ORDER
Method: show (THINGS (eql collections)) &key ORDER
Method: show (FUNC function) &key ORDER NL MSG
Method: show (THINGS (eql connections)) &key

Previous: , Up: Exported definitions   [Contents][Index]

6.1.5 Classes

Class: document ()

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

Package

cl-mongo

Source

document.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: elements
Initargs

:elements

Readers

elements (generic function)

Writers

(setf elements) (generic function)

Slot: _local_id
Initargs

:local

Readers

_local (generic function)

Slot: _id
Initargs

:oid

Readers

_id (generic function)

Direct Default Initargs
InitargValue
:localt
:oid(cl-mongo::make-bson-oid)
Class: mongo ()

Encapsulates the connection to the mongo database. Each connection is a added to a global registry.

Package

cl-mongo

Source

mongo.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: port
Initargs

:port

Readers

port (generic function)

Slot: host
Initargs

:host

Readers

host (generic function)

Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: socket
Initargs

:socket

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: id
Initform

(uuid:make-v4-uuid)

Readers

id (generic function)

Slot: db
Initargs

:db

Readers

db (generic function)

Writers

(setf db) (generic function)


Previous: , Up: Definitions   [Contents][Index]

6.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.1 Constants

Constant: +bson-binary+

ordinary binary

Package

cl-mongo

Source

bson-binary.lisp (file)

Constant: +bson-binary-function+

function

Package

cl-mongo

Source

bson-binary.lisp (file)

Constant: +bson-binary-generic+

binary/generic

Package

cl-mongo

Source

bson-binary.lisp (file)

Constant: +bson-binary-md5+

md5

Package

cl-mongo

Source

bson-binary.lisp (file)

Constant: +bson-binary-user+

user defined

Package

cl-mongo

Source

bson-binary.lisp (file)

Constant: +bson-binary-uuid+

uuid

Package

cl-mongo

Source

bson-binary.lisp (file)

Constant: +bson-data-array+

bson array

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-binary+

bson binary

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-boolean+

bson boolean encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-code+

bson code encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-code_w_s+

bson javascript with scope

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-date+

bson date encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-dbpointer+

bson db pointer encoding/deprecated

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-int32+

bson 32 bit int encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-long+

bson 64 bit int encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-max-key+

bson data ultimate maximum

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-min-key+

bson data ultimate minimum

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-null+

bson null encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-number+

bson number encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-object+

bson data array; bson object

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-oid+

bson oid encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-regex+

bson regex encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-string+

bson string encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-symbol+

bson symbol encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-timestamp+

bson 32 bit int encoding

Package

cl-mongo

Source

bson.lisp (file)

Constant: +bson-data-undefined+

undefined/deprecated

Package

cl-mongo

Source

bson.lisp (file)

Constant: +default-array-size+

size of default array in the encoder

Package

cl-mongo

Source

bson.lisp (file)

Constant: +java-script-epoch+

(encode-universal-time 0 0 0 1 1 1970 0)

Package

cl-mongo

Source

bson-time.lisp (file)

Constant: +max-uint32+

max + 1 value of unsigned 32 bit integer

Package

cl-mongo

Source

octets.lisp (file)

Constant: +max-uint64+

max + 1 value of unsigned 64 bit integer

Package

cl-mongo

Source

octets.lisp (file)

Constant: +milliseconds-multiplier+

’convert’ to milliseconds

Package

cl-mongo

Source

bson-time.lisp (file)

Constant: +mongo-delete+

delete command

Package

cl-mongo

Source

protocol.lisp (file)

Constant: +mongo-get-more+

request for more docs/next cursor iterator

Package

cl-mongo

Source

protocol.lisp (file)

Constant: +mongo-insert+

insert command

Package

cl-mongo

Source

protocol.lisp (file)

Constant: +mongo-kill-cursors+

kill the cursor/reclaim db resources

Package

cl-mongo

Source

protocol.lisp (file)

Constant: +mongo-port+
Package

cl-mongo

Source

mongo.lisp (file)

Constant: +mongo-query+

query command

Package

cl-mongo

Source

protocol.lisp (file)

Constant: +mongo-update+

update/insert command

Package

cl-mongo

Source

protocol.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.2 Special variables

Special Variable: *bt-time-zone*

the current time zone; 5 -> EST

Package

cl-mongo

Source

bson-time.lisp (file)

Special Variable: *db.use-history*

an attempt to record the history of the shell

Package

cl-mongo

Source

mongo.lisp (file)

Special Variable: *indent*
Package

cl-mongo

Source

shell.lisp (file)

Special Variable: *js-definitions*

hash table containing client side javascript

Package

cl-mongo

Source

java-script.lisp (file)

Special Variable: *mongo-registry*

hash table of all open mongo connections

Package

cl-mongo

Source

mongo.lisp (file)

Special Variable: *q*
Package

cl-mongo

Source

do-query.lisp (file)

Special Variable: *r*
Package

cl-mongo

Source

do-query.lisp (file)

Special Variable: *runners*
Package

cl-mongo

Source

do-query.lisp (file)

Special Variable: +bt-day-names+
Package

cl-mongo

Source

bson-time.lisp (file)

Special Variable: +bt-months+
Package

cl-mongo

Source

bson-time.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.3 Macros

Macro: $exp+ &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $kv-eval &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $op OP &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $op* OP &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $range &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: $size &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: construct-$+- VAL ARG &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: construct-container* VALUE ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: construct-container-lst* ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: expand-selector &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: jssrvdef NAME

Return the body of the javascript function as installed on the server; otherwise nill.

Package

cl-mongo

Source

java-script.lisp (file)

Macro: set-keys &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: upd OP &rest ARGS
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Macro: with-indent &body BODY
Package

cl-mongo

Source

shell.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.4 Functions

Function: add-integer INT32 ARRAY
Package

cl-mongo

Source

octets.lisp (file)

Function: add-octets SOURCE TARGET &key START FROM-END
Package

cl-mongo

Source

octets.lisp (file)

Function: add-to-array ELEM ARR
Package

cl-mongo

Source

octets.lisp (file)

Function: add-to-registry MONGO
Package

cl-mongo

Source

mongo.lisp (file)

Function: append-to-octet-vector SOURCE TARGET
Package

cl-mongo

Source

octets.lisp (file)

Function: asc/desc->+1/-1 HT
Package

cl-mongo

Source

db.lisp (file)

Function: bind-return VAL RESULT

return value bound to val in a return document. Used for count etc..

Package

cl-mongo

Source

shell.lisp (file)

Function: bool-to-byte VAL
Package

cl-mongo

Source

octets.lisp (file)

Function: bson-decode TOTLEN POS DOCS ARRAY &key CONTAINER
Package

cl-mongo

Source

bson-decode.lisp (file)

Function: bson-encode-array KEY &key ARRAY TYPE ENCODER
Package

cl-mongo

Source

bson.lisp (file)

Function: bson-encode-cons LIST STACK BSON-ARRAY-STACK
Package

cl-mongo

Source

bson-array.lisp (file)

Function: byte-to-bool VAL
Package

cl-mongo

Source

octets.lisp (file)

Function: byte-to-octet VAL
Package

cl-mongo

Source

octets.lisp (file)

Function: collect-args LST &optional ACCUM
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Function: collect-to-hash HT DOC
Package

cl-mongo

Source

do-query.lisp (file)

Function: connection? NAME
Package

cl-mongo

Source

mongo.lisp (file)

Function: copy-pair INSTANCE
Package

cl-mongo

Source

pair.lisp (file)

Function: count-it COLLECTION KEY
Package

cl-mongo

Source

db.lisp (file)

Function: customize STR
Package

cl-mongo

Source

doc.lisp (file)

Function: decode-double-float-bits BITS
Package

cl-mongo

Source

encode-float.lisp (file)

Function: decode-float-bits BITS SIGN-BYTE EXPONENT-BYTE MANTISSA-BYTE BIAS
Package

cl-mongo

Source

encode-float.lisp (file)

Function: default? ()
Package

cl-mongo

Source

mongo.lisp (file)

Function: denormalize MANTISSA EXPONENT BIAS MANTISSA-BYTE
Package

cl-mongo

Source

encode-float.lisp (file)

Function: do-reduce FN &key INITIAL-VALUE
Package

cl-mongo

Source

do-query.lisp (file)

Function: empty-str STR
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Function: encode-double-float-bits FLOAT
Package

cl-mongo

Source

encode-float.lisp (file)

Function: encode-float-bits FLOAT SIGN-BYTE EXPONENT-BYTE MANTISSA-BYTE BIAS
Package

cl-mongo

Source

encode-float.lisp (file)

Function: end-of-key START ARRAY
Package

cl-mongo

Source

bson-decode.lisp (file)

Function: error-on-key-exists KEY
Package

cl-mongo

Source

mongo.lisp (file)

Function: gen-clean GEN
Package

cl-mongo

Source

mem.lisp (file)

Function: gendoc TARGET
Package

cl-mongo

Source

doc.lisp (file)

Function: get-all-values KEY LIST-OF-DOCS
Package

cl-mongo

Source

document.lisp (file)

Function: gmt-to-bson-time GMT
Package

cl-mongo

Source

bson-time.lisp (file)

Function: hash-keys HT
Package

cl-mongo

Source

document.lisp (file)

Function: header+docsp VAL
Package

cl-mongo

Source

db.lisp (file)

Function: headerp VAL
Package

cl-mongo

Source

db.lisp (file)

Function: hex-md5 STR
Package

cl-mongo

Source

db.lisp (file)

Function: ht->document.1 HT
Package

cl-mongo

Source

document.lisp (file)

Function: ht->list.1 HT
Package

cl-mongo

Source

bson-decode.lisp (file)

Function: ht-test SIZE
Package

cl-mongo

Source

document.lisp (file)

Function: int32-to-octet VAL
Package

cl-mongo

Source

octets.lisp (file)

Function: int64-to-octet VAL
Package

cl-mongo

Source

octets.lisp (file)

Function: js-show ()
Package

cl-mongo

Source

java-script.lisp (file)

Function: load-file PATH
Package

cl-mongo

Source

doc.lisp (file)

Function: make-bson-array &key SIZE
Package

cl-mongo

Source

bson-array.lisp (file)

Function: make-bson-code JS
Package

cl-mongo

Source

bson-code.lisp (file)

Function: make-bson-oid &key OID
Package

cl-mongo

Source

bson-oid.lisp (file)

Function: make-bson-regex REGEX OPTIONS
Package

cl-mongo

Source

bson-regex.lisp (file)

Function: make-bson-time &optional RAW-TIME
Package

cl-mongo

Source

bson-time.lisp (file)

Function: make-elements SIZE
Package

cl-mongo

Source

document.lisp (file)

Function: make-fixed-size-octet-vector SZ
Package

cl-mongo

Source

octets.lisp (file)

Function: make-int-vector SZ &key INIT-FILL
Package

cl-mongo

Source

bson-array.lisp (file)

Function: make-kv-container ()
Package

cl-mongo

Source

pair.lisp (file)

Function: make-mongo &key HOST PORT DB NAME
Package

cl-mongo

Source

mongo.lisp (file)

Function: make-octet-vector SZ &key INIT-FILL
Package

cl-mongo

Source

octets.lisp (file)

Function: map-reduce-op OP LST
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Function: mongo-ids ()
Package

cl-mongo

Source

mongo.lisp (file)

Function: mongo-registry ()
Package

cl-mongo

Source

mongo.lisp (file)

Function: mongo-reply ARRAY

Extract reply parameters

Package

cl-mongo

Source

protocol.lisp (file)

Function: mongodb-reader COLL LOCK CV &key QUERY MONGO LIMIT SELECTOR
Package

cl-mongo

Source

do-query.lisp (file)

Function: mr.collections &key MONGO
Package

cl-mongo

Source

map-reduce.lisp (file)

Function: mr.gc* QUERY &key MONGO
Package

cl-mongo

Source

map-reduce.lisp (file)

Function: new-line STREAM
Package

cl-mongo

Source

shell.lisp (file)

Function: normalize-args LST &optional ACCUM
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Function: normalize-array ARRAY
Package

cl-mongo

Source

bson-array.lisp (file)

Function: normalize-bson-array ARRAY
Package

cl-mongo

Source

bson-array.lisp (file)

Function: null-terminate-array ARRAY
Package

cl-mongo

Source

bson.lisp (file)

Function: null-terminated-octet-to-string ARR LENGTH
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-byte VEC
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-byte.1 VEC START
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-int32 VEC
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-int32.1 VEC START
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-int64 VEC
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-int64.1 VEC START
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-uint64 VEC
Package

cl-mongo

Source

octets.lisp (file)

Function: octet-to-uint64.1 VEC START
Package

cl-mongo

Source

octets.lisp (file)

Function: op-split LST &optional ACCUM
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Function: pair KEY VALUE
Package

cl-mongo

Source

pair.lisp (file)

Function: pair-key INSTANCE
Function: (setf pair-key) VALUE INSTANCE
Package

cl-mongo

Source

pair.lisp (file)

Function: pair-p OBJECT
Package

cl-mongo

Source

pair.lisp (file)

Function: pair-value INSTANCE
Function: (setf pair-value) VALUE INSTANCE
Package

cl-mongo

Source

pair.lisp (file)

Function: perf.db.find COLLECTION QM &key QUERY MONGO OPTIONS SKIP LIMIT SELECTOR
Package

cl-mongo

Source

do-query.lisp (file)

Function: perf.mongo-reply ARRAY
Package

cl-mongo

Source

do-query.lisp (file)

Function: pop-from-array ARR
Package

cl-mongo

Source

bson-array.lisp (file)

Function: positive VAL
Package

cl-mongo

Source

octets.lisp (file)

Function: print-doc DOC &key ORDER NL MSG
Package

cl-mongo

Source

shell.lisp (file)

Function: print-hash HT STREAM &key MAX
Package

cl-mongo

Source

document.lisp (file)

Function: queue-reader FN LOCK CV LOCK2 CV2
Package

cl-mongo

Source

do-query.lisp (file)

Function: read-back MONGO
Package

cl-mongo

Source

mongo.lisp (file)

Function: read-buffer MONGO TIMEOUT STATE &optional ACCUM
Package

cl-mongo

Source

mongo.lisp (file)

Function: read-ready MONGO TIMEOUT
Package

cl-mongo

Source

mongo.lisp (file)

Function: rebuild* L ACCUM
Package

cl-mongo

Source

doc.lisp (file)

Function: reclaim-memory ()
Package

cl-mongo

Source

mem.lisp (file)

Function: restore-default-connection NAME
Package

cl-mongo

Source

mongo.lisp (file)

Function: rm* RESULT &key MONGO

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.

Package

cl-mongo

Source

shell.lisp (file)

Function: scale MANTISSA EXPONENT MANTISSA-BITS
Package

cl-mongo

Source

encode-float.lisp (file)

Function: scale-integer VALUE BITS
Package

cl-mongo

Source

encode-float.lisp (file)

Function: segment* STR ACCUM
Package

cl-mongo

Source

doc.lisp (file)

Function: select-body STR
Package

cl-mongo

Source

doc.lisp (file)

Function: set-array-length ARRAY &key START
Package

cl-mongo

Source

bson.lisp (file)

Function: set-octets START SOURCE TARGET
Package

cl-mongo

Source

octets.lisp (file)

Function: slurp-stream STREAM
Package

cl-mongo

Source

doc.lisp (file)

Function: str-md5 MD5
Package

cl-mongo

Source

bson-binary.lisp (file)

Function: string-replace SEP NEW STR
Package

cl-mongo

Source

doc.lisp (file)

Function: string-replace* SEP NEW STR
Package

cl-mongo

Source

doc.lisp (file)

Function: string-to-null-terminated-octet STR
Package

cl-mongo

Source

octets.lisp (file)

Function: strip-comments STR
Package

cl-mongo

Source

doc.lisp (file)

Function: switch-default-connection NAME &key HOST DB PORT
Package

cl-mongo

Source

mongo.lisp (file)

Function: test-for-readback STREAM TIMEOUT
Package

cl-mongo

Source

mongo.lisp (file)

Function: test-for-readback* STREAM TIMEOUT
Package

cl-mongo

Source

mongo.lisp (file)

Function: th-reader FUN LOCK-Q CV-Q LOCK-R CV-R
Package

cl-mongo

Source

do-query.lisp (file)

Function: th-status ()
Package

cl-mongo

Source

do-query.lisp (file)

Function: th-writer COLL LOCK CV &key QUERY MONGO LIMIT SELECTOR
Package

cl-mongo

Source

do-query.lisp (file)

Function: to-octet VAL SIZE
Package

cl-mongo

Source

octets.lisp (file)

Function: to-signed-value VALUE &key SIZE MAX-UINT
Package

cl-mongo

Source

octets.lisp (file)

Function: to-val VEC SIZE
Package

cl-mongo

Source

octets.lisp (file)

Function: to-val.1 VEC START SIZE
Package

cl-mongo

Source

octets.lisp (file)

Function: tor FN
Package

cl-mongo

Source

do-query.lisp (file)

Function: unwrap LST
Package

cl-mongo

Source

mongo-syntax.lisp (file)

Function: update-options &key UPSERT MULTI-UPDATE
Package

cl-mongo

Source

protocol.lisp (file)

Function: write-file PATH STR
Package

cl-mongo

Source

doc.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.5 Generic functions

Generic Function: _id BSON-OID

return a 12 byte array, irrespective of the internals of bson-oid, which may have a larger array

Package

cl-mongo

Source

bson-oid.lisp (file)

Methods
Method: _id (DOCUMENT document)

automatically generated reader method

Source

document.lisp (file)

Method: _id (BSON-OID bson-oid)
Generic Function: _local OBJECT
Package

cl-mongo

Methods
Method: _local (DOCUMENT document)

automatically generated reader method

Source

document.lisp (file)

Generic Function: bson-array-pop ARRAY

pop element from arrray

Package

cl-mongo

Source

bson-array.lisp (file)

Methods
Method: bson-array-pop (ARRAY bson-array)
Generic Function: bson-array-pop-element ARRAY
Package

cl-mongo

Methods
Method: bson-array-pop-element (ARRAY bson-array)
Source

bson-array.lisp (file)

Generic Function: bson-array-push ELEMENT ARRAY

push element to arrray

Package

cl-mongo

Source

bson-array.lisp (file)

Methods
Method: bson-array-push ELEMENT (ARRAY bson-array)
Generic Function: bson-array-reset ARRAY
Package

cl-mongo

Source

bson-array.lisp (file)

Methods
Method: bson-array-reset (ARRAY bson-array)
Generic Function: bson-binary TYPE DATA

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.

Package

cl-mongo

Source

bson-binary.lisp (file)

Methods
Method: bson-binary (TYPE (eql 128)) DATA
Method: bson-binary (TYPE (eql user)) DATA
Method: bson-binary (TYPE (eql 3)) DATA
Method: bson-binary (TYPE (eql uuid)) DATA
Method: bson-binary (TYPE (eql 5)) DATA
Method: bson-binary (TYPE (eql md5)) DATA
Method: bson-binary (TYPE (eql 2)) DATA
Method: bson-binary (TYPE (eql binary)) DATA
Method: bson-binary (TYPE (eql 1)) DATA
Method: bson-binary (TYPE (eql function)) DATA
Generic Function: bson-encode KEY VALUE &key ARRAY SIZE TYPE ENCODER

encode a bson data element

Package

cl-mongo

Source

bson.lisp (file)

Methods
Method: bson-encode (KEY string) (VALUE pair) &key
Source

bson-encode-container.lisp (file)

Method: bson-encode (KEY string) (VALUE kv-container) &key
Source

bson-encode-container.lisp (file)

Method: bson-encode (KEY string) (VALUE document) &key
Source

bson-encode-container.lisp (file)

Method: bson-encode (KEY string) (VALUE hash-table) &key
Source

bson-encode-container.lisp (file)

Method: bson-encode (KEY string) (VALUE cons) &key
Source

bson-array.lisp (file)

Method: bson-encode (KEY string) (VALUE bson-array) &key ARRAY SIZE TYPE ENCODER
Source

bson-array.lisp (file)

Method: bson-encode (KEY string) (VALUE bson-regex) &key ARRAY
Method: bson-encode (KEY string) (VALUE float) &key ARRAY
Method: bson-encode (KEY string) (VALUE integer) &key ARRAY
Method: bson-encode (KEY string) (VALUE string) &key ARRAY TYPE
Method: bson-encode (KEY string) (VALUE bson-oid) &key ARRAY
Method: bson-encode (KEY string) (VALUE symbol) &key ARRAY
Method: bson-encode (KEY string) (VALUE bson-code) &key ARRAY
Method: bson-encode (KEY string) (VALUE bson-time) &key ARRAY
Method: bson-encode (KEY string) (VALUE (eql nil)) &key ARRAY
Method: bson-encode (KEY string) (VALUE (eql t)) &key ARRAY
Method: bson-encode (KEY string) (VALUE array) &key ARRAY TYPE ENCODER
Method: bson-encode (KEY string) (VALUE bson-binary) &key ARRAY TYPE

the ordinary binary type as some structure in that the length of the binary array is encoded

Method: bson-encode (KEY string) (VALUE bson-binary-base) &key ARRAY TYPE
Method: bson-encode (KEY integer) VALUE &key
Method: bson-encode (KEY (eql nil)) (VALUE (eql nil)) &key ARRAY
Method: bson-encode (KEY string) VALUE &key ARRAY TYPE ENCODER
Generic Function: bson-encode-container CONTAINER &key ARRAY SIZE

encode a container of key-value pairs..

Package

cl-mongo

Source

bson-encode-container.lisp (file)

Methods
Method: bson-encode-container (KV pair) &key
Method: bson-encode-container (KV-CONTAINER kv-container) &key ARRAY SIZE
Method: bson-encode-container (CONTAINER hash-table) &key ARRAY SIZE
Method: bson-encode-container (CONTAINER document) &key ARRAY SIZE
Method: bson-encode-container (CONTAINER (eql nil)) &key ARRAY
Generic Function: code OBJECT
Package

cl-mongo

Methods
Method: code (BSON-CODE bson-code)

automatically generated reader method

Source

bson-code.lisp (file)

Generic Function: container OBJECT
Generic Function: (setf container) NEW-VALUE OBJECT
Package

cl-mongo

Methods
Method: container (KV-CONTAINER kv-container)

automatically generated reader method

Source

pair.lisp (file)

Method: (setf container) NEW-VALUE (KV-CONTAINER kv-container)

automatically generated writer method

Source

pair.lisp (file)

Generic Function: data OBJECT
Package

cl-mongo

Methods
Method: data (BSON-BINARY-BASE bson-binary-base)

automatically generated reader method

Source

bson-binary.lisp (file)

Generic Function: data-array OBJECT
Generic Function: (setf data-array) NEW-VALUE OBJECT
Package

cl-mongo

Methods
Method: data-array (BSON-ARRAY bson-array)

automatically generated reader method

Source

bson-array.lisp (file)

Method: (setf data-array) NEW-VALUE (BSON-ARRAY bson-array)

automatically generated writer method

Source

bson-array.lisp (file)

Generic Function: db OBJECT
Generic Function: (setf db) NEW-VALUE OBJECT
Package

cl-mongo

Methods
Method: db (MONGO mongo)

automatically generated reader method

Source

mongo.lisp (file)

Method: (setf db) NEW-VALUE (MONGO mongo)

automatically generated writer method

Source

mongo.lisp (file)

Generic Function: decode TIME

decode the bson-time for human consumption

Package

cl-mongo

Source

bson-time.lisp (file)

Methods
Method: decode (BSON-TIME bson-time)
Generic Function: doc-elements DOCUMENT
Package

cl-mongo

Source

document.lisp (file)

Methods
Method: doc-elements (DOCUMENT document)
Method: doc-elements (DOCUMENT hash-table)
Generic Function: elements OBJECT
Generic Function: (setf elements) NEW-VALUE OBJECT
Package

cl-mongo

Methods
Method: elements (DOCUMENT document)

automatically generated reader method

Source

document.lisp (file)

Method: (setf elements) NEW-VALUE (DOCUMENT document)

automatically generated writer method

Source

document.lisp (file)

Generic Function: elp ELEMENT
Package

cl-mongo

Source

shell.lisp (file)

Methods
Method: elp (ELEMENT cons)
Method: elp (DOC document)
Method: elp ELEMENT
Generic Function: fmt BSON-TIME &optional STREAM

format bson time to be in human readable form

Package

cl-mongo

Source

bson-time.lisp (file)

Methods
Method: fmt (BSON-TIME bson-time) &optional STREAM
Generic Function: full-collection-name MONGO COLLECTION

generate the full collection name

Package

cl-mongo

Source

db.lisp (file)

Methods
Method: full-collection-name (MONGO mongo) (COLLECTION string)
Generic Function: get-id ID
Package

cl-mongo

Source

document.lisp (file)

Methods
Method: get-id (ID bson-oid)
Method: get-id ID
Generic Function: host OBJECT
Package

cl-mongo

Methods
Method: host (MONGO mongo)

automatically generated reader method

Source

mongo.lisp (file)

Generic Function: id OBJECT
Package

cl-mongo

Methods
Method: id (MONGO mongo)

automatically generated reader method

Source

mongo.lisp (file)

Method: id (BSON-OID bson-oid)

automatically generated reader method

Source

bson-oid.lisp (file)

Generic Function: index-array OBJECT
Generic Function: (setf index-array) NEW-VALUE OBJECT
Package

cl-mongo

Methods
Method: index-array (BSON-ARRAY bson-array)

automatically generated reader method

Source

bson-array.lisp (file)

Method: (setf index-array) NEW-VALUE (BSON-ARRAY bson-array)

automatically generated writer method

Source

bson-array.lisp (file)

Generic Function: kv->doc KV

turn a pair of key/value pairs into a document

Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv->doc (KV hash-table)
Method: kv->doc (KV-CONTAINER kv-container)
Method: kv->doc (KV pair)
Generic Function: kv->ht KV

turn a pair of key/value pairs into a hash table

Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv->ht (KV-CONTAINER kv-container)
Method: kv->ht (KV hash-table)
Method: kv->ht (KV pair)
Generic Function: kv-container-add PAIR CONTAINER
Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv-container-add (CONTB kv-container) (KV-CONTAINER kv-container)
Method: kv-container-add (PAIR pair) (KV-CONTAINER kv-container)
Generic Function: kv-container-aref CONT INDEX
Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv-container-aref (INDEX integer) (KV-CONTAINER kv-container)
Generic Function: kv-container-kv INDEX CONT
Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv-container-kv (INDEX integer) (KV-CONTAINER kv-container)
Generic Function: kv-container-length CONT
Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv-container-length (KV-CONTAINER kv-container)
Generic Function: kv-container-pop CONT
Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv-container-pop (KV-CONTAINER kv-container)
Generic Function: kv-container-push EL CONT
Package

cl-mongo

Source

pair.lisp (file)

Methods
Method: kv-container-push (EL pair) (KV-CONTAINER kv-container)
Generic Function: local OBJECT
Package

cl-mongo

Methods
Method: local (BSON-TIME bson-time)

automatically generated reader method

Source

bson-time.lisp (file)

Generic Function: mongo-delete COLLECTION OBJECT

delete a mongo object

Package

cl-mongo

Source

protocol.lisp (file)

Methods
Method: mongo-delete (COLLECTION string) (OBJECT document)
Method: mongo-delete (COLLECTION string) (SELECTOR array)
Generic Function: mongo-get-more COLLECTION CURSOR &key LIMIT

iterate the db cursor..

Package

cl-mongo

Source

protocol.lisp (file)

Methods
Method: mongo-get-more (COLLECTION string) (CURSOR array) &key LIMIT
Generic Function: mongo-insert COLLECTION DOCUMENTS

insert function for mongo

Package

cl-mongo

Source

protocol.lisp (file)

Methods
Method: mongo-insert (COLLECTION string) (DOCUMENTS cons)
Method: mongo-insert (COLLECTION string) (DOCUMENT document)
Method: mongo-insert (COLLECTION string) (DOCUMENT array)
Generic Function: mongo-kill-cursors CURSOR COUNT

tell the db you’re done with the cursors

Package

cl-mongo

Source

protocol.lisp (file)

Methods
Method: mongo-kill-cursors (CURSOR array) (COUNT (eql 1))
Generic Function: mongo-message MONGO MESSAGE &key TIMEOUT

message to/from mongo..

Package

cl-mongo

Source

mongo.lisp (file)

Methods
Method: mongo-message (MONGO mongo) (MESSAGE array) &key TIMEOUT
Generic Function: mongo-message* MONGO MESSAGE &key TIMEOUT
Package

cl-mongo

Methods
Method: mongo-message* (MONGO mongo) (MESSAGE array) &key TIMEOUT
Source

mongo.lisp (file)

Generic Function: mongo-query COLLECTION QUERY &key OPTIONS SKIP LIMIT SELECTOR

query a bson database

Package

cl-mongo

Source

protocol.lisp (file)

Methods
Method: mongo-query (COLLECTION string) (QUERY hash-table) &key OPTIONS SKIP LIMIT SELECTOR
Method: mongo-query (COLLECTION string) QUERY &key OPTIONS SKIP LIMIT SELECTOR
Generic Function: mongo-stream MONGO

mongo stream socket..

Package

cl-mongo

Source

mongo.lisp (file)

Methods
Method: mongo-stream (MONGO mongo)
Generic Function: mongo-update COLLECTION SELECTOR DOCUMENT &key OPTIONS

insert function for mongo

Package

cl-mongo

Source

protocol.lisp (file)

Methods
Method: mongo-update (COLLECTION string) (SELECTOR array) (DOCUMENT array) &key OPTIONS
Generic Function: name OBJECT
Generic Function: (setf name) NEW-VALUE OBJECT
Package

cl-mongo

Methods
Method: name (MONGO mongo)

automatically generated reader method

Source

mongo.lisp (file)

Method: (setf name) NEW-VALUE (MONGO mongo)

automatically generated writer method

Source

mongo.lisp (file)

Generic Function: options OBJECT
Package

cl-mongo

Methods
Method: options (BSON-REGEX bson-regex)

automatically generated reader method

Source

bson-regex.lisp (file)

Generic Function: port OBJECT
Package

cl-mongo

Methods
Method: port (MONGO mongo)

automatically generated reader method

Source

mongo.lisp (file)

Generic Function: pp* RESULT &key STREAM ND
Package

cl-mongo

Methods
Method: pp* (RESULT cons) &key STREAM ND
Source

shell.lisp (file)

Generic Function: print-object.1 DOCUMENT STREAM
Package

cl-mongo

Methods
Method: print-object.1 (DOCUMENT document) STREAM
Source

document.lisp (file)

Generic Function: print-object.2 DOCUMENT STREAM
Package

cl-mongo

Methods
Method: print-object.2 (DOCUMENT document) STREAM
Source

document.lisp (file)

Generic Function: raw OBJECT
Package

cl-mongo

Methods
Method: raw (BSON-TIME bson-time)

automatically generated reader method

Source

bson-time.lisp (file)

Generic Function: regex OBJECT
Package

cl-mongo

Methods
Method: regex (BSON-REGEX bson-regex)

automatically generated reader method

Source

bson-regex.lisp (file)

Generic Function: rep STREAM BSON-BINARY

a human-readable representation of the binary data .

Package

cl-mongo

Source

bson-binary.lisp (file)

Methods
Method: rep STREAM (BSON-BINARY bson-binary-md5) after
Method: rep STREAM (BSON-BINARY bson-binary-base)
Generic Function: type-id OBJECT
Package

cl-mongo

Methods
Method: type-id (BSON-BINARY-USER bson-binary-user)

automatically generated reader method

Source

bson-binary.lisp (file)

Method: type-id (BSON-BINARY-MD5 bson-binary-md5)

automatically generated reader method

Source

bson-binary.lisp (file)

Method: type-id (BSON-BINARY-UUID bson-binary-uuid)

automatically generated reader method

Source

bson-binary.lisp (file)

Method: type-id (BSON-BINARY bson-binary)

automatically generated reader method

Source

bson-binary.lisp (file)

Method: type-id (BSON-BINARY-FUNCTION bson-binary-function)

automatically generated reader method

Source

bson-binary.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

6.2.6 Structures

Structure: pair ()
Package

cl-mongo

Source

pair.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods
Direct slots
Slot: key
Readers

pair-key (function)

Writers

(setf pair-key) (function)

Slot: value
Readers

pair-value (function)

Writers

(setf pair-value) (function)


Previous: , Up: Internal definitions   [Contents][Index]

6.2.7 Classes

Class: bson-array ()
Package

cl-mongo

Source

bson-array.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: array
Initargs

:data-array

Readers

data-array (generic function)

Writers

(setf data-array) (generic function)

Slot: index-array
Initargs

:index-array

Readers

index-array (generic function)

Writers

(setf index-array) (generic function)

Class: bson-binary ()

bson ordinary binary type

Package

cl-mongo

Source

bson-binary.lisp (file)

Direct superclasses

bson-binary-base (class)

Direct methods
Direct slots
Slot: type-id
Initform

cl-mongo::+bson-binary+

Readers

type-id (generic function)

Class: bson-binary-base ()

bson binary type; this is the base class.

Package

cl-mongo

Source

bson-binary.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: data
Initargs

:data

Readers

data (generic function)

Class: bson-binary-function ()

bson function binary type

Package

cl-mongo

Source

bson-binary.lisp (file)

Direct superclasses

bson-binary-base (class)

Direct methods

type-id (method)

Direct slots
Slot: type-id
Initform

cl-mongo::+bson-binary-function+

Readers

type-id (generic function)

Class: bson-binary-md5 ()

bson md5 binary type

Package

cl-mongo

Source

bson-binary.lisp (file)

Direct superclasses

bson-binary-base (class)

Direct methods
Direct slots
Slot: type-id
Initform

cl-mongo::+bson-binary-md5+

Readers

type-id (generic function)

Class: bson-binary-user ()

bson user defined binary type

Package

cl-mongo

Source

bson-binary.lisp (file)

Direct superclasses

bson-binary-base (class)

Direct methods

type-id (method)

Direct slots
Slot: type-id
Initform

cl-mongo::+bson-binary-user+

Readers

type-id (generic function)

Class: bson-binary-uuid ()

bson uuid binary type

Package

cl-mongo

Source

bson-binary.lisp (file)

Direct superclasses

bson-binary-base (class)

Direct methods

type-id (method)

Direct slots
Slot: type-id
Initform

cl-mongo::+bson-binary-uuid+

Readers

type-id (generic function)

Class: bson-code ()
Package

cl-mongo

Source

bson-code.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: code
Initargs

:code

Readers

code (generic function)

Class: bson-oid ()
Package

cl-mongo

Source

bson-oid.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: id
Initargs

:oid

Readers

id (generic function)

Direct Default Initargs
InitargValue
:oid(uuid:uuid-to-byte-array (uuid:make-v4-uuid))
Class: bson-regex ()
Package

cl-mongo

Source

bson-regex.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: regex
Initargs

:regex

Readers

regex (generic function)

Slot: options
Initargs

:options

Readers

options (generic function)

Class: bson-time ()
Package

cl-mongo

Source

bson-time.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: raw
Initargs

:raw

Readers

raw (generic function)

Slot: local
Initargs

:local

Readers

local (generic function)

Direct Default Initargs
InitargValue
:localt
:raw(cl-mongo::gmt-to-bson-time (get-universal-time))
Class: kv-container ()
Package

cl-mongo

Source

pair.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: container
Initform

(make-array 2 :fill-pointer 0 :adjustable t)

Readers

container (generic function)

Writers

(setf container) (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L   M   O  
Index Entry  Section

C
cl-mongo.asd: The cl-mongo<dot>asd file
cl-mongo/COPYING: The cl-mongo/copying file
cl-mongo/README.md: The cl-mongo/readme<dot>md file
cl-mongo/src: The cl-mongo/src module
cl-mongo/src/bson-array.lisp: The cl-mongo/src/bson-array<dot>lisp file
cl-mongo/src/bson-binary.lisp: The cl-mongo/src/bson-binary<dot>lisp file
cl-mongo/src/bson-code.lisp: The cl-mongo/src/bson-code<dot>lisp file
cl-mongo/src/bson-decode.lisp: The cl-mongo/src/bson-decode<dot>lisp file
cl-mongo/src/bson-encode-container.lisp: The cl-mongo/src/bson-encode-container<dot>lisp file
cl-mongo/src/bson-oid.lisp: The cl-mongo/src/bson-oid<dot>lisp file
cl-mongo/src/bson-regex.lisp: The cl-mongo/src/bson-regex<dot>lisp file
cl-mongo/src/bson-time.lisp: The cl-mongo/src/bson-time<dot>lisp file
cl-mongo/src/bson.lisp: The cl-mongo/src/bson<dot>lisp file
cl-mongo/src/db.lisp: The cl-mongo/src/db<dot>lisp file
cl-mongo/src/do-query.lisp: The cl-mongo/src/do-query<dot>lisp file
cl-mongo/src/doc.lisp: The cl-mongo/src/doc<dot>lisp file
cl-mongo/src/document.lisp: The cl-mongo/src/document<dot>lisp file
cl-mongo/src/encode-float.lisp: The cl-mongo/src/encode-float<dot>lisp file
cl-mongo/src/java-script.lisp: The cl-mongo/src/java-script<dot>lisp file
cl-mongo/src/map-reduce.lisp: The cl-mongo/src/map-reduce<dot>lisp file
cl-mongo/src/mem.lisp: The cl-mongo/src/mem<dot>lisp file
cl-mongo/src/mongo-syntax.lisp: The cl-mongo/src/mongo-syntax<dot>lisp file
cl-mongo/src/mongo.lisp: The cl-mongo/src/mongo<dot>lisp file
cl-mongo/src/octets.lisp: The cl-mongo/src/octets<dot>lisp file
cl-mongo/src/packages.lisp: The cl-mongo/src/packages<dot>lisp file
cl-mongo/src/pair.lisp: The cl-mongo/src/pair<dot>lisp file
cl-mongo/src/protocol.lisp: The cl-mongo/src/protocol<dot>lisp file
cl-mongo/src/shell.lisp: The cl-mongo/src/shell<dot>lisp file

F
File, Lisp, cl-mongo.asd: The cl-mongo<dot>asd file
File, Lisp, cl-mongo/src/bson-array.lisp: The cl-mongo/src/bson-array<dot>lisp file
File, Lisp, cl-mongo/src/bson-binary.lisp: The cl-mongo/src/bson-binary<dot>lisp file
File, Lisp, cl-mongo/src/bson-code.lisp: The cl-mongo/src/bson-code<dot>lisp file
File, Lisp, cl-mongo/src/bson-decode.lisp: The cl-mongo/src/bson-decode<dot>lisp file
File, Lisp, cl-mongo/src/bson-encode-container.lisp: The cl-mongo/src/bson-encode-container<dot>lisp file
File, Lisp, cl-mongo/src/bson-oid.lisp: The cl-mongo/src/bson-oid<dot>lisp file
File, Lisp, cl-mongo/src/bson-regex.lisp: The cl-mongo/src/bson-regex<dot>lisp file
File, Lisp, cl-mongo/src/bson-time.lisp: The cl-mongo/src/bson-time<dot>lisp file
File, Lisp, cl-mongo/src/bson.lisp: The cl-mongo/src/bson<dot>lisp file
File, Lisp, cl-mongo/src/db.lisp: The cl-mongo/src/db<dot>lisp file
File, Lisp, cl-mongo/src/do-query.lisp: The cl-mongo/src/do-query<dot>lisp file
File, Lisp, cl-mongo/src/doc.lisp: The cl-mongo/src/doc<dot>lisp file
File, Lisp, cl-mongo/src/document.lisp: The cl-mongo/src/document<dot>lisp file
File, Lisp, cl-mongo/src/encode-float.lisp: The cl-mongo/src/encode-float<dot>lisp file
File, Lisp, cl-mongo/src/java-script.lisp: The cl-mongo/src/java-script<dot>lisp file
File, Lisp, cl-mongo/src/map-reduce.lisp: The cl-mongo/src/map-reduce<dot>lisp file
File, Lisp, cl-mongo/src/mem.lisp: The cl-mongo/src/mem<dot>lisp file
File, Lisp, cl-mongo/src/mongo-syntax.lisp: The cl-mongo/src/mongo-syntax<dot>lisp file
File, Lisp, cl-mongo/src/mongo.lisp: The cl-mongo/src/mongo<dot>lisp file
File, Lisp, cl-mongo/src/octets.lisp: The cl-mongo/src/octets<dot>lisp file
File, Lisp, cl-mongo/src/packages.lisp: The cl-mongo/src/packages<dot>lisp file
File, Lisp, cl-mongo/src/pair.lisp: The cl-mongo/src/pair<dot>lisp file
File, Lisp, cl-mongo/src/protocol.lisp: The cl-mongo/src/protocol<dot>lisp file
File, Lisp, cl-mongo/src/shell.lisp: The cl-mongo/src/shell<dot>lisp file
File, other, cl-mongo/COPYING: The cl-mongo/copying file
File, other, cl-mongo/README.md: The cl-mongo/readme<dot>md file

L
Lisp File, cl-mongo.asd: The cl-mongo<dot>asd file
Lisp File, cl-mongo/src/bson-array.lisp: The cl-mongo/src/bson-array<dot>lisp file
Lisp File, cl-mongo/src/bson-binary.lisp: The cl-mongo/src/bson-binary<dot>lisp file
Lisp File, cl-mongo/src/bson-code.lisp: The cl-mongo/src/bson-code<dot>lisp file
Lisp File, cl-mongo/src/bson-decode.lisp: The cl-mongo/src/bson-decode<dot>lisp file
Lisp File, cl-mongo/src/bson-encode-container.lisp: The cl-mongo/src/bson-encode-container<dot>lisp file
Lisp File, cl-mongo/src/bson-oid.lisp: The cl-mongo/src/bson-oid<dot>lisp file
Lisp File, cl-mongo/src/bson-regex.lisp: The cl-mongo/src/bson-regex<dot>lisp file
Lisp File, cl-mongo/src/bson-time.lisp: The cl-mongo/src/bson-time<dot>lisp file
Lisp File, cl-mongo/src/bson.lisp: The cl-mongo/src/bson<dot>lisp file
Lisp File, cl-mongo/src/db.lisp: The cl-mongo/src/db<dot>lisp file
Lisp File, cl-mongo/src/do-query.lisp: The cl-mongo/src/do-query<dot>lisp file
Lisp File, cl-mongo/src/doc.lisp: The cl-mongo/src/doc<dot>lisp file
Lisp File, cl-mongo/src/document.lisp: The cl-mongo/src/document<dot>lisp file
Lisp File, cl-mongo/src/encode-float.lisp: The cl-mongo/src/encode-float<dot>lisp file
Lisp File, cl-mongo/src/java-script.lisp: The cl-mongo/src/java-script<dot>lisp file
Lisp File, cl-mongo/src/map-reduce.lisp: The cl-mongo/src/map-reduce<dot>lisp file
Lisp File, cl-mongo/src/mem.lisp: The cl-mongo/src/mem<dot>lisp file
Lisp File, cl-mongo/src/mongo-syntax.lisp: The cl-mongo/src/mongo-syntax<dot>lisp file
Lisp File, cl-mongo/src/mongo.lisp: The cl-mongo/src/mongo<dot>lisp file
Lisp File, cl-mongo/src/octets.lisp: The cl-mongo/src/octets<dot>lisp file
Lisp File, cl-mongo/src/packages.lisp: The cl-mongo/src/packages<dot>lisp file
Lisp File, cl-mongo/src/pair.lisp: The cl-mongo/src/pair<dot>lisp file
Lisp File, cl-mongo/src/protocol.lisp: The cl-mongo/src/protocol<dot>lisp file
Lisp File, cl-mongo/src/shell.lisp: The cl-mongo/src/shell<dot>lisp file

M
Module, cl-mongo/src: The cl-mongo/src module

O
Other File, cl-mongo/COPYING: The cl-mongo/copying file
Other File, cl-mongo/README.md: The cl-mongo/readme<dot>md file

Jump to:   C   F   L   M   O  

Next: , Previous: , Up: Indexes   [Contents][Index]

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

$
$: Exported macros
$!=: Exported macros
$!in: Exported macros
$+: Exported macros
$-: Exported macros
$/: Exported macros
$<: Exported macros
$<=: Exported macros
$>: Exported macros
$>=: Exported macros
$add-to-set: Exported macros
$all: Exported macros
$em: Exported macros
$exists: Exported macros
$exp+: Internal macros
$in: Exported macros
$inc: Exported macros
$index: Exported macros
$kv-eval: Internal macros
$map-reduce: Exported macros
$mod: Exported macros
$not: Exported macros
$op: Internal macros
$op*: Internal macros
$pop-back: Exported macros
$pop-front: Exported macros
$pull: Exported macros
$pull-all: Exported macros
$push: Exported macros
$push-all: Exported macros
$range: Internal macros
$set: Exported macros
$size: Internal macros
$unset: Exported macros
$where: Exported macros

(
(setf container): Internal generic functions
(setf container): Internal generic functions
(setf data-array): Internal generic functions
(setf data-array): Internal generic functions
(setf db): Internal generic functions
(setf db): Internal generic functions
(setf elements): Internal generic functions
(setf elements): Internal generic functions
(setf index-array): Internal generic functions
(setf index-array): Internal generic functions
(setf name): Internal generic functions
(setf name): Internal generic functions
(setf pair-key): Internal functions
(setf pair-value): Internal functions

_
_id: Internal generic functions
_id: Internal generic functions
_id: Internal generic functions
_local: Internal generic functions
_local: Internal generic functions

A
add-element: Exported generic functions
add-element: Exported generic functions
add-element: Exported generic functions
add-integer: Internal functions
add-octets: Internal functions
add-to-array: Internal functions
add-to-registry: Internal functions
append-to-octet-vector: Internal functions
asc/desc->+1/-1: Internal functions

B
bind-return: Internal functions
bool-to-byte: Internal functions
bson-array-pop: Internal generic functions
bson-array-pop: Internal generic functions
bson-array-pop-element: Internal generic functions
bson-array-pop-element: Internal generic functions
bson-array-push: Internal generic functions
bson-array-push: Internal generic functions
bson-array-reset: Internal generic functions
bson-array-reset: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-binary: Internal generic functions
bson-decode: Internal functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode: Internal generic functions
bson-encode-array: Internal functions
bson-encode-cons: Internal functions
bson-encode-container: Internal generic functions
bson-encode-container: Internal generic functions
bson-encode-container: Internal generic functions
bson-encode-container: Internal generic functions
bson-encode-container: Internal generic functions
bson-encode-container: Internal generic functions
bson-time-to-ut: Exported functions
byte-to-bool: Internal functions
byte-to-octet: Internal functions

C
code: Internal generic functions
code: Internal generic functions
collect-all-elements: Exported functions
collect-args: Internal functions
collect-to-hash: Internal functions
connection?: Internal functions
construct-$+-: Internal macros
construct-container*: Internal macros
construct-container-lst*: Internal macros
container: Internal generic functions
container: Internal generic functions
copy-pair: Internal functions
count-it: Internal functions
customize: Internal functions
cwd: Exported functions

D
data: Internal generic functions
data: Internal generic functions
data-array: Internal generic functions
data-array: Internal generic functions
date-time: Exported functions
db: Internal generic functions
db: Internal generic functions
db.add-user: Exported generic functions
db.add-user: Exported generic functions
db.auth: Exported generic functions
db.auth: Exported generic functions
db.collections: Exported generic functions
db.collections: Exported generic functions
db.count: Exported generic functions
db.count: Exported generic functions
db.count: Exported generic functions
db.count: Exported generic functions
db.create-collection: Exported generic functions
db.delete: Exported generic functions
db.delete: Exported generic functions
db.delete: Exported generic functions
db.delete: Exported generic functions
db.delete: Exported generic functions
db.delete: Exported generic functions
db.distinct: Exported generic functions
db.distinct: Exported generic functions
db.ensure-index: Exported generic functions
db.ensure-index: Exported generic functions
db.ensure-index: Exported generic functions
db.ensure-index: Exported generic functions
db.ensure-index: Exported generic functions
db.eval: Exported generic functions
db.eval: Exported generic functions
db.find: Exported generic functions
db.find: Exported generic functions
db.find: Exported generic functions
db.find: Exported generic functions
db.find: Exported generic functions
db.find: Exported generic functions
db.find: Exported generic functions
db.find: Exported generic functions
db.indexes: Exported generic functions
db.indexes: Exported generic functions
db.insert: Exported generic functions
db.insert: Exported generic functions
db.iter: Exported generic functions
db.iter: Exported generic functions
db.iter: Exported generic functions
db.iterator: Exported functions
db.next: Exported generic functions
db.next: Exported generic functions
db.next: Exported generic functions
db.next: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.run-command: Exported generic functions
db.save: Exported generic functions
db.save: Exported generic functions
db.save: Exported generic functions
db.save: Exported generic functions
db.sort: Exported macros
db.stop: Exported generic functions
db.stop: Exported generic functions
db.stop: Exported generic functions
db.stop: Exported generic functions
db.stop: Exported generic functions
db.update: Exported generic functions
db.update: Exported generic functions
db.use: Exported generic functions
db.use: Exported generic functions
db.use: Exported generic functions
decode: Internal generic functions
decode: Internal generic functions
decode-double-float-bits: Internal functions
decode-float-bits: Internal functions
default?: Internal functions
defjs: Exported macros
defsrvjs: Exported macros
denormalize: Internal functions
do-query: Exported functions
do-reduce: Internal functions
doc-elements: Internal generic functions
doc-elements: Internal generic functions
doc-elements: Internal generic functions
doc-id: Exported functions
docs: Exported functions

E
elements: Internal generic functions
elements: Internal generic functions
elp: Internal generic functions
elp: Internal generic functions
elp: Internal generic functions
elp: Internal generic functions
empty-str: Internal functions
encode-double-float-bits: Internal functions
encode-float-bits: Internal functions
end-of-key: Internal functions
error-on-key-exists: Internal functions
expand-selector: Internal macros

F
fmt: Internal generic functions
fmt: Internal generic functions
full-collection-name: Internal generic functions
full-collection-name: Internal generic functions
Function, (setf pair-key): Internal functions
Function, (setf pair-value): Internal functions
Function, add-integer: Internal functions
Function, add-octets: Internal functions
Function, add-to-array: Internal functions
Function, add-to-registry: Internal functions
Function, append-to-octet-vector: Internal functions
Function, asc/desc->+1/-1: Internal functions
Function, bind-return: Internal functions
Function, bool-to-byte: Internal functions
Function, bson-decode: Internal functions
Function, bson-encode-array: Internal functions
Function, bson-encode-cons: Internal functions
Function, bson-time-to-ut: Exported functions
Function, byte-to-bool: Internal functions
Function, byte-to-octet: Internal functions
Function, collect-all-elements: Exported functions
Function, collect-args: Internal functions
Function, collect-to-hash: Internal functions
Function, connection?: Internal functions
Function, copy-pair: Internal functions
Function, count-it: Internal functions
Function, customize: Internal functions
Function, cwd: Exported functions
Function, date-time: Exported functions
Function, db.iterator: Exported functions
Function, decode-double-float-bits: Internal functions
Function, decode-float-bits: Internal functions
Function, default?: Internal functions
Function, denormalize: Internal functions
Function, do-query: Exported functions
Function, do-reduce: Internal functions
Function, doc-id: Exported functions
Function, docs: Exported functions
Function, empty-str: Internal functions
Function, encode-double-float-bits: Internal functions
Function, encode-float-bits: Internal functions
Function, end-of-key: Internal functions
Function, error-on-key-exists: Internal functions
Function, gen-clean: Internal functions
Function, gendoc: Internal functions
Function, generate-readme: Exported functions
Function, get-all-values: Internal functions
Function, gmt-to-bson-time: Internal functions
Function, hash-keys: Internal functions
Function, header+docsp: Internal functions
Function, headerp: Internal functions
Function, hex-md5: Internal functions
Function, ht->document: Exported functions
Function, ht->document.1: Internal functions
Function, ht->list.1: Internal functions
Function, ht-test: Internal functions
Function, int32-to-octet: Internal functions
Function, int64-to-octet: Internal functions
Function, iter: Exported functions
Function, js-show: Internal functions
Function, load-file: Internal functions
Function, make-bson-array: Internal functions
Function, make-bson-code: Internal functions
Function, make-bson-oid: Internal functions
Function, make-bson-regex: Internal functions
Function, make-bson-time: Internal functions
Function, make-document: Exported functions
Function, make-elements: Internal functions
Function, make-fixed-size-octet-vector: Internal functions
Function, make-int-vector: Internal functions
Function, make-kv-container: Internal functions
Function, make-mongo: Internal functions
Function, make-octet-vector: Internal functions
Function, map-reduce-op: Internal functions
Function, mapdoc: Exported functions
Function, mongo-ids: Internal functions
Function, mongo-registry: Internal functions
Function, mongo-reply: Internal functions
Function, mongo-show: Exported functions
Function, mongodb-reader: Internal functions
Function, mr.collections: Internal functions
Function, mr.gc: Exported functions
Function, mr.gc*: Internal functions
Function, mr.gc.all: Exported functions
Function, mr.p: Exported functions
Function, nd: Exported functions
Function, new-line: Internal functions
Function, normalize-args: Internal functions
Function, normalize-array: Internal functions
Function, normalize-bson-array: Internal functions
Function, now: Exported functions
Function, null-terminate-array: Internal functions
Function, null-terminated-octet-to-string: Internal functions
Function, nwd: Exported functions
Function, octet-to-byte: Internal functions
Function, octet-to-byte.1: Internal functions
Function, octet-to-int32: Internal functions
Function, octet-to-int32.1: Internal functions
Function, octet-to-int64: Internal functions
Function, octet-to-int64.1: Internal functions
Function, octet-to-uint64: Internal functions
Function, octet-to-uint64.1: Internal functions
Function, op-split: Internal functions
Function, pair: Internal functions
Function, pair-key: Internal functions
Function, pair-p: Internal functions
Function, pair-value: Internal functions
Function, perf.db.find: Internal functions
Function, perf.mongo-reply: Internal functions
Function, pop-from-array: Internal functions
Function, positive: Internal functions
Function, print-doc: Internal functions
Function, print-hash: Internal functions
Function, queue-reader: Internal functions
Function, read-back: Internal functions
Function, read-buffer: Internal functions
Function, read-ready: Internal functions
Function, rebuild*: Internal functions
Function, reclaim-memory: Internal functions
Function, restore-default-connection: Internal functions
Function, ret: Exported functions
Function, rm: Exported functions
Function, rm*: Internal functions
Function, scale: Internal functions
Function, scale-integer: Internal functions
Function, segment*: Internal functions
Function, select-body: Internal functions
Function, set-array-length: Internal functions
Function, set-octets: Internal functions
Function, slurp-stream: Internal functions
Function, str-md5: Internal functions
Function, string-replace: Internal functions
Function, string-replace*: Internal functions
Function, string-to-null-terminated-octet: Internal functions
Function, strip-comments: Internal functions
Function, switch-default-connection: Internal functions
Function, test-for-readback: Internal functions
Function, test-for-readback*: Internal functions
Function, th-reader: Internal functions
Function, th-status: Internal functions
Function, th-writer: Internal functions
Function, time-zone: Exported functions
Function, to-octet: Internal functions
Function, to-signed-value: Internal functions
Function, to-val: Internal functions
Function, to-val.1: Internal functions
Function, tor: Internal functions
Function, unwrap: Internal functions
Function, update-options: Internal functions
Function, write-file: Internal functions

G
gen-clean: Internal functions
gendoc: Internal functions
generate-readme: Exported functions
Generic Function, (setf container): Internal generic functions
Generic Function, (setf data-array): Internal generic functions
Generic Function, (setf db): Internal generic functions
Generic Function, (setf elements): Internal generic functions
Generic Function, (setf index-array): Internal generic functions
Generic Function, (setf name): Internal generic functions
Generic Function, add-element: Exported generic functions
Generic Function, bson-array-pop: Internal generic functions
Generic Function, bson-array-pop-element: Internal generic functions
Generic Function, bson-array-push: Internal generic functions
Generic Function, bson-array-reset: Internal generic functions
Generic Function, bson-binary: Internal generic functions
Generic Function, bson-encode: Internal generic functions
Generic Function, bson-encode-container: Internal generic functions
Generic Function, code: Internal generic functions
Generic Function, container: Internal generic functions
Generic Function, data: Internal generic functions
Generic Function, data-array: Internal generic functions
Generic Function, db: Internal generic functions
Generic Function, db.add-user: Exported generic functions
Generic Function, db.auth: Exported generic functions
Generic Function, db.collections: Exported generic functions
Generic Function, db.count: Exported generic functions
Generic Function, db.create-collection: Exported generic functions
Generic Function, db.delete: Exported generic functions
Generic Function, db.distinct: Exported generic functions
Generic Function, db.ensure-index: Exported generic functions
Generic Function, db.eval: Exported generic functions
Generic Function, db.find: Exported generic functions
Generic Function, db.indexes: Exported generic functions
Generic Function, db.insert: Exported generic functions
Generic Function, db.iter: Exported generic functions
Generic Function, db.next: Exported generic functions
Generic Function, db.run-command: Exported generic functions
Generic Function, db.save: Exported generic functions
Generic Function, db.stop: Exported generic functions
Generic Function, db.update: Exported generic functions
Generic Function, db.use: Exported generic functions
Generic Function, decode: Internal generic functions
Generic Function, doc-elements: Internal generic functions
Generic Function, elements: Internal generic functions
Generic Function, elp: Internal generic functions
Generic Function, fmt: Internal generic functions
Generic Function, full-collection-name: Internal generic functions
Generic Function, get-element: Exported generic functions
Generic Function, get-id: Internal generic functions
Generic Function, get-keys: Exported generic functions
Generic Function, host: Internal generic functions
Generic Function, id: Internal generic functions
Generic Function, index-array: Internal generic functions
Generic Function, kv: Exported generic functions
Generic Function, kv->doc: Internal generic functions
Generic Function, kv->ht: Internal generic functions
Generic Function, kv-container-add: Internal generic functions
Generic Function, kv-container-aref: Internal generic functions
Generic Function, kv-container-kv: Internal generic functions
Generic Function, kv-container-length: Internal generic functions
Generic Function, kv-container-pop: Internal generic functions
Generic Function, kv-container-push: Internal generic functions
Generic Function, local: Internal generic functions
Generic Function, mongo: Exported generic functions
Generic Function, mongo-close: Exported generic functions
Generic Function, mongo-delete: Internal generic functions
Generic Function, mongo-get-more: Internal generic functions
Generic Function, mongo-insert: Internal generic functions
Generic Function, mongo-kill-cursors: Internal generic functions
Generic Function, mongo-message: Internal generic functions
Generic Function, mongo-message*: Internal generic functions
Generic Function, mongo-query: Internal generic functions
Generic Function, mongo-registered: Exported generic functions
Generic Function, mongo-stream: Internal generic functions
Generic Function, mongo-swap: Exported generic functions
Generic Function, mongo-update: Internal generic functions
Generic Function, name: Internal generic functions
Generic Function, options: Internal generic functions
Generic Function, port: Internal generic functions
Generic Function, pp: Exported generic functions
Generic Function, pp*: Internal generic functions
Generic Function, print-object.1: Internal generic functions
Generic Function, print-object.2: Internal generic functions
Generic Function, raw: Internal generic functions
Generic Function, regex: Internal generic functions
Generic Function, rep: Internal generic functions
Generic Function, rm-element: Exported generic functions
Generic Function, show: Exported generic functions
Generic Function, type-id: Internal generic functions
Generic Function, _id: Internal generic functions
Generic Function, _local: Internal generic functions
get-all-values: Internal functions
get-element: Exported generic functions
get-element: Exported generic functions
get-element: Exported generic functions
get-element: Exported generic functions
get-element: Exported generic functions
get-element: Exported generic functions
get-element: Exported generic functions
get-id: Internal generic functions
get-id: Internal generic functions
get-id: Internal generic functions
get-keys: Exported generic functions
get-keys: Exported generic functions
gmt-to-bson-time: Internal functions

H
hash-keys: Internal functions
header+docsp: Internal functions
headerp: Internal functions
hex-md5: Internal functions
host: Internal generic functions
host: Internal generic functions
ht->document: Exported functions
ht->document.1: Internal functions
ht->list.1: Internal functions
ht-test: Internal functions

I
id: Internal generic functions
id: Internal generic functions
id: Internal generic functions
index-array: Internal generic functions
index-array: Internal generic functions
install-js: Exported macros
int32-to-octet: Internal functions
int64-to-octet: Internal functions
iter: Exported functions

J
js-show: Internal functions
jsdef: Exported macros
jssrvdef: Internal macros

K
kv: Exported generic functions
kv: Exported generic functions
kv: Exported generic functions
kv: Exported generic functions
kv: Exported generic functions
kv: Exported generic functions
kv->doc: Internal generic functions
kv->doc: Internal generic functions
kv->doc: Internal generic functions
kv->doc: Internal generic functions
kv->ht: Internal generic functions
kv->ht: Internal generic functions
kv->ht: Internal generic functions
kv->ht: Internal generic functions
kv-container-add: Internal generic functions
kv-container-add: Internal generic functions
kv-container-add: Internal generic functions
kv-container-aref: Internal generic functions
kv-container-aref: Internal generic functions
kv-container-kv: Internal generic functions
kv-container-kv: Internal generic functions
kv-container-length: Internal generic functions
kv-container-length: Internal generic functions
kv-container-pop: Internal generic functions
kv-container-pop: Internal generic functions
kv-container-push: Internal generic functions
kv-container-push: Internal generic functions

L
load-file: Internal functions
local: Internal generic functions
local: Internal generic functions

M
Macro, $: Exported macros
Macro, $!=: Exported macros
Macro, $!in: Exported macros
Macro, $+: Exported macros
Macro, $-: Exported macros
Macro, $/: Exported macros
Macro, $<: Exported macros
Macro, $<=: Exported macros
Macro, $>: Exported macros
Macro, $>=: Exported macros
Macro, $add-to-set: Exported macros
Macro, $all: Exported macros
Macro, $em: Exported macros
Macro, $exists: Exported macros
Macro, $exp+: Internal macros
Macro, $in: Exported macros
Macro, $inc: Exported macros
Macro, $index: Exported macros
Macro, $kv-eval: Internal macros
Macro, $map-reduce: Exported macros
Macro, $mod: Exported macros
Macro, $not: Exported macros
Macro, $op: Internal macros
Macro, $op*: Internal macros
Macro, $pop-back: Exported macros
Macro, $pop-front: Exported macros
Macro, $pull: Exported macros
Macro, $pull-all: Exported macros
Macro, $push: Exported macros
Macro, $push-all: Exported macros
Macro, $range: Internal macros
Macro, $set: Exported macros
Macro, $size: Internal macros
Macro, $unset: Exported macros
Macro, $where: Exported macros
Macro, construct-$+-: Internal macros
Macro, construct-container*: Internal macros
Macro, construct-container-lst*: Internal macros
Macro, db.sort: Exported macros
Macro, defjs: Exported macros
Macro, defsrvjs: Exported macros
Macro, expand-selector: Internal macros
Macro, install-js: Exported macros
Macro, jsdef: Exported macros
Macro, jssrvdef: Internal macros
Macro, remove-js: Exported macros
Macro, set-keys: Internal macros
Macro, upd: Internal macros
Macro, with-indent: Internal macros
Macro, with-mongo-connection: Exported macros
make-bson-array: Internal functions
make-bson-code: Internal functions
make-bson-oid: Internal functions
make-bson-regex: Internal functions
make-bson-time: Internal functions
make-document: Exported functions
make-elements: Internal functions
make-fixed-size-octet-vector: Internal functions
make-int-vector: Internal functions
make-kv-container: Internal functions
make-mongo: Internal functions
make-octet-vector: Internal functions
map-reduce-op: Internal functions
mapdoc: Exported functions
Method, (setf container): Internal generic functions
Method, (setf data-array): Internal generic functions
Method, (setf db): Internal generic functions
Method, (setf elements): Internal generic functions
Method, (setf index-array): Internal generic functions
Method, (setf name): Internal generic functions
Method, add-element: Exported generic functions
Method, add-element: Exported generic functions
Method, bson-array-pop: Internal generic functions
Method, bson-array-pop-element: Internal generic functions
Method, bson-array-push: Internal generic functions
Method, bson-array-reset: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-binary: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode: Internal generic functions
Method, bson-encode-container: Internal generic functions
Method, bson-encode-container: Internal generic functions
Method, bson-encode-container: Internal generic functions
Method, bson-encode-container: Internal generic functions
Method, bson-encode-container: Internal generic functions
Method, code: Internal generic functions
Method, container: Internal generic functions
Method, data: Internal generic functions
Method, data-array: Internal generic functions
Method, db: Internal generic functions
Method, db.add-user: Exported generic functions
Method, db.auth: Exported generic functions
Method, db.collections: Exported generic functions
Method, db.count: Exported generic functions
Method, db.count: Exported generic functions
Method, db.count: Exported generic functions
Method, db.delete: Exported generic functions
Method, db.delete: Exported generic functions
Method, db.delete: Exported generic functions
Method, db.delete: Exported generic functions
Method, db.delete: Exported generic functions
Method, db.distinct: Exported generic functions
Method, db.ensure-index: Exported generic functions
Method, db.ensure-index: Exported generic functions
Method, db.ensure-index: Exported generic functions
Method, db.ensure-index: Exported generic functions
Method, db.eval: Exported generic functions
Method, db.find: Exported generic functions
Method, db.find: Exported generic functions
Method, db.find: Exported generic functions
Method, db.find: Exported generic functions
Method, db.find: Exported generic functions
Method, db.find: Exported generic functions
Method, db.find: Exported generic functions
Method, db.indexes: Exported generic functions
Method, db.insert: Exported generic functions
Method, db.iter: Exported generic functions
Method, db.iter: Exported generic functions
Method, db.next: Exported generic functions
Method, db.next: Exported generic functions
Method, db.next: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.run-command: Exported generic functions
Method, db.save: Exported generic functions
Method, db.save: Exported generic functions
Method, db.save: Exported generic functions
Method, db.stop: Exported generic functions
Method, db.stop: Exported generic functions
Method, db.stop: Exported generic functions
Method, db.stop: Exported generic functions
Method, db.update: Exported generic functions
Method, db.use: Exported generic functions
Method, db.use: Exported generic functions
Method, decode: Internal generic functions
Method, doc-elements: Internal generic functions
Method, doc-elements: Internal generic functions
Method, elements: Internal generic functions
Method, elp: Internal generic functions
Method, elp: Internal generic functions
Method, elp: Internal generic functions
Method, fmt: Internal generic functions
Method, full-collection-name: Internal generic functions
Method, get-element: Exported generic functions
Method, get-element: Exported generic functions
Method, get-element: Exported generic functions
Method, get-element: Exported generic functions
Method, get-element: Exported generic functions
Method, get-element: Exported generic functions
Method, get-id: Internal generic functions
Method, get-id: Internal generic functions
Method, get-keys: Exported generic functions
Method, host: Internal generic functions
Method, id: Internal generic functions
Method, id: Internal generic functions
Method, index-array: Internal generic functions
Method, kv: Exported generic functions
Method, kv: Exported generic functions
Method, kv: Exported generic functions
Method, kv: Exported generic functions
Method, kv: Exported generic functions
Method, kv->doc: Internal generic functions
Method, kv->doc: Internal generic functions
Method, kv->doc: Internal generic functions
Method, kv->ht: Internal generic functions
Method, kv->ht: Internal generic functions
Method, kv->ht: Internal generic functions
Method, kv-container-add: Internal generic functions
Method, kv-container-add: Internal generic functions
Method, kv-container-aref: Internal generic functions
Method, kv-container-kv: Internal generic functions
Method, kv-container-length: Internal generic functions
Method, kv-container-pop: Internal generic functions
Method, kv-container-push: Internal generic functions
Method, local: Internal generic functions
Method, mongo: Exported generic functions
Method, mongo-close: Exported generic functions
Method, mongo-close: Exported generic functions
Method, mongo-close: Exported generic functions
Method, mongo-delete: Internal generic functions
Method, mongo-delete: Internal generic functions
Method, mongo-get-more: Internal generic functions
Method, mongo-insert: Internal generic functions
Method, mongo-insert: Internal generic functions
Method, mongo-insert: Internal generic functions
Method, mongo-kill-cursors: Internal generic functions
Method, mongo-message: Internal generic functions
Method, mongo-message*: Internal generic functions
Method, mongo-query: Internal generic functions
Method, mongo-query: Internal generic functions
Method, mongo-registered: Exported generic functions
Method, mongo-stream: Internal generic functions
Method, mongo-swap: Exported generic functions
Method, mongo-swap: Exported generic functions
Method, mongo-swap: Exported generic functions
Method, mongo-update: Internal generic functions
Method, name: Internal generic functions
Method, options: Internal generic functions
Method, port: Internal generic functions
Method, pp: Exported generic functions
Method, pp: Exported generic functions
Method, pp*: Internal generic functions
Method, print-object.1: Internal generic functions
Method, print-object.2: Internal generic functions
Method, raw: Internal generic functions
Method, regex: Internal generic functions
Method, rep: Internal generic functions
Method, rep: Internal generic functions
Method, rm-element: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, show: Exported generic functions
Method, type-id: Internal generic functions
Method, type-id: Internal generic functions
Method, type-id: Internal generic functions
Method, type-id: Internal generic functions
Method, type-id: Internal generic functions
Method, _id: Internal generic functions
Method, _id: Internal generic functions
Method, _local: Internal generic functions
mongo: Exported generic functions
mongo: Exported generic functions
mongo-close: Exported generic functions
mongo-close: Exported generic functions
mongo-close: Exported generic functions
mongo-close: Exported generic functions
mongo-delete: Internal generic functions
mongo-delete: Internal generic functions
mongo-delete: Internal generic functions
mongo-get-more: Internal generic functions
mongo-get-more: Internal generic functions
mongo-ids: Internal functions
mongo-insert: Internal generic functions
mongo-insert: Internal generic functions
mongo-insert: Internal generic functions
mongo-insert: Internal generic functions
mongo-kill-cursors: Internal generic functions
mongo-kill-cursors: Internal generic functions
mongo-message: Internal generic functions
mongo-message: Internal generic functions
mongo-message*: Internal generic functions
mongo-message*: Internal generic functions
mongo-query: Internal generic functions
mongo-query: Internal generic functions
mongo-query: Internal generic functions
mongo-registered: Exported generic functions
mongo-registered: Exported generic functions
mongo-registry: Internal functions
mongo-reply: Internal functions
mongo-show: Exported functions
mongo-stream: Internal generic functions
mongo-stream: Internal generic functions
mongo-swap: Exported generic functions
mongo-swap: Exported generic functions
mongo-swap: Exported generic functions
mongo-swap: Exported generic functions
mongo-update: Internal generic functions
mongo-update: Internal generic functions
mongodb-reader: Internal functions
mr.collections: Internal functions
mr.gc: Exported functions
mr.gc*: Internal functions
mr.gc.all: Exported functions
mr.p: Exported functions

N
name: Internal generic functions
name: Internal generic functions
nd: Exported functions
new-line: Internal functions
normalize-args: Internal functions
normalize-array: Internal functions
normalize-bson-array: Internal functions
now: Exported functions
null-terminate-array: Internal functions
null-terminated-octet-to-string: Internal functions
nwd: Exported functions

O
octet-to-byte: Internal functions
octet-to-byte.1: Internal functions
octet-to-int32: Internal functions
octet-to-int32.1: Internal functions
octet-to-int64: Internal functions
octet-to-int64.1: Internal functions
octet-to-uint64: Internal functions
octet-to-uint64.1: Internal functions
op-split: Internal functions
options: Internal generic functions
options: Internal generic functions

P
pair: Internal functions
pair-key: Internal functions
pair-p: Internal functions
pair-value: Internal functions
perf.db.find: Internal functions
perf.mongo-reply: Internal functions
pop-from-array: Internal functions
port: Internal generic functions
port: Internal generic functions
positive: Internal functions
pp: Exported generic functions
pp: Exported generic functions
pp: Exported generic functions
pp*: Internal generic functions
pp*: Internal generic functions
print-doc: Internal functions
print-hash: Internal functions
print-object.1: Internal generic functions
print-object.1: Internal generic functions
print-object.2: Internal generic functions
print-object.2: Internal generic functions

Q
queue-reader: Internal functions

R
raw: Internal generic functions
raw: Internal generic functions
read-back: Internal functions
read-buffer: Internal functions
read-ready: Internal functions
rebuild*: Internal functions
reclaim-memory: Internal functions
regex: Internal generic functions
regex: Internal generic functions
remove-js: Exported macros
rep: Internal generic functions
rep: Internal generic functions
rep: Internal generic functions
restore-default-connection: Internal functions
ret: Exported functions
rm: Exported functions
rm*: Internal functions
rm-element: Exported generic functions
rm-element: Exported generic functions

S
scale: Internal functions
scale-integer: Internal functions
segment*: Internal functions
select-body: Internal functions
set-array-length: Internal functions
set-keys: Internal macros
set-octets: Internal functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
show: Exported generic functions
slurp-stream: Internal functions
str-md5: Internal functions
string-replace: Internal functions
string-replace*: Internal functions
string-to-null-terminated-octet: Internal functions
strip-comments: Internal functions
switch-default-connection: Internal functions

T
test-for-readback: Internal functions
test-for-readback*: Internal functions
th-reader: Internal functions
th-status: Internal functions
th-writer: Internal functions
time-zone: Exported functions
to-octet: Internal functions
to-signed-value: Internal functions
to-val: Internal functions
to-val.1: Internal functions
tor: Internal functions
type-id: Internal generic functions
type-id: Internal generic functions
type-id: Internal generic functions
type-id: Internal generic functions
type-id: Internal generic functions
type-id: Internal generic functions

U
unwrap: Internal functions
upd: Internal macros
update-options: Internal functions

W
with-indent: Internal macros
with-mongo-connection: Exported macros
write-file: Internal functions

Jump to:   $   (   _  
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +   _  
A   C   D   E   H   I   K   L   N   O   P   R   S   T   V  
Index Entry  Section

*
*bt-time-zone*: Internal special variables
*db.use-history*: Internal special variables
*indent*: Internal special variables
*js-definitions*: Internal special variables
*mongo-default-db*: Exported special variables
*mongo-default-host*: Exported special variables
*mongo-default-port*: Exported special variables
*mongo-registry*: Internal special variables
*q*: Internal special variables
*r*: Internal special variables
*repo-root*: Exported special variables
*runners*: Internal special variables

+
+bson-binary+: Internal constants
+bson-binary-function+: Internal constants
+bson-binary-generic+: Internal constants
+bson-binary-md5+: Internal constants
+bson-binary-user+: Internal constants
+bson-binary-uuid+: Internal constants
+bson-data-array+: Internal constants
+bson-data-binary+: Internal constants
+bson-data-boolean+: Internal constants
+bson-data-code+: Internal constants
+bson-data-code_w_s+: Internal constants
+bson-data-date+: Internal constants
+bson-data-dbpointer+: Internal constants
+bson-data-int32+: Internal constants
+bson-data-long+: Internal constants
+bson-data-max-key+: Internal constants
+bson-data-min-key+: Internal constants
+bson-data-null+: Internal constants
+bson-data-number+: Internal constants
+bson-data-object+: Internal constants
+bson-data-oid+: Internal constants
+bson-data-regex+: Internal constants
+bson-data-string+: Internal constants
+bson-data-symbol+: Internal constants
+bson-data-timestamp+: Internal constants
+bson-data-undefined+: Internal constants
+bt-day-names+: Internal special variables
+bt-months+: Internal special variables
+default-array-size+: Internal constants
+java-script-epoch+: Internal constants
+max-uint32+: Internal constants
+max-uint64+: Internal constants
+milliseconds-multiplier+: Internal constants
+mongo-delete+: Internal constants
+mongo-get-more+: Internal constants
+mongo-insert+: Internal constants
+mongo-kill-cursors+: Internal constants
+mongo-port+: Internal constants
+mongo-query+: Internal constants
+mongo-update+: Internal constants

_
_id: Exported classes
_local_id: Exported classes

A
array: Internal classes

C
code: Internal classes
Constant, +bson-binary+: Internal constants
Constant, +bson-binary-function+: Internal constants
Constant, +bson-binary-generic+: Internal constants
Constant, +bson-binary-md5+: Internal constants
Constant, +bson-binary-user+: Internal constants
Constant, +bson-binary-uuid+: Internal constants
Constant, +bson-data-array+: Internal constants
Constant, +bson-data-binary+: Internal constants
Constant, +bson-data-boolean+: Internal constants
Constant, +bson-data-code+: Internal constants
Constant, +bson-data-code_w_s+: Internal constants
Constant, +bson-data-date+: Internal constants
Constant, +bson-data-dbpointer+: Internal constants
Constant, +bson-data-int32+: Internal constants
Constant, +bson-data-long+: Internal constants
Constant, +bson-data-max-key+: Internal constants
Constant, +bson-data-min-key+: Internal constants
Constant, +bson-data-null+: Internal constants
Constant, +bson-data-number+: Internal constants
Constant, +bson-data-object+: Internal constants
Constant, +bson-data-oid+: Internal constants
Constant, +bson-data-regex+: Internal constants
Constant, +bson-data-string+: Internal constants
Constant, +bson-data-symbol+: Internal constants
Constant, +bson-data-timestamp+: Internal constants
Constant, +bson-data-undefined+: Internal constants
Constant, +default-array-size+: Internal constants
Constant, +java-script-epoch+: Internal constants
Constant, +max-uint32+: Internal constants
Constant, +max-uint64+: Internal constants
Constant, +milliseconds-multiplier+: Internal constants
Constant, +mongo-delete+: Internal constants
Constant, +mongo-get-more+: Internal constants
Constant, +mongo-insert+: Internal constants
Constant, +mongo-kill-cursors+: Internal constants
Constant, +mongo-port+: Internal constants
Constant, +mongo-query+: Internal constants
Constant, +mongo-update+: Internal constants
container: Internal classes

D
data: Internal classes
db: Exported classes

E
elements: Exported classes

H
host: Exported classes

I
id: Exported classes
id: Internal classes
index-array: Internal classes

K
key: Internal structures

L
local: Internal classes

N
name: Exported classes

O
options: Internal classes

P
port: Exported classes

R
raw: Internal classes
regex: Internal classes

S
Slot, array: Internal classes
Slot, code: Internal classes
Slot, container: Internal classes
Slot, data: Internal classes
Slot, db: Exported classes
Slot, elements: Exported classes
Slot, host: Exported classes
Slot, id: Exported classes
Slot, id: Internal classes
Slot, index-array: Internal classes
Slot, key: Internal structures
Slot, local: Internal classes
Slot, name: Exported classes
Slot, options: Internal classes
Slot, port: Exported classes
Slot, raw: Internal classes
Slot, regex: Internal classes
Slot, socket: Exported classes
Slot, type-id: Internal classes
Slot, type-id: Internal classes
Slot, type-id: Internal classes
Slot, type-id: Internal classes
Slot, type-id: Internal classes
Slot, value: Internal structures
Slot, _id: Exported classes
Slot, _local_id: Exported classes
socket: Exported classes
Special Variable, *bt-time-zone*: Internal special variables
Special Variable, *db.use-history*: Internal special variables
Special Variable, *indent*: Internal special variables
Special Variable, *js-definitions*: Internal special variables
Special Variable, *mongo-default-db*: Exported special variables
Special Variable, *mongo-default-host*: Exported special variables
Special Variable, *mongo-default-port*: Exported special variables
Special Variable, *mongo-registry*: Internal special variables
Special Variable, *q*: Internal special variables
Special Variable, *r*: Internal special variables
Special Variable, *repo-root*: Exported special variables
Special Variable, *runners*: Internal special variables
Special Variable, +bt-day-names+: Internal special variables
Special Variable, +bt-months+: Internal special variables

T
type-id: Internal classes
type-id: Internal classes
type-id: Internal classes
type-id: Internal classes
type-id: Internal classes

V
value: Internal structures

Jump to:   *   +   _  
A   C   D   E   H   I   K   L   N   O   P   R   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   D   K   M   P   S  
Index Entry  Section

B
bson-array: Internal classes
bson-binary: Internal classes
bson-binary-base: Internal classes
bson-binary-function: Internal classes
bson-binary-md5: Internal classes
bson-binary-user: Internal classes
bson-binary-uuid: Internal classes
bson-code: Internal classes
bson-oid: Internal classes
bson-regex: Internal classes
bson-time: Internal classes

C
cl-mongo: The cl-mongo system
cl-mongo: The cl-mongo package
cl-mongo-system: The cl-mongo-system package
Class, bson-array: Internal classes
Class, bson-binary: Internal classes
Class, bson-binary-base: Internal classes
Class, bson-binary-function: Internal classes
Class, bson-binary-md5: Internal classes
Class, bson-binary-user: Internal classes
Class, bson-binary-uuid: Internal classes
Class, bson-code: Internal classes
Class, bson-oid: Internal classes
Class, bson-regex: Internal classes
Class, bson-time: Internal classes
Class, document: Exported classes
Class, kv-container: Internal classes
Class, mongo: Exported classes

D
document: Exported classes

K
kv-container: Internal classes

M
mongo: Exported classes

P
Package, cl-mongo: The cl-mongo package
Package, cl-mongo-system: The cl-mongo-system package
pair: Internal structures

S
Structure, pair: Internal structures
System, cl-mongo: The cl-mongo system

Jump to:   B   C   D   K   M   P   S