mongoc_collection_create_index_with_opts()¶
Synopsis¶
bool
mongoc_collection_create_index_with_opts (mongoc_collection_t *collection,
const bson_t *keys,
const mongoc_index_opt_t *index_opts,
const bson_t *command_opts,
bson_t *reply,
bson_error_t *error);
Deprecated¶
This function is deprecated and should not be used in new code. See Creating Indexes.
Parameters¶
collection: A mongoc_collection_t.keys: Abson_t.index_opts: A mongoc_index_opt_t.command_opts: Abson_twith extra options, such as writeConcern or collation, orNULL.reply: An optional location for abson_twhich will store the server’s reply.error: An optional location for a bson_error_t orNULL.
Description¶
This function will request the creation of a new index.
This function will use the createIndexes command.
The server’s reply is stored in reply.
If no write concern is provided in command_opts, the collection’s write concern is used.
See mongoc_index_opt_t for options on creating indexes.
Errors¶
Errors are propagated via the error parameter.
Returns¶
Returns true if successful. Returns false and sets error if there are invalid arguments or a server or network error.
reply is always initialized and must be destroyed with bson_destroy(). If the server is running an obsolete version of MongoDB then reply may be empty, though it will still be initialized.