1MONGOC_QUERY_FLAGS_T(3) libmongoc MONGOC_QUERY_FLAGS_T(3)
2
6 mongoc_query_flags_t - mongoc_query_flags_t
7 Flags for query operations
9
11 typedef enum {
12 MONGOC_QUERY_NONE = 0,
13 MONGOC_QUERY_TAILABLE_CURSOR = 1 << 1,
14 MONGOC_QUERY_SECONDARY_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
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
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 re‐ │
33 │ │ trieved. You can resume │
34 │ │ this cursor later. │
35 ├───────────────────────────┼────────────────────────────┤
36 │MONGOC_QUERY_SECONDARY_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 pe‐ │
52 │ │ riod, 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. Only │
60 │ │ applies to cursors created │
61 │ │ from a find operation │
62 │ │ (i.e. │
63 │ │ mongoc_collection_find()). │
64 └───────────────────────────┴────────────────────────────┘
65 │MONGOC_QUERY_PARTIAL │ Get partial results from │
68 │ │ mongos if some shards are │
69 │ │ down (instead of throwing │
70 │ │ an error). │
71 └───────────────────────────┴────────────────────────────┘
72
74 MongoDB, Inc
75
77 2017-present, MongoDB, Inc
781.24.3 Aug 17, 2023 MONGOC_QUERY_FLAGS_T(3)