JSON Equality Matching Rule
JSON Equality Matching Rules determine whether two JSON values are equivalent using a custom set of rules.
It is possible to select which JSON fields should be used for matching as well as whether those fields, if they are strings, should be normalized first by trimming white space and/or ignoring case differences.
Parent
The JSON Equality Matching Rule object inherits from Schema Provider.
JSON Equality Matching Rule Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
| Basic Properties | Advanced Properties |
|---|---|
case-sensitive-strings |
case-sensitive-strings
Synopsis |
Indicates whether JSON string comparisons should be case-sensitive. |
Default Value |
false |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None When this property is changed, indexes using this matching rule must be rebuilt. |
Advanced |
No |
Read-Only |
No |
enabled
Synopsis |
Indicates whether the Schema Provider is enabled for use. |
Default Value |
None |
Allowed Values |
true false |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
No |
Read-Only |
No |
ignore-white-space
Synopsis |
Indicates whether JSON string comparisons should ignore white space. |
Description |
When enabled, all leading and trailing white space will be removed and intermediate white space will be reduced to a single character. |
Default Value |
true |
Allowed Values |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None When this property is changed, indexes using this matching rule must be rebuilt. |
Advanced |
No |
Read-Only |
No |
json-keys
Synopsis |
Specifies which JSON fields should be compared in order to determine whether two JSON objects are equivalent. |
Description |
This parameter is a list of space-delimited JSON pointers. |
Default Value |
None |
Allowed Values |
A non-empty list of space-delimited JSON pointers. |
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None When this property is changed, indexes using this matching rule must be rebuilt. |
Advanced |
No |
Read-Only |
No |
Advanced Properties
Use the --advanced
option to access advanced properties.
java-class
Synopsis |
Specifies the fully-qualified name of the Java class that provides the JSON Equality Matching Rule implementation. |
Default Value |
org.opends.server.schema.JsonEqualityMatchingRuleProvider |
Allowed Values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin Action Required |
None |
Advanced |
Yes |
Read-Only |
No |