doc: more documentation for new symbols.

Author: chergert

doc/mongoc_collection_find_and_modify.txt

@@ -0,0 +1,57 @@
+mongoc_collection_find_and_modify(3)
+====================================
+
+
+NAME
+----
+mongoc_collection_find_and_modify - find a documents matching a selector and modify them
+
+
+SYNOPSIS
+--------
+[source,c]
+-----------------------
+bool mongoc_collection_find_and_modify (mongoc_collection_t *collection,
+                                        const bson_t        *query,
+                                        const bson_t        *sort,
+                                        const bson_t        *update,
+                                        const bson_t        *fields,
+                                        bool                 remove,
+                                        bool                 upsert,
+                                        bool                 return_new,
+                                        bson_t              *reply,
+                                        bson_error_t        *error);
+-----------------------
+
+
+DESCRIPTION
+-----------
+
+The _mongoc_collection_find_and_modify()_ function is a helper for the
+findAndModify command.
+
+Documents matching _query_ and sorted with _sort_ will be updated using
+_update_ as the update specification. Only fields matching _fields_ will
+be returned.
+
+If _remove_ is true, then matching documents will be removed.
+
+If _upsert_ is true and no document matching _query_ is found, then
+a new document will be inserted.
+
+If _return_new_ is true, then the new version of the document is returned.
+Otherwise, the previous version of the document is returned.
+
+_reply_ is a location to store the resulting document. It will always be
+initialized even if the command is failed. Release this with _bson_destroy()_.
+
+
+RETURN VALUE
+------------
+true if the command executed successfully.
+false if the command failed and _error_ is set.
+
+
+AUTHORS
+-------
+This page was written by MongoDB, Inc.

doc/mongoc_collection_rename.txt

@@ -0,0 +1,44 @@
+mongoc_collection_rename(3)
+===========================
+
+
+NAME
+----
+mongoc_collection_rename - rename a MongoDB collection
+
+
+SYNOPSIS
+--------
+[source,c]
+-----------------------
+bool mongoc_collection_rename (mongoc_collection_t *collection,
+                               const char          *new_db,
+                               const char          *new_name,
+                               bool                 drop_target_before_rename,
+                               bson_error_t        *error);
+-----------------------
+
+
+DESCRIPTION
+-----------
+
+The _mongoc_collection_rename()_ function is a helper to rename an
+existing collection on the MongoDB server.
+
+_new_db_ is the name of the new database to place the collection within.
+
+_new_name_ is the name of the new collection within _new_db_.
+
+If _drop_target_before_rename_ is true, than any collection matching
+_new_name_ will be dropped before renaming the collection.
+
+
+RETURN VALUE
+------------
+true if the command executed successfully.
+false if the command failed and _error_ is set.
+
+
+AUTHORS
+-------
+This page was written by MongoDB, Inc.

doc/mongoc_collection_stats.txt

@@ -0,0 +1,44 @@
+mongoc_collection_stats(3)
+==========================
+
+
+NAME
+----
+mongoc_collection_stats - fetch stats on a MongoDB collection
+
+
+SYNOPSIS
+--------
+[source,c]
+-----------------------
+bool mongoc_collection_stats (mongoc_collection_t *collection,
+                              const bson_t        *options,
+                              bson_t              *reply,
+                              bson_error_t        *error);
+-----------------------
+
+
+DESCRIPTION
+-----------
+
+The _mongoc_collection_stats()_ function is a helper to retrieve stats
+on a MongoDB collection.
+
+_options_ is an optional bson document containing extra options to pass
+to the _collStats_ command.
+
+If successful, the results are stored in _reply_.
+
+_reply_ is initialized even in the case of failure. Release this
+with _bson_destroy()_.
+
+
+RETURN VALUE
+------------
+true if the command executed successfully.
+false if the command failed and _error_ is set.
+
+
+AUTHORS
+-------
+This page was written by MongoDB, Inc.

doc/mongoc_collection_validate.txt

@@ -0,0 +1,47 @@
+mongoc_collection_validate(3)
+=============================
+
+
+NAME
+----
+mongoc_collection_validate - validate the contents of a MongoDB collection
+
+
+SYNOPSIS
+--------
+[source,c]
+-----------------------
+bool mongoc_collection_validate (mongoc_collection_t *collection,
+                                 const bson_t        *options,
+                                 bson_t              *reply,
+                                 bson_error_t        *error);
+-----------------------
+
+
+DESCRIPTION
+-----------
+
+The _mongoc_collection_validate()_ function is a helper to validate a MongoDB
+collection.
+
+_options_ is an optional bson document containing extra options to pass
+to the _validate_ command.
+
+Currently supported options are::
+
+    - if _full_ is true, then a more thorough scan is performed.
+    - if _scandata_ is false, then indexes are scanned but not data.
+
+The results are stored in _reply_. _reply_ is initialized even in the case of
+failure. Release this with _bson_destroy()_.
+
+
+RETURN VALUE
+------------
+true if the command executed successfully.
+false if the command failed and _error_ is set.
+
+
+AUTHORS
+-------
+This page was written by MongoDB, Inc.

doc/mongoc_cursor_current.txt

@@ -0,0 +1,33 @@
+mongoc_cursor_current(3)
+========================
+
+
+NAME
+----
+mongoc_collection_current - fetch current document from MongoDB cursor
+
+
+SYNOPSIS
+--------
+[source,c]
+-----------------------
+const bson_t *mongoc_cursor_current (const mongoc_cursor_t *);
+-----------------------
+
+
+DESCRIPTION
+-----------
+This function returns the current document observed by a _mongoc_cursor_t_.
+This is the same as the result document from _mongoc_cursor_next()_.
+
+This primarily useful to language bindings.
+
+
+RETURN VALUE
+------------
+A document which should not be modified or freed.
+
+
+AUTHORS
+-------
+This page was written by MongoDB, Inc.