bionic (3) mongoc_cursor_set_hint.3.gz

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

NAME
       mongoc_cursor_set_hint - mongoc_cursor_set_hint()


SYNOPSIS
          bool
          mongoc_cursor_set_hint (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.

       (The function name includes the old term "hint" for the sake of backward compatibility, but we  now  call
       this number a "server id".)

       Use  mongoc_cursor_set_hint  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


       2018, MongoDB, Inc