1MONGOC_COLLECTION_FIND_INDEXES_WMIoTnHg_oMODOPBNTGSCO(C3D_)rCiOvLeLrECTION_FIND_INDEXES_WITH_OPTS(3)
2
3
4

NAME

6       mongoc_collection_find_indexes_with_opts        -        mongoc_collec‐
7       tion_find_indexes_with_opts()
8

SYNOPSIS

10          mongoc_cursor_t *
11          mongoc_collection_find_indexes_with_opts (mongoc_collection_t *collection,
12                                                    const bson_t *opts);
13
14       Fetches a cursor containing documents, each corresponding to  an  index
15       on this collection.
16

PARAMETERS

18       · collection: A mongoc_collection_t.
19
20       · opts: A bson_t containing additional options.
21
22       opts may be NULL or a BSON document with additional command options:
23
24       · sessionId:  First,  construct  a  mongoc_client_session_t  with  mon‐
25         goc_client_start_session. You  can  begin  a  transaction  with  mon‐
26         goc_client_session_start_transaction, optionally with a mongoc_trans‐
27         action_opt_t that overrides the options  inherited  from  collection,
28         and  use mongoc_client_session_append to add the session to opts. See
29         the example code for mongoc_client_session_t.
30
31       · serverId: To target a specific server, include  an  int32  "serverId"
32         field.  Obtain  the  id  by calling mongoc_client_select_server, then
33         mongoc_server_description_id on its return value.
34

ERRORS

36       Use mongoc_cursor_error on the returned cursor to check for errors.
37

RETURNS

39       A cursor where each result corresponds to the  server's  representation
40       of an index on this collection. If the collection does not exist on the
41       server, the cursor will be empty.
42
43       The    cursor    functions     mongoc_cursor_set_limit,     mongoc_cur‐
44       sor_set_batch_size, and mongoc_cursor_set_max_await_time_ms have no use
45       on the returned cursor.
46

AUTHOR

48       MongoDB, Inc
49

51       2017-present, MongoDB, Inc
52
53
54
55
561.13.1                           JanMO2N4G,OC2_0C1O9LLECTION_FIND_INDEXES_WITH_OPTS(3)
Impressum