1MONGOC_CLIENT_FIND_DATABASES_WITH_OPlTiSbM(mO3oN)nGgOoCc_CLIENT_FIND_DATABASES_WITH_OPTS(3)
2
3
4

NAME

6       mongoc_client_find_databases_with_opts    -    mongoc_client_find_data‐
7       bases_with_opts()
8

SYNOPSIS

10          mongoc_cursor_t *
11          mongoc_client_find_databases_with_opts (
12             mongoc_client_t *client, const bson_t *opts) BSON_GNUC_WARN_UNUSED_RESULT;
13
14       Fetches a cursor containing documents, each corresponding to a database
15       on this MongoDB server.
16

PARAMETERS

18       • client: A mongoc_client_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  client,  and
28         use  mongoc_client_session_append to add the session to opts. See the
29         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
35       This function is considered a retryable read operation.  Upon  a  tran‐
36       sient error (a network error, errors due to replica set failover, etc.)
37       the operation is safely retried once.  If retryreads is  false  in  the
38       URI (see mongoc_uri_t) the retry behavior does not apply.
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 a database.
46
47       The    cursor    functions     mongoc_cursor_set_limit,     mongoc_cur‐
48       sor_set_batch_size, and mongoc_cursor_set_max_await_time_ms have no use
49       on the returned cursor.
50

AUTHOR

52       MongoDB, Inc
53

55       2017-present, MongoDB, Inc
56
57
58
59
601.20.0                           Nov 1M8O,NG2O0C2_1CLIENT_FIND_DATABASES_WITH_OPTS(3)
Impressum