API Models Enums Consistency - evansims/openfga-php GitHub Wiki
Consistency levels for OpenFGA authorization queries. This enum defines the available consistency levels that control the trade-off between data consistency and query performance in OpenFGA operations. Different consistency levels affect how fresh the data needs to be when processing authorization checks.
Table of Contents
OpenFGA\Models\Enums
UnitEnumBackedEnum
| Name | Value | Description |
|---|---|---|
HIGHER_CONSISTENCY |
HIGHER_CONSISTENCY |
Prioritize data consistency over query performance. This option ensures that authorization checks are performed against the most up-to-date data, potentially at the cost of increased latency. Use when accuracy is more important than speed. |
MINIMIZE_LATENCY |
MINIMIZE_LATENCY |
Prioritize query performance over data consistency. This option allows for faster authorization checks by potentially using slightly stale data. Use when speed is more important than having the absolute latest data. |
UNSPECIFIED |
UNSPECIFIED |
Use the default consistency level determined by the OpenFGA server. This option delegates the consistency decision to the server's configuration, which may change based on deployment settings. |
| Name | Value | Description |
|---|---|---|
HIGHER_CONSISTENCY |
HIGHER_CONSISTENCY |
Prioritize data consistency over query performance. This option ensures that authorization checks are performed against the most up-to-date data, potentially at the cost of increased latency. Use when accuracy is more important than speed. |
MINIMIZE_LATENCY |
MINIMIZE_LATENCY |
Prioritize query performance over data consistency. This option allows for faster authorization checks by potentially using slightly stale data. Use when speed is more important than having the absolute latest data. |
UNSPECIFIED |
UNSPECIFIED |
Use the default consistency level determined by the OpenFGA server. This option delegates the consistency decision to the server's configuration, which may change based on deployment settings. |
public function getDescription(): stringGet a user-friendly description of this consistency level. Provides a descriptive explanation of what this consistency level means for query behavior and performance characteristics.
string — A descriptive explanation of the consistency level
public function prioritizesConsistency(): boolCheck if this consistency level prioritizes data freshness. Useful for determining if a query will potentially have higher latency in exchange for more up-to-date data.
bool — True if consistency is prioritized over performance, false otherwise
public function prioritizesPerformance(): boolCheck if this consistency level prioritizes query performance. Useful for determining if a query will potentially use stale data in exchange for better performance.
bool — True if performance is prioritized over consistency, false otherwise