1MONGOC_QUERY_FLAGS_T(3)            libmongoc           MONGOC_QUERY_FLAGS_T(3)
2
3
4

NAME

6       mongoc_query_flags_t - mongoc_query_flags_t
7
8       Flags for query operations
9

SYNOPSIS

11          typedef enum {
12             MONGOC_QUERY_NONE = 0,
13             MONGOC_QUERY_TAILABLE_CURSOR = 1 << 1,
14             MONGOC_QUERY_SLAVE_OK = 1 << 2,
15             MONGOC_QUERY_OPLOG_REPLAY = 1 << 3,
16             MONGOC_QUERY_NO_CURSOR_TIMEOUT = 1 << 4,
17             MONGOC_QUERY_AWAIT_DATA = 1 << 5,
18             MONGOC_QUERY_EXHAUST = 1 << 6,
19             MONGOC_QUERY_PARTIAL = 1 << 7,
20          } mongoc_query_flags_t;
21

DESCRIPTION

23       These  flags  correspond to the MongoDB wire protocol. They may be bit‐
24       wise or'd together. They may modify how a query  is  performed  in  the
25       MongoDB server.
26

FLAG VALUES

28              ┌───────────────────────────┬────────────────────────────┐
29              │MONGOC_QUERY_NONE          │ Specify no query flags.    │
30              ├───────────────────────────┼────────────────────────────┤
31              │MONGOC_QUERY_TAILABLE_CUR‐ │ Cursor will not be  closed │
32              │SOR                        │ when   the  last  data  is │
33              │                           │ retrieved. You can  resume │
34              │                           │ this cursor later.         │
35              ├───────────────────────────┼────────────────────────────┤
36              │MONGOC_QUERY_SLAVE_OK      │ Allow query of replica set │
37              │                           │ secondaries.               │
38              ├───────────────────────────┼────────────────────────────┤
39              │MONGOC_QUERY_OPLOG_REPLAY  │ Used  internally  by  Mon‐ │
40              │                           │ goDB.                      │
41              ├───────────────────────────┼────────────────────────────┤
42              │MONGOC_QUERY_NO_CUR‐       │ The server normally  times │
43              │SOR_TIMEOUT                │ out  an  idle cursor after │
44              │                           │ an inactivity  period  (10 │
45              │                           │ minutes).   This  prevents │
46              │                           │ that.                      │
47              ├───────────────────────────┼────────────────────────────┤
48              │MONGOC_QUERY_AWAIT_DATA    │ Use       with        MON‐ │
49              │                           │ GOC_QUERY_TAILABLE_CURSOR. │
50              │                           │ Block rather than  return‐ │
51              │                           │ ing   no   data.  After  a │
52              │                           │ period, time out.          │
53              ├───────────────────────────┼────────────────────────────┤
54              │MONGOC_QUERY_EXHAUST       │ Stream the data down  full │
55              │                           │ blast  in multiple "reply" │
56              │                           │ packets. Faster  when  you │
57              │                           │ are  pulling down a lot of │
58              │                           │ data and you know you want │
59              │                           │ to retrieve it all.        │
60              ├───────────────────────────┼────────────────────────────┤
61              │MONGOC_QUERY_PARTIAL       │ Get  partial  results from │
62              │                           │ mongos if some shards  are │
63              │                           │ down  (instead of throwing │
64              │                           │ an error).                 │
65              └───────────────────────────┴────────────────────────────┘
66

AUTHOR

68       MongoDB, Inc
69

71       2017-present, MongoDB, Inc
72
73
74
75
761.16.2                           Feb 25, 2020          MONGOC_QUERY_FLAGS_T(3)
Impressum