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

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_CURSOR_SET_SERVER_ID(3)	   libmongoc	MONGOC_CURSOR_SET_SERVER_ID(3)

SYNOPSIS
	  bool
	  mongoc_cursor_set_server_id (mongoc_cursor_t *cursor,	uint32_t server_id)

PARAMETERS
        cursor: A mongoc_cursor_t.

        server_id: An opaque id identifying the server	to use.

DESCRIPTION
       Specifies  which	 server	to use for the operation. This function	has an
       effect only if called before the	find operation is executed.

       Use mongoc_cursor_set_server_id only for	 building  a  language	driver
       that  wraps  the	 C  Driver.  When writing applications in C, leave the
       server id unset and allow the driver to choose a	suitable  server  from
       the find	operation's read preference.

RETURNS
       Returns	true  on  success. If any arguments are	invalid, returns false
       and logs	an error.

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025	MONGOC_CURSOR_SET_SERVER_ID(3)

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

home | help