Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_SESSION_OPT_T(3)		   libmongoc	       MONGOC_SESSION_OPT_T(3)

	  #include <mongoc/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 and multi-document transactions, then free it
       with   mongoc_client_session_destroy().	  Any	 mongoc_cursor_t    or
       mongoc_change_stream_t  using  a	 session  must be destroyed before the
       session,	and a session must be destroyed	before the mongoc_client_t  it
       came from.

       By default, sessions are	causally consistent. To	disable	causal consis-
       tency,  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 prohibited with sessions.

       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 ses-
       sion 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

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025	       MONGOC_SESSION_OPT_T(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_session_opt_t&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help