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.

Basic Properties

case-sensitive-strings

SynopsisIndicates 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

SynopsisIndicates 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

SynopsisIndicates whether JSON string comparisons should ignore white space.
DescriptionWhen 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

SynopsisSpecifies which JSON fields should be compared in order to determine whether two JSON objects are equivalent.
DescriptionThis 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

matching-rule-name

SynopsisThe name of the custom JSON matching rule.
Default Value

The matching rule will not have a name.

Allowed Values

A string.

Multi-valued

No

Required

No

Admin Action Required

None

Advanced

No

Read-Only

No

matching-rule-oid

SynopsisThe numeric OID of the custom JSON matching rule.
Default Value

None

Allowed Values

The OID of the matching rule.

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

No

Read-Only

No

Advanced Properties

Use the --advanced option to access advanced properties.

java-class

SynopsisSpecifies 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:

  • org.opends.server.schema.SchemaProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

Yes

Read-Only

No

Read a different version of :