module Mongo: sig .. end
This is a major client-faced module, for the high level usage.
This module includes a series of APIs that client can use directly to communicate with MongoDB. The most important functions are for insert, udpate, delete, query, get_more. They are the essential interactions that a client can have with MongoDB.
Please note that the current version of APIs here are all essential only. For example, Clients cannot set detailed flags for queries, etc. All operations here are with default flags (which is 0).
A Mongo is bound to a db and a collection. All operations will be done upon the bound db and collection only.
Please refer to MongoDB Wire Protocol for more information
exception Mongo_failed of string
the exception will be raised if anything is wrong, with a string message
type
the type for Mongo
Essential info of a Mongo
val get_db_name : t -> string
val get_collection_name : t -> string
val get_ip : t -> string
val get_port : t -> int
val get_file_descr : t -> Unix.file_descr
Lifecycle of a Mongo
val create : string -> int -> string -> string -> t
create a Mongo. please note that Mongo is bound to a db and a collection. e.g. create ip port db_name collection_name. May raise Mongo_failed exception.
val create_local_default : string -> string -> t
create a Mongo connecting to 127.0.0.1, port 27017. e.g. create_local_default db_name collection_name. May raise Mongo_failed exception.
val destory : t -> unit
destory a Mongo. Please use this to destory a Mongo once it finishes its purpose, in order to release system resources. May raise Mongo_failed exception.
Insert
val insert : t -> Bson.t list -> unit
insert a list of bson documents into MongoDB. May raise Mongo_failed exception.
Update
val update_one : t -> Bson.t * Bson.t -> unit
update the first document matched in MongoDB. e.g., update_one m (s, u);; m is the Mongo. s is the selector document, used to match the documents that need to be updated. u is the update document and any matched documents will be updated to u. May raise Mongo_failed exception.
val update_all : t -> Bson.t * Bson.t -> unit
update all documents matched in MongoDB. e.g., update m (s, u);; m is the Mongo. s is the selector document, used to match the documents that need to be updated. u is the update document and any matched documents will be updated to u. May raise Mongo_failed exception.
Delete
val delete_one : t -> Bson.t -> unit
delete the first document matched in MongoDB. e.g., delete_one m s;; m is the Mongo. s is the selector document, used to match the documents that need to be deleted. May raise Mongo_failed exception.
val delete_all : t -> Bson.t -> unit
delete the all documents matched in MongoDB. e.g., delete_one m s;; m is the Mongo. s is the selector document, used to match the documents that need to be deleted. May raise Mongo_failed exception.
Query / Find
val find : ?skip:int -> t -> MongoReply.t
find all / the default number of documents in the db and collection. May raise Mongo_failed exception.
val find_one : ?skip:int -> t -> MongoReply.t
find the first document in the db and collection. May raise Mongo_failed exception.
val find_of_num : ?skip:int -> t -> int -> MongoReply.t
find the desired number of documents in the db and collection. May raise Mongo_failed exception.
val find_q : ?skip:int -> t -> Bson.t -> MongoReply.t
find all / the default number of documents in the db and collection matching the bson query. May raise Mongo_failed exception.
val find_q_one : ?skip:int -> t -> Bson.t -> MongoReply.t
find the first document in the db and collection matching the bson query. May raise Mongo_failed exception.
val find_q_of_num : ?skip:int -> t -> Bson.t -> int -> MongoReply.t
find the desired number of documents in the db and collection matching the bson query. May raise Mongo_failed exception.
val find_q_s : ?skip:int -> t -> Bson.t -> Bson.t -> MongoReply.t
find all / the default number of documents in the db and collection matching the bson query, each document returned will only contains elements specified in the selector doc. May raise Mongo_failed exception.
val find_q_s_one : ?skip:int -> t -> Bson.t -> Bson.t -> MongoReply.t
find the first documents in the db and collection matching the bson query, each document returned will only contains elements specified in the selector doc. May raise Mongo_failed exception.
val find_q_s_of_num : ?skip:int -> t -> Bson.t -> Bson.t -> int -> MongoReply.t
find the desired number of documents in the db and collection matching the bson query, each document returned will only contains elements specified in the selector doc. May raise Mongo_failed exception.
val count : ?skip:int -> ?limit:int -> ?query:Bson.t -> t -> int
counts the number of documents in a collection
Query / Find more via cursor
val get_more_of_num : t -> int64 -> int -> MongoReply.t
get the desired number of documents via a cursor_id. e.g. get_more_of_num m cursor_id num. May raise Mongo_failed exception.
val get_more : t -> int64 -> MongoReply.t
get all / the default number of documents via a cursor_id. e.g. get_more_of_num m cursor_id num. May raise Mongo_failed exception.
Kill cursor
val kill_cursors : t -> int64 list -> unit
kill a list of cursors, to save MongoDB resources. e.g., kill_cursors m cursor_list. May raise Mongo_failed exception.
Index
type
| |
Background of bool |
| |
Unique of bool |
| |
Name of string |
| |
DropDups of bool |
| |
Sparse of bool |
| |
ExpireAfterSeconds of int |
| |
V of int |
| |
Weight of Bson.t |
| |
Default_language of string |
| |
Language_override of string |
option for index. See http://docs.mongodb.org/manual/reference/method/db.collection.ensureIndex/#db.collection.ensureIndex for more info
val get_indexes : t -> MongoReply.t
return a list of all indexes
val ensure_index : t -> Bson.t -> index_option list -> unit
ensure an index
val ensure_simple_index : ?options:index_option list -> t -> string -> unit
ensure an index (helper)
val ensure_multi_simple_index : ?options:index_option list -> t -> string list -> unit
ensure multi-fields index (helper)
val drop_index : t -> string -> MongoReply.t
drop a index
val drop_all_index : t -> MongoReply.t
drop all index of a collection
Instance Administration Commands
val change_collection : t -> string -> t
change instance collection
val drop_collection : t -> MongoReply.t
removes an entire collection from a database
val drop_database : t -> MongoReply.t
drops a database, deleting the associated data files