Struct ReplicationQueryBuilder 

pub struct ReplicationQueryBuilder { /* private fields */ }

Fluent replication query builder

Builds queries for the replication endpoint which is designed for bulk data transfer and full dataset synchronization.

Constraints

• Maximum $top: 2000 (vs 200 for standard queries)
• No $skip: Use next links from response headers instead
• No $orderby: Results ordered oldest to newest by default
• No $apply: Aggregations not supported

Examples

// Basic replication query
let query = ReplicationQueryBuilder::new("Property")
    .top(2000)
    .build()?;

// With filter and select
let query = ReplicationQueryBuilder::new("Property")
    .filter("StandardStatus eq 'Active'")
    .select(&["ListingKey", "City", "ListPrice"])
    .top(1000)
    .build()?;

Implementations

impl ReplicationQueryBuilder

pub fn new(resource: impl Into<String>) -> Self

Create a new replication query builder for a resource

Examples

let query = ReplicationQueryBuilder::new("Property")
    .top(2000)
    .build()?;

pub fn filter(self, expression: impl Into<String>) -> Self

Add an OData filter expression

Pass a complete OData filter string. The library does not parse or validate the filter - it simply URL-encodes it and adds it to the query.

Examples

let query = ReplicationQueryBuilder::new("Property")
    .filter("StandardStatus eq 'Active'")
    .build()?;

pub fn select(self, fields: &[&str]) -> Self

Select specific fields

Using $select is highly recommended for replication queries to reduce payload size and improve performance.

Examples

let query = ReplicationQueryBuilder::new("Property")
    .select(&["ListingKey", "City", "ListPrice"])
    .build()?;

pub fn top(self, n: u32) -> Self

Limit number of results (maximum: 2000)

The replication endpoint allows up to 2000 records per request, compared to 200 for standard queries.

Errors

Returns an error if n exceeds 2000.

Examples

let query = ReplicationQueryBuilder::new("Property")
    .top(2000)
    .build()?;

pub fn build(self) -> Result<ReplicationQuery>

Build the replication query

Errors

Returns an error if validation fails (e.g., top > 2000).