Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MONGOCRYPT-696 document "range" as unstable #832

Merged
merged 3 commits into from
Jun 17, 2024
Merged

MONGOCRYPT-696 document "range" as unstable #832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92c3bd8
document "range" as unstable
kevinAlbs Jun 13, 2024
46b9895
Merge branch 'master' into document-range-as-unstable
kevinAlbs Jun 13, 2024
a19676a
regenerate stripped header in pymongocrypt
kevinAlbs Jun 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions bindings/python/pymongocrypt/binding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -667,6 +667,7 @@ def _parse_version(version):
/// String constant for setopt_algorithm "rangePreview" explicit encryption (deprecated in favor of "range")
/// NOTE: "rangePreview" is experimental only and is not intended for public use.
/// API for "rangePreview" may be removed in a future release.
// NOTE: "Range" is currently unstable API and subject to backwards breaking changes.

/**
* Identify the AWS KMS master key to use for creating a data key.
Expand Down Expand Up @@ -852,6 +853,7 @@ def _parse_version(version):
*
* NOTE: "rangePreview" is experimental only and is not intended for public use.
* API for "rangePreview" may be removed in a future release.
* NOTE: "range" is currently unstable API and subject to backwards breaking changes.
*
* This method expects the passed-in BSON to be of the form:
* { "v" : FLE2RangeFindDriverSpec }
Expand Down Expand Up @@ -1362,6 +1364,7 @@ def _parse_version(version):

/**
* @brief Opt-into use of Queryable Encryption Range V2 protocol.
* NOTE: "range" is currently unstable API and subject to backwards breaking changes.
*
* @param[in] crypt The @ref mongocrypt_t object.
*
Expand Down Expand Up @@ -1413,6 +1416,7 @@ def _parse_version(version):

/**
* Set options for explicit encryption with the "range" algorithm.
* NOTE: "range" is currently unstable API and subject to backwards breaking changes.
*
* @p opts is a BSON document of the form:
* {
Expand All @@ -1435,6 +1439,7 @@ def _parse_version(version):
// 'rangePreview' is deprecated in favor of range.
/// NOTE: "rangePreview" is experimental only and is not intended for public use.
/// API for "rangePreview" may be removed in a future release.
/// NOTE: "range" is currently unstable API and subject to backwards breaking changes.

"""
)
Expand Down
5 changes: 5 additions & 0 deletions src/mongocrypt.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,7 @@ bool mongocrypt_ctx_setopt_algorithm(mongocrypt_ctx_t *ctx, const char *algorith
/// NOTE: "rangePreview" is experimental only and is not intended for public use.
/// API for "rangePreview" may be removed in a future release.
#define MONGOCRYPT_ALGORITHM_RANGEPREVIEW_DEPRECATED_STR "RangePreview"
// NOTE: "Range" is currently unstable API and subject to backwards breaking changes.
#define MONGOCRYPT_ALGORITHM_RANGE_STR "Range"

/**
Expand Down Expand Up @@ -883,6 +884,7 @@ bool mongocrypt_ctx_explicit_encrypt_init(mongocrypt_ctx_t *ctx, mongocrypt_bina
*
* NOTE: "rangePreview" is experimental only and is not intended for public use.
* API for "rangePreview" may be removed in a future release.
* NOTE: "range" is currently unstable API and subject to backwards breaking changes.
*
* This method expects the passed-in BSON to be of the form:
* { "v" : FLE2RangeFindDriverSpec }
Expand Down Expand Up @@ -1418,6 +1420,7 @@ void mongocrypt_setopt_bypass_query_analysis(mongocrypt_t *crypt);

/**
* @brief Opt-into use of Queryable Encryption Range V2 protocol.
* NOTE: "range" is currently unstable API and subject to backwards breaking changes.
*
* @param[in] crypt The @ref mongocrypt_t object.
*
Expand Down Expand Up @@ -1473,6 +1476,7 @@ bool mongocrypt_ctx_setopt_query_type(mongocrypt_ctx_t *ctx, const char *query_t

/**
* Set options for explicit encryption with the "range" algorithm.
* NOTE: "range" is currently unstable API and subject to backwards breaking changes.
*
* @p opts is a BSON document of the form:
* {
Expand All @@ -1498,6 +1502,7 @@ bool mongocrypt_ctx_setopt_algorithm_range(mongocrypt_ctx_t *ctx, mongocrypt_bin
/// NOTE: "rangePreview" is experimental only and is not intended for public use.
/// API for "rangePreview" may be removed in a future release.
#define MONGOCRYPT_QUERY_TYPE_RANGEPREVIEW_DEPRECATED_STR "rangePreview"
/// NOTE: "range" is currently unstable API and subject to backwards breaking changes.
#define MONGOCRYPT_QUERY_TYPE_RANGE_STR "range"

#endif /* MONGOCRYPT_H */
Loading