Struct SourceDefinition 

pub struct SourceDefinition {
    pub name: String,
    pub schedule: String,
    pub cursor: Option<String>,
    pub function: String,
    pub enabled: bool,
    pub options: Value,
    pub run_as: Option<RunAs>,
}

A scheduled ingress Source — the dual of an ObserverDefinition.

An observer is egress (“a database change → tell the world”); a source is ingress (“on a schedule → fetch the world → write the database via mutations”, resuming from a durable cursor). The function runs on the cron schedule; authoring is metadata-only — the body is a Deno function (Model B) or a built-in native PullSource (Model A).

This desugars to a cron:<schedule> scheduling of function, bound to a durable cursor named cursor_name — sugar over the existing cron trigger, not a new trigger kind.

Example

use fraiseql_core::schema::SourceDefinition;

let source = SourceDefinition::new("orders", "*/5 * * * *", "pollOrders");
assert_eq!(source.cursor_name(), "orders"); // defaults to the source name
assert!(source.enabled);

Fields

name: String

Source name (unique) — the durable-cursor row and the advisory-lease key.

schedule: String

POSIX cron expression the source polls on (e.g. "*/5 * * * *").

cursor: Option<String>

The durable cursor this source advances. Defaults to name when absent, so most sources need not set it.

function: String

The bound handler: a Deno function name (Model B) or a built-in native PullSource name (Model A).

enabled: bool

Whether the source is enabled. A disabled source is compiled but not scheduled. Defaults to true.

options: Value

Connector-specific options handed to the source, opaque to the framework.

run_as: Option<RunAs>

The authority this source’s background mutations run under (#573) — its run_as ceiling. Absent ⇒ fail-closed: the source runs with no roles/scopes/tenant and can write nothing. See identity.

Implementations

impl SourceDefinition

pub fn new( name: impl Into<String>, schedule: impl Into<String>, function: impl Into<String>, ) -> Self

Create a source with the required fields; cursor defaults to the name, enabled to true, and options to null.

pub fn cursor_name(&self) -> &str

The durable cursor this source advances — its explicit cursor, or its name when unset.

pub fn with_cursor(self, cursor: impl Into<String>) -> Self

Set an explicit cursor name (distinct from the source name).

pub fn with_options(self, options: Value) -> Self

Set connector options.

pub fn with_run_as(self, run_as: RunAs) -> Self

Set the run_as authority ceiling (#573).

pub fn identity(&self, request_id: impl Into<String>) -> SecurityContext

The background SecurityContext this source’s mutations run under (#573).

Built from run_as via SecurityContext::system_job; absent run_as yields a fail-closed identity (no roles, no scopes, no tenant → every authz/RLS decision denies). request_id correlates one firing of the source (typically its per-fire idempotency token).

pub const fn disabled(self) -> Self

Mark the source disabled (compiled, but not scheduled).

pub fn cron_trigger(&self) -> String

The cron:<schedule> trigger type this source desugars to — the sugar-over- cron binding. The runtime schedules function on it.

Trait Implementations

impl Clone for SourceDefinition

fn clone(&self) -> SourceDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceDefinition

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SourceDefinition

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SourceDefinition

impl PartialEq for SourceDefinition

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SourceDefinition

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 SourceDefinition