Configuration options for synchronous consistency in Reltio Lightspeed
Learn more about configure synchronous consistency for the Predicate API at tenant, entity type, or request levels.
Configuration options for synchronous consistency
There are three options available to you:
Option | Description | Recommended use case |
---|---|---|
1 - Tenant-level | Defines a default consistency mode strong or eventual for all entity write operations across the tenant. | Best for standardizing consistency behavior across all APIs and reducing client-side configuration complexity. |
2 - Entity type-level | Overrides tenant-level settings for a specific entity type using the indexingConfig object. | Use when only certain entity types require synchronous updates, such as profiles used in login or fraud workflows. |
3 - Request-level | Overrides any eventual settings by using the options=strongDDNConsistency query parameter. | Use for rare or dynamic cases when strong consistency is needed for individual operations. |
1 - Tenant-level configuration
Configure the Reltio Lightspeed™ Data Delivery Network (Reltio Lightspeed) to enable strong or eventual consistency using tenant- and entity-level settings. Add this to your tenant configuration to apply strong consistency to all entities by default:
"predicateAPIConfig": {
"enabled": true,
"consistency": "strong"
}
-
"enabled": true
activates the Lightspeed Predicate API capability. -
consistency
controls the default behavior:eventual
allows asynchronous indexing (default if not overridden).strong
ensures writes block until the predicate index is updated.
2 - Entity type-level configuration (L3)
Use this configuration to enable or override consistency behavior for specific entity types within a tenant.
This setting allows you to enable synchronous predicate index updates for one entity type while other types continue using the tenant-level default (eventual
) consistency.
For example, you might want to enforce read-after-write guarantees for Individual
entities involved in real-time activation flows, while allowing other entity types like Organization
or Location
to use asynchronous processing.
To override consistency at the entity type level, include the following block in your tenant configuration:
"indexingConfig": {
"predicateEnabled": true,
"consistency": "strong"
}
If this setting is omitted, the entity type inherits the value from the tenant-level predicateAPIConfig
.
The system indexes an entity synchronously only when its type is configured with "consistency": "strong"
.
3 - Request-level configuration
Use the following query parameter to override default behavior at runtime:
POST /entities?options=strongDDNConsistency
This parameter enforces strong consistency for a single API call, even if your tenant or entity type is configured for eventual consistency.
Here’s a full example of a request using this override:
POST https://<reltio>/reltio/api/<tenantID>/entities?options=strongDDNConsistency
[
{
"type": "configuration/entityTypes/Individual",
"attributes": {
"UUID": [
{ "value": "1" }
],
"Full_Name": [
{ "value": "Emma Thompson" }
],
"Phone": [
{
"value": {
"Type": [{ "value": "Working" }],
"Phone_Number": [{ "value": "(555) 123-4567" }]
}
}
]
},
"crosswalks": [
{
"type": "configuration/sources/PP",
"value": "1101"
}
]
}
]
Behavioral precedence
Scope | Configuration | Behavior |
---|---|---|
Request-level | options=strongDDNConsistency | Overrides entity and tenant settings |
Entity type | "consistency": "strong" | Overrides tenant default |
Tenant-level | predicateAPIConfig.consistency | Default unless overridden above |
For an overview of when and why to use this setting, see Understanding synchronous updates in Reltio Lightspeed.