JSON Query Equality Matching Rule
The JSON Query Equality Matching Rule Provider provides the ability to configure customized JSON query equality matching rules.
The core schema provides a default 'jsonQueryMatch' equality matching rule for JSON values which match JSON strings according to the LDAP 'caseIgnoreMatch' semantics (i.e trim white space and ignore case differences), as well as the indexing of all JSON fields. This schema provider allows users to create custom JSON matching rules which may use different string matching semantics and, more importantly, may only index a restricted set of JSON fields, thereby consuming less backend resources.
Parent
The JSON Query Equality Matching Rule object inherits from Schema Provider.
JSON Query 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 |
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 |
Advanced |
No |
Read-only |
No |
indexed-field
Synopsis |
Specifies which JSON fields should be indexed. |
Description |
A field will be indexed if it matches any of the configured field patterns. |
Default value |
All JSON fields will be indexed. |
Allowed values |
A JSON pointer which may include wild-cards. A single '*' wild-card matches at most a single path element, whereas a double '**' matches zero or more path elements. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
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 Query Equality Matching Rule implementation. |
Default value |
org.opends.server.schema.JsonQueryEqualityMatchingRuleProvider |
Allowed values |
A Java class that extends or implements:
|
Multi-valued |
No |
Required |
Yes |
Admin action required |
None |
Advanced |
Yes |
Read-only |
No |