mongoc_cursor_set_hint man page

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

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

true if successful, otherwise false and logs an error.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐10‐20 MongoDB C Driver