Skip to content

Commit

Permalink
GEODE-2282: Provide ability to sort field while creating pdxType for …
Browse files Browse the repository at this point in the history
…jSON document (Need to document system property)

This closes apache#366
  • Loading branch information
davebarnes97 committed Jan 26, 2017
1 parent ca9cfd4 commit 0a1f762
Showing 1 changed file with 12 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ limitations under the License.

The `JSONFormatter` API allows you to put JSON formatted documents into regions and retrieve them later by storing the documents internally as PdxInstances.

Geode now supports the use of JSON formatted documents natively. When you add a JSON document to a Geode cache, you call the JSONFormatter APIs to transform them into the PDX format (as a `PdxInstance`), which enables Geode to understand the JSON document at a field level.
Geode supports the use of JSON formatted documents natively. When you add a JSON document to a Geode cache, you call the JSONFormatter APIs to transform them into the PDX format (as a `PdxInstance`), which enables Geode to understand the JSON document at a field level.

In terms of querying and indexing, because the documents are stored internally as PDX, applications can index on any field contained inside the JSON document including any nested field (within JSON objects or JSON arrays.) Any queries run on these stored documents will return PdxInstances as results. To update a JSON document stored in Geode , you can execute a function on the PdxInstance.

Expand All @@ -44,3 +44,14 @@ After executing a Geode query or calling `region.get`, you can use the following
- `toJSONByteArray`. Reads a PdxInstance and returns a JSON byte array.

For more information on using the JSONFormatter, see the Java API documentation for `org.apache.geode.pdx.JSONFormatter`.

# Sorting Behavior of Serialized JSON Fields

By default, Geode serialization creates a unique pdx typeID for each unique JSON document, even if the
only difference between the JSON documents is the order in which their fields are specified.

If you prefer that JSON documents which differ only in the order in which their fields are specified
map to the same typeID, set the property `gemfire.pdx.mapper.sort-json-field-names` to `true`. This
tells the system to sort the JSON fields prior to serialization, allowing the system to identify
matching entries, and helps reduce the number of pdx typeIDs that are generated by the serialization
mechanism.

0 comments on commit 0a1f762

Please sign in to comment.