oracular (3) mongoc_client_pool_enable_auto_encryption.3.gz

SYNOPSIS

          bool
          mongoc_client_pool_enable_auto_encryption (mongoc_client_pool_t *pool,
                                                     mongoc_auto_encryption_opts_t* opts,
                                                     bson_error_t* error);

       Enable  automatic  client  side encryption on a mongoc_client_pool_t. Requires libmongoc to be built with
       support for In-Use Encryption. See In-Use Encryption for instructions  to  enable  In-Use  Encryption  in
       libmongoc.

       Automatic  encryption  is  an  enterprise-only  feature  that only applies to operations on a collection.
       Automatic encryption is not supported for operations on a database or view, and operations that  are  not
       bypassed  will  result  in  error.  To  bypass  automatic encryption for all operations, bypass automatic
       encryption with mongoc_auto_encryption_opts_set_bypass_auto_encryption() in opts.

       Automatic encryption requires the authenticated user to have the listCollections privilege action.

       Enabling automatic encryption reduces the maximum message  size  and  may  have  a  negative  performance
       impact.

PARAMETERS

       • client: A mongoc_client_t.

       • opts: A required mongoc_auto_encryption_opts_t.

       • error: A bson_error_t which is set on error.

RETURNS

       Returns true if successful. Returns false and sets error otherwise.

       SEE ALSO:
          mongoc_auto_encryption_opts_t

          mongoc_client_enable_auto_encryption()

          In-Use Encryption for libmongoc

          The MongoDB Manual for Client-Side Field Level Encryption

          The MongoDB Manual for Queryable Encryption

AUTHOR

       MongoDB, Inc

COPYRIGHT

       2017-present, MongoDB, Inc