---
name: "mongoc_collection_create_indexes_with_opts"
section: "3"
platform: "linux"
package: "libmongoc-doc"
version: "1.30.4-1+deb13u3"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mongoc_collection_create_indexes_with_opts"
---

# mongoc\_collection\_create\_indexes\_with\_opts(3)

## SYNOPSIS

```
typedef struct _mongoc_index_model_t mongoc_index_model_t;
mongoc_index_model_t *
mongoc_index_model_new (const bson_t *keys, const bson_t *opts);
void mongoc_index_model_destroy (mongoc_index_model_t *model);
bool
mongoc_collection_create_indexes_with_opts (mongoc_collection_t *collection,
                                            mongoc_index_model_t **models,
                                            size_t n_models,
                                            const bson_t *opts,
                                            bson_t *reply,
                                            bson_error_t *error);
```

## PARAMETERS

- •

  **collection**: A *mongoc\_collection\_t*.

- •

  **models**: An array of **mongoc\_index\_model\_t \***.

- •

  **n\_models**: The number of **models**.

- •

  **opts**: Optional options.

- •

  **reply**: A maybe-**NULL** pointer to *overwritable storage* for a *bson\_t* to contain the results.

- •

  **error**: An optional location for a *bson\_error\_t* or **NULL**.

**opts** may be NULL or a BSON document with additional command options:

- •

  **writeConcern**: Construct a *mongoc\_write\_concern\_t* and use *mongoc\_write\_concern\_append()* to add the write concern to **opts**. See the example code for *mongoc\_client\_write\_command\_with\_opts()*.

- •

  **sessionId**: First, construct a *mongoc\_client\_session\_t* with *mongoc\_client\_start\_session()*. You can begin a transaction with *mongoc\_client\_session\_start\_transaction()*, optionally with a *mongoc\_transaction\_opt\_t* that overrides the options inherited from **collection**, and use *mongoc\_client\_session\_append()* to add the session to **opts**. See the example code for *mongoc\_client\_session\_t*.

- •

  **collation**: Configure textual comparisons. See *Setting Collation Order*, and *the MongoDB Manual entry on Collation*. Collation requires MongoDB 3.2 or later, otherwise an error is returned.

- •

  **serverId**: To target a specific server, include an int32 "serverId" field. Obtain the id by calling *mongoc\_client\_select\_server()*, then *mongoc\_server\_description\_id()* on its return value.

Additional options passed in **opts** are appended to the **createIndexes** command. See the *MongoDB Manual for createIndexes* for all supported options.

If no write concern is provided in **opts**, the collection's write concern is used.

### mongoc\_index\_model\_t

Each **mongoc\_index\_model\_t** represents an index to create. **mongoc\_index\_model\_new** includes:

- •

  **keys** Expected to match the form of the **key** field in the *createIndexes* command.

- •

  **opts** Optional index options appended as a sibling to the **key** field in the *createIndexes* command.

## DESCRIPTION

This function wraps around the *createIndexes* command.

## 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.

**SEE ALSO:**

```
Manage Collection Indexes.
```

## AUTHOR

MongoDB, Inc

## COPYRIGHT

2009-present, MongoDB, Inc.