mongoc_bulk_operation_set_hint man page

mongoc_bulk_operation_set_hint() — Specifies which server to use for the operation. This function has an effect only if called before mongoc_bulk_operation_execute.

Synopsis

void
mongoc_bulk_operation_set_hint (const mongoc_bulk_operation_t *bulk,
                                uint32_t                       server_id);

Parameters

bulk
A mongoc_bulk_operation_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 mongoc_bulk_operation_execute

(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_bulk_operation_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 for the bulk operation.

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