'\" t
.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MONGOC_QUERY_FLAGS_T" "3" "May 07, 2024" "1.27.1" "libmongoc"
.sp
Flags for query operations
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
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;
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
These flags correspond to the MongoDB wire protocol. They may be bitwise or\(aqd together. They may modify how a query is performed in the MongoDB server.
.SH FLAG VALUES
.TS
center;
|l|l|.
_
T{
MONGOC_QUERY_NONE
T}	T{
Specify no query flags.
T}
_
T{
MONGOC_QUERY_TAILABLE_CURSOR
T}	T{
Cursor will not be closed when the last data is retrieved. You can resume this cursor later.
T}
_
T{
MONGOC_QUERY_SECONDARY_OK
T}	T{
Allow query of replica set secondaries.
T}
_
T{
MONGOC_QUERY_OPLOG_REPLAY
T}	T{
Used internally by MongoDB.
T}
_
T{
MONGOC_QUERY_NO_CURSOR_TIMEOUT
T}	T{
The server normally times out an idle cursor after an inactivity period (10 minutes). This prevents that.
T}
_
T{
MONGOC_QUERY_AWAIT_DATA
T}	T{
Use with MONGOC_QUERY_TAILABLE_CURSOR. Block rather than returning no data. After a period, time out.
T}
_
T{
MONGOC_QUERY_EXHAUST
T}	T{
Stream the data down full blast in multiple \(dqreply\(dq 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. \fI\%mongoc_collection_find()\fP).
T}
_
T{
MONGOC_QUERY_PARTIAL
T}	T{
Get partial results from mongos if some shards are down (instead of throwing an error).
T}
_
.TE
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.