Struct DeleteParams 

pub struct DeleteParams {
    pub filters: Vec<LogicCondition>,
    pub order: Vec<OrderTerm>,
    pub limit: Option<u64>,
    pub returning: Option<Vec<SelectItem>>,
}

Parameters for a DELETE operation.

Safety

Deletes without filters are rejected to prevent accidental mass deletions. Use LIMIT with ORDER BY for predictable results.

Examples

use postgrest_parser::{DeleteParams, parse_filter, LogicCondition};

// Delete with filter
let filter = parse_filter("status", "eq.inactive").unwrap();
let params = DeleteParams::new()
    .with_filters(vec![LogicCondition::Filter(filter)]);

assert!(params.has_filters());

// Delete with LIMIT and ORDER BY
use postgrest_parser::parse_order;
let filter = parse_filter("created_at", "lt.2020-01-01").unwrap();
let order = parse_order("created_at.asc").unwrap();
let params = DeleteParams::new()
    .with_filters(vec![LogicCondition::Filter(filter)])
    .with_order(order)
    .with_limit(100);

assert_eq!(params.limit, Some(100));

Fields

filters: Vec<LogicCondition>

WHERE clause filters (required for safety)

order: Vec<OrderTerm>

Optional ORDER BY clause (required if using LIMIT)

limit: Option<u64>

Optional LIMIT clause

returning: Option<Vec<SelectItem>>

Optional RETURNING clause columns (returns deleted rows)

Implementations

impl DeleteParams

pub fn new() -> Self

Creates new delete parameters with no filters.

pub fn with_filters(self, filters: Vec<LogicCondition>) -> Self

Adds WHERE clause filters.

pub fn with_order(self, order: Vec<OrderTerm>) -> Self

Adds ORDER BY clause.

pub fn with_limit(self, limit: u64) -> Self

Adds LIMIT clause (requires ORDER BY for safety).

pub fn with_returning(self, returning: Vec<SelectItem>) -> Self

Specifies columns to return from deleted rows (RETURNING clause).

pub fn has_filters(&self) -> bool

Returns true if filters are present.

Trait Implementations

impl Clone for DeleteParams

fn clone(&self) -> DeleteParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteParams

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

Formats the value using the given formatter.

impl Default for DeleteParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DeleteParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeleteParams

fn eq(&self, other: &DeleteParams) -> 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 DeleteParams

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 DeleteParams