File: mongoc_client_set_read_concern.rst

package info (click to toggle)
mongo-c-driver 1.17.6-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 37,256 kB
  • sloc: ansic: 152,613; javascript: 7,954; python: 3,259; sh: 138; makefile: 29; xml: 10
file content (26 lines) | stat: -rw-r--r-- 895 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
:man_page: mongoc_client_set_read_concern

mongoc_client_set_read_concern()
================================

Synopsis
--------

.. code-block:: c

  void
  mongoc_client_set_read_concern (mongoc_client_t *client,
                                  const mongoc_read_concern_t *read_concern);

Sets the read concern for the client. This only affects future operations, collections, and databases inheriting from ``client``.

The default read concern is MONGOC_READ_CONCERN_LEVEL_LOCAL. This is the correct read concern for the great majority of applications.

It is a programming error to call this function on a client from a :symbol:`mongoc_client_pool_t`. For pooled clients, set the read concern with the :ref:`MongoDB URI <mongoc_uri_t_read_concern_options>` instead.

Parameters
----------

* ``client``: A :symbol:`mongoc_client_t`.
* ``read_concern``: A :symbol:`mongoc_read_concern_t`.