GEODE-9550: Native Client user guide: warn against floating point val…

…ues in keys (apache#857) * GEODE-9550: Native Client user guide: warn against floating point values in keys
davebarnes97 · Aug 25, 2021 · ed75ba5 · ed75ba5
1 parent f45f16b
commit ed75ba5
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/docs/geode-native-docs-cpp/continuous-queries.html.md.erb b/docs/geode-native-docs-cpp/continuous-queries.html.md.erb
@@ -45,6 +45,9 @@ Compare this to register interest by reviewing [Registering Interest for Entries
 
 - **Active query execution**. Once initialized, the queries operate on new events. Events that change the query result are sent to the client immediately.
 
+**Note:** Because floating point numbers can not reliably be compared for equality, do not use
+floating point values as keys or key components when constructing a query.
+
 ## <a id="cq_api"></a>Typical Continuous Query Lifecycle
 
 1.  The client creates the CQ. This sets up everything for running the query and provides the client with a `CqQuery` object, but does not execute the CQ. At this point, the query is in a `STOPPED `state, ready to be closed or run.

diff --git a/docs/geode-native-docs-cpp/remote-queries.html.md.erb b/docs/geode-native-docs-cpp/remote-queries.html.md.erb
@@ -28,6 +28,9 @@ You can optimize your queries by defining indexes on the cache server.
 
 Querying and indexing operate only on remote cache server contents.
 
+**Note:** Because floating point numbers can not reliably be compared for equality, do not use
+floating point values as keys or key components when constructing a query.
+
 ### <a id="QueryLanguage"></a>Query language: OQL
 <%=vars.product_name%> provides a SQL-like querying language called OQL that allows you to access data stored in <%=vars.product_name%> regions.
 OQL is very similar to SQL, but OQL allows you to query complex objects, object attributes, and methods.

diff --git a/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb b/docs/geode-native-docs-dotnet/continuous-queries.html.md.erb
@@ -45,6 +45,9 @@ Compare this to register interest by reviewing [Registering Interest for Entries
 
 - **Active query execution**. Once initialized, the queries operate on new events. Events that change the query result are sent to the client immediately.
 
+**Note:** Because floating point numbers can not reliably be compared for equality, do not use
+floating point values as keys or key components when constructing a query.
+
 ## <a id="cq_api"></a>Typical Continuous Query Lifecycle
 
 1.  The client creates the CQ. This sets up everything for running the query and provides the client with a `CqQuery` object, but does not execute the CQ. At this point, the query is in a `STOPPED `state, ready to be closed or run.

diff --git a/docs/geode-native-docs-dotnet/remote-queries.html.md.erb b/docs/geode-native-docs-dotnet/remote-queries.html.md.erb
@@ -28,6 +28,9 @@ You can optimize your queries by defining indexes on the cache server.
 
 Querying and indexing operate only on remote cache server contents.
 
+**Note:** Because floating point numbers can not reliably be compared for equality, do not use
+floating point values as keys or key components when constructing a query.
+
 ### <a id="QueryLanguage"></a>Query language: OQL
 <%=vars.product_name%> provides a SQL-like querying language called OQL that allows you to access data stored in <%=vars.product_name%> regions.
 OQL is very similar to SQL, but OQL allows you to query complex objects, object attributes, and methods.