FreeBSD Manual Pages
MONGOC_QUERY_FLAGS_T(3) libmongoc MONGOC_QUERY_FLAGS_T(3) Flags for query operations SYNOPSIS typedef enum { MONGOC_QUERY_NONE = 0, MONGOC_QUERY_TAILABLE_CURSOR = 1 << 1, MONGOC_QUERY_SECONDARY_OK = 1 << 2, MONGOC_QUERY_OPLOG_REPLAY = 1 << 3, MONGOC_QUERY_NO_CURSOR_TIMEOUT = 1 << 4, MONGOC_QUERY_AWAIT_DATA = 1 << 5, MONGOC_QUERY_EXHAUST = 1 << 6, MONGOC_QUERY_PARTIAL = 1 << 7, } mongoc_query_flags_t; DESCRIPTION These flags correspond to the MongoDB wire protocol. They may be bit- wise or'd together. They may modify how a query is performed in the MongoDB server. FLAG VALUES +----------------------------+----------------------------+ | MONGOC_QUERY_NONE | Specify no query flags. | +----------------------------+----------------------------+ | MONGOC_QUERY_TAILABLE_CUR- | Cursor will not be closed | | SOR | when the last data is re- | | | trieved. You can resume | | | this cursor later. | +----------------------------+----------------------------+ | MONGOC_QUERY_SECONDARY_OK | Allow query of replica set | | | secondaries. | +----------------------------+----------------------------+ | MONGOC_QUERY_OPLOG_REPLAY | Used internally by Mon- | | | goDB. | +----------------------------+----------------------------+ | MONGOC_QUERY_NO_CUR- | The server normally times | | SOR_TIMEOUT | out an idle cursor after | | | an inactivity period (10 | | | minutes). This prevents | | | that. | +----------------------------+----------------------------+ | MONGOC_QUERY_AWAIT_DATA | Use with MON- | | | GOC_QUERY_TAILABLE_CURSOR. | | | Block rather than return- | | | ing no data. After a pe- | | | riod, time out. | +----------------------------+----------------------------+ | MONGOC_QUERY_EXHAUST | Stream the data down full | | | blast in multiple "reply" | | | packets. Faster when you | | | are pulling down a lot of | | | data and you know you want | | | to retrieve it all. Only | | | applies to cursors created | | | from a find operation | | | (i.e. | | | mongoc_collection_find()). | +----------------------------+----------------------------+ | MONGOC_QUERY_PARTIAL | Get partial results from | | | mongos if some shards are | | | down (instead of throwing | | | an error). | +----------------------------+----------------------------+ AUTHOR MongoDB, Inc COPYRIGHT 2009-present, MongoDB, Inc. 1.30.2 Apr 12, 2025 MONGOC_QUERY_FLAGS_T(3)
SYNOPSIS | DESCRIPTION | FLAG VALUES | AUTHOR | COPYRIGHT
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_query_flags_t&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>