mongoc_collection_command (3) - Linux Manuals
mongoc_collection_command: This function shall execute a command on a collection. This is performed lazily and therefore requires calling mongoc_cursor_next() on the resulting cursor structure. The cursor should be freed with mongoc_cursor_destroy() when no longer in use.
Command to display mongoc_collection_command manual in Linux: $ man 3 mongoc_collection_command
NAME
mongoc_collection_command() - This function shall execute a command on a collection. This is performed lazily and therefore requires calling mongoc_cursor_next() on the resulting cursor structure. The cursor should be freed with mongoc_cursor_destroy() when no longer in use.
SYNOPSIS
mongoc_cursor_t *
mongoc_collection_command (mongoc_collection_t *collection,
mongoc_query_flags_t flags,
uint32_t skip,
uint32_t limit,
uint32_t batch_size,
const bson_t *command,
const bson_t *fields,
const mongoc_read_prefs_t *read_prefs)
BSON_GNUC_WARN_UNUSED_RESULT;
PARAMETERS
- collection
-
A
mongoc_collection_t
\&.
- flags
-
A
mongoc_query_flags_t
\&.
- skip
-
A uint32_t with the number of documents to skip or zero.
- limit
-
A uint32_t with the max number of documents to return or zero.
- batch_size
-
A uint32_t with the number of documents in each batch or zero. Default is 100.
- command
-
A
bson_t
containing the command to execute.
- fields
-
A
bson_t
containing the fields to return or
NULL
\&. Not all commands support this option.
- read_prefs
-
A
mongoc_read_prefs_t
or
NULL
\&.
DESCRIPTION
This function shall execute a command on a collection. This is performed lazily and therefore requires calling
mongoc_cursor_next(3)
on the resulting cursor structure. The cursor should be freed with
mongoc_cursor_destroy(3)
when no longer in use.
RETURNS
A lazy
mongoc_cursor_t
that should be freed with
mongoc_cursor_destroy(3)
\&.
NOTE
-
Failure to handle the result of this function is a programming error.
COLOPHON
This page is part of MongoDB C Driver.
Please report any bugs at
https://jira.mongodb.org/browse/CDRIVER.
Pages related to mongoc_collection_command
- mongoc_collection_command_simple (3) - This is a simplified version of mongoc_collection_command() that returns the first result document in reply. The parameter reply is initialized even upon failure to simplify memory management.
- mongoc_collection_copy (3) - Performs a deep copy of the collection struct and its configuration. Useful if you intend to call mongoc_collection_set_write_concern, mongoc_collection_set_read_prefs, or mongoc_collection_set_read_concern, and want to preserve an unaltered copy of the struct.
- mongoc_collection_count (3) - This function shall execute a count query on the underlying 'collection'. The bson 'query' is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation.
- mongoc_collection_count_with_opts (3) - This function shall execute a count query on the underlying 'collection'. The bson 'query' is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation.
- mongoc_collection_create_bulk_operation (3) - This function shall begin a new bulk operation. After creating this you may call various functions such as mongoc_bulk_operation_update(), mongoc_bulk_operation_insert() and others.
- mongoc_collection_create_index (3) - This function will request the creation of a new index.
- mongoc_collection_aggregate (3) - This function shall execute an aggregation query on the underlying 'collection'. The bson 'pipeline' is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation.
- mongoc_collection_delete (3) - This function shall delete documents in the given collection that match selector. The bson selector is not validated, simply passed along as appropriate to the server. As such, compatibility and errors should be validated in the appropriate server documentation.
- mongoc_collection_destroy (3) - This function shall destroy a mongoc_collection_t and its associated resources.
- mongoc_collection_drop (3) - This function requests that a collection be dropped, including all indexes associated with the collection.
- mongoc_collection_drop_index (3) - This function requests than an index on collection be dropped. In the event of an error it returns false and error is set.
- mongoc_collection_ensure_index (3) - None
- mongoc_collection_find (3) - This function shall execute a query on the underlying collection.
- mongoc_collection_find_and_modify (3) - Update and return an object.
- mongoc_collection_find_and_modify_with_opts (3) - Update and return an object.
- mongoc_collection_find_indexes (3) - None
- mongoc_collection_get_last_error (3) - The mongoc_collection_get_last_error() function shall return getLastError document, according to write_concern on last executed command for current collection instance.
- mongoc_collection_get_name (3) - Fetches the name of collection.
- mongoc_collection_get_read_concern (3) - Fetches the default read concern to be used on read operations originating from collection.
- mongoc_collection_get_read_prefs (3) - Fetches the default read preferences to use for collection. Operations without specified read-preferences will default to this.
- mongoc_collection_get_write_concern (3) - Fetches the default write concern to be used on write operations originating from collection and not specifying a write concern.
- mongoc_collection_insert (3) - This function shall insert document into collection.