Scroll to navigation

MONGOC_READ_PREFS_SET_HEDGE(3) libmongoc MONGOC_READ_PREFS_SET_HEDGE(3)

Deprecated since version MongoDB: Server 8.0

Hedged reads are deprecated in MongoDB version 8.0 and will be removed in a future release.

SYNOPSIS

void
mongoc_read_prefs_set_hedge (mongoc_read_prefs_t *read_prefs,


                             const bson_t *hedge);


PARAMETERS

  • read_prefs: A mongoc_read_prefs_t.
  • hedge: A bson_t.

DESCRIPTION

Sets the hedge document to be used for the read preference. Sharded clusters running MongoDB 4.4 or later can dispatch read operations in parallel, returning the result from the fastest host and cancelling the unfinished operations.

For example, this is a valid hedge document

{


   enabled: true
}


Appropriate values for the enabled key are true or false.

AUTHOR

MongoDB, Inc

COPYRIGHT

2009-present, MongoDB, Inc.

June 17, 2025 2.0.2