Struct ChangelogConfig 

pub struct ChangelogConfig {
    pub expose: bool,
    pub schema: String,
    pub read_role: Option<String>,
    pub write_role: Option<String>,
    pub max_limit: u32,
    pub write_enabled: bool,
}

Configuration for exposing the observer entity-change log as queryable GraphQL types.

When expose = true, the compiler injects two read-only object types (EntityChangeLog, TransportCheckpoint), a cursor-paginated list query, a point-lookup query, and a checkpoint upsert mutation, all backed by the views the changelog migration installs. Sidecar consumers can then poll the changelog over the same GraphQL endpoint they use for everything else — same auth, audit, rate limiting.

The generated operations are gated by read_role / write_role (RBAC). The views read from tb_entity_change_log / tb_transport_checkpoint, which the observer system installs (or which the operator supplies as a documented prerequisite).

Fields

expose: bool

Master switch. When false, no changelog types are registered (default).

schema: String

PostgreSQL schema holding tb_entity_change_log and tb_transport_checkpoint. Default "core" (the observer install convention).

read_role: Option<String>

Role required to query the changelog (entity_change_logs, transport_checkpoint).

Matched against SecurityContext.roles. None disables the read gate (not recommended for production). Default Some("changelog_reader").

write_role: Option<String>

Role required to upsert checkpoints (upsert_transport_checkpoint).

Matched against SecurityContext.roles. None disables the write gate. Default Some("changelog_writer").

max_limit: u32

Maximum rows a single entity_change_logs page should return.

Enforced as a documented/runtime clamp rather than a GraphQL argument constraint (the argument system has no max). Default 1000.

write_enabled: bool

Whether the mutation executor writes the tb_entity_change_log outbox row in-transaction (the Change-Spine transactional outbox). Default true.

Distinct from expose, which gates the read path (the #149 GraphQL changelog types): write_enabled gates the write path. Set false to disable the outbox write globally — e.g. for an application that does not consume the Change Spine — so no mutation pays the write. Overridable at runtime by FRAISEQL_CHANGELOG_ENABLED; composes (AND) with the per-mutation MutationDefinition.changelog flag.

Trait Implementations

impl Clone for ChangelogConfig

fn clone(&self) -> ChangelogConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChangelogConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ChangelogConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ChangelogConfig

where ChangelogConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ChangelogConfig

impl PartialEq for ChangelogConfig

fn eq(&self, other: &ChangelogConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChangelogConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ChangelogConfig