bionic (3) mongoc_session_opt_t.3.gz

Provided by: libmongoc-doc_1.9.2+dfsg-1build1_all bug

NAME
       mongoc_session_opt_t - mongoc_session_opt_t

          #include <mongoc.h>

          typedef struct _mongoc_session_opt_t mongoc_session_opt_t;


SYNOPSIS
       Start a session with mongoc_client_start_session, use the session for a sequence of operations, then free
       it with mongoc_client_session_destroy(). A session must be freed before the mongoc_client_t it came from.

       By default, sessions are causally consistent. To disable causal consistency, before  starting  a  session
       create       a       mongoc_session_opt_t       with       mongoc_session_opts_new()       and       call
       mongoc_session_opts_set_causal_consistency(), then free the struct with mongoc_session_opts_destroy.

       Unacknowledged  writes  are  not  causally  consistent.  If  you  execute  a  write  operation   with   a
       mongoc_write_concern_t  on  which you have called mongoc_write_concern_set_w with a value of 0, the write
       does not participate in causal consistency.

       A mongoc_client_session_t must  be  used  by  only  one  thread  at  a  time.  Due  to  session  pooling,
       mongoc_client_start_session  may  return  a  session  that has been idle for some time and is about to be
       closed after its idle timeout. Use the session within one minute of acquiring it to refresh  the  session
       and avoid a timeout.

       See the example code for mongoc_session_opts_set_causal_consistency.


AUTHOR
       MongoDB, Inc


       2018, MongoDB, Inc