OptionalactiveWhether the Data Policy is active
OptionalapplyIf true, enforces policy rules during import set transformations
OptionalapplyIf true, enforces policy rules for SOAP/REST web service operations
OptionalconditionsEncoded query string defining when the policy applies
OptionaldescriptionDetailed description of the Data Policy's purpose
OptionalinheritIf true, applies this policy to all tables that extend the target table
OptionalmodelDocument ID reference for model-based policies
OptionalreverseIf true, reverses the policy rules when condition is false
OptionalrulesField-level rules (mandatory, read-only) keyed by field name. Each field can only have one rule.
Type Safety Trade-off:
Partial<Record<TableSchemaDotWalk<T>, ...>> part provides type safety and autocomplete for fields in the main table& Record<string, ...> index signature allows cross-table dot-walk notation (e.g., 'employee.department')
and rules with explicit table properties that reference fields outside the main tableThis design prioritizes flexibility for cross-table rules over strict type safety, as Data Policies commonly need to enforce rules on fields in referenced tables that cannot be statically validated.
OptionalshortA brief description of the Data Policy's purpose
The table to which the Data Policy applies (required)
OptionaluseIf true, also enforces as UI Policy on client side for immediate user feedback
Type representing the complete configuration of a Data Policy with metadata.