Scroll to navigation

MONGOC_BULK_OPERATION_SET_HINT(3) libmongoc MONGOC_BULK_OPERATION_SET_HINT(3)

WARNING:

Deprecated since version 1.28.0: This function is deprecated and should not be used in new code.

Please use mongoc_bulk_operation_set_server_id() in new code.



SYNOPSIS

void
mongoc_bulk_operation_set_hint (mongoc_bulk_operation_t *bulk, uint32_t server_id)


  BSON_GNUC_DEPRECATED_FOR (mongoc_bulk_operation_set_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.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.

October 9, 2024 1.28.1