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
enabled
ignore-white-space
indexed-field
matching-rule-name
matching-rule-oid

java-class

Basic Properties

Use the --advanced option to access advanced properties.

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

matching-rule-name

Synopsis

The 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

Synopsis

The 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

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:

  • org.opends.server.schema.SchemaProvider

Multi-valued

No

Required

Yes

Admin Action Required

None

Advanced

Yes

Read-Only

No