1MONGOC_COLLECTION_FIND_INDEXES_WITH_lMOiOPbNTmGSoO(nC3g_)oCcOLLECTION_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
17       This  function  is considered a retryable read operation.  Upon a tran‐
18       sient error (a network error, errors due to replica set failover, etc.)
19       the  operation  is  safely retried once.  If retryreads is false in the
20       URI (see mongoc_uri_t) the retry behavior does not apply.
21

PARAMETERS

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

ERRORS

41       Use mongoc_cursor_error on the returned cursor to check for errors.
42

RETURNS

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

AUTHOR

53       MongoDB, Inc
54

56       2017-present, MongoDB, Inc
57
58
59
60
611.16.2                           FebMO2N5G,OC2_0C2O0LLECTION_FIND_INDEXES_WITH_OPTS(3)
Impressum