Struct ReplicationBind 

pub struct ReplicationBind {
    pub into: BindTarget,
    pub name: String,
    pub template: String,
    pub format: BindFormat,
    pub advance_from: Option<String>,
}

Available on crate feature source-rest only.

Declarative binding of the stored bookmark into the outgoing request — “server-side incremental push-down” (#513).

Today faucet tracks bookmarks and filters incrementally client-side (after download). A bind lets a source instead push the bookmark into the request (query param / header / body field / path) so the server returns only the new rows. The existing client-side filter_incremental stays active as a safety net for servers that don’t honour the filter exactly.

Fields

into: BindTarget

Where to place the rendered value.

name: String

The parameter / header / body-field / path-placeholder name.

template: String

Template rendered with BIND_PLACEHOLDER (${bookmark}) replaced by the formatted bookmark. Defaults to the bare ${bookmark}; set e.g. "gte|${bookmark}" (Greenhouse) or "[${bookmark} TO *]" (Lucene).

format: BindFormat

How to format the bookmark before substitution.

advance_from: Option<String>

Optional JSONPath into the response body to advance the bookmark from, instead of max(record[replication_key]).

Implementations

impl ReplicationBind

pub fn validate(&self) -> Result<(), FaucetError>

Validate the binding at config-load time.

pub fn render(&self, bookmark: &Value) -> Result<String, FaucetError>

Render the binding for a concrete bookmark: format the value, then substitute it into the template.

Trait Implementations

impl Clone for ReplicationBind

fn clone(&self) -> ReplicationBind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReplicationBind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ReplicationBind

fn deserialize<__D>( __deserializer: __D, ) -> Result<ReplicationBind, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ReplicationBind

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ReplicationBind

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ReplicationBind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReplicationBind