You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by db...@apache.org on 2021/08/25 20:56:41 UTC

[geode-native] branch support/1.14 updated: GEODE-9550: Native Client user guide: warn against floating point values in keys (#857)

This is an automated email from the ASF dual-hosted git repository.

dbarnes pushed a commit to branch support/1.14
in repository https://gitbox.apache.org/repos/asf/geode-native.git


The following commit(s) were added to refs/heads/support/1.14 by this push:
     new 064c43f  GEODE-9550: Native Client user guide: warn against floating point values in keys (#857)
064c43f is described below

commit 064c43f7e0b0220a11a2c6d47549db4fc01c7d95
Author: Dave Barnes <db...@apache.org>
AuthorDate: Wed Aug 25 13:56:37 2021 -0700

    GEODE-9550: Native Client user guide: warn against floating point values in keys (#857)
    
    * GEODE-9550: Native Client user guide: warn against floating point values in keys
---
 docs/geode-native-docs-cpp/continuous-queries.html.md.erb    | 3 +++
 docs/geode-native-docs-cpp/remote-queries.html.md.erb        | 3 +++
 docs/geode-native-docs-dotnet/continuous-queries.html.md.erb | 3 +++
 docs/geode-native-docs-dotnet/remote-queries.html.md.erb     | 3 +++
 4 files changed, 12 insertions(+)

diff --git a/docs/geode-native-docs-cpp/continuous-queries.html.md.erb b/docs/geode-native-docs-cpp/continuous-queries.html.md.erb
index daf2d85..5e12670 100644
--- 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
index b46f9fd..4bb9947 100644
--- 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
index 7904c26..665bbef 100644
--- 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
index 1851482..a93901f 100644
--- 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.