Skip to main content

UpdateParams

Struct UpdateParams 

Source
pub struct UpdateParams {
    pub set_values: HashMap<String, Value>,
    pub filters: Vec<LogicCondition>,
    pub order: Vec<OrderTerm>,
    pub limit: Option<u64>,
    pub returning: Option<Vec<SelectItem>>,
}
Expand description

Parameters for an UPDATE operation.

§Safety

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

§Examples

use postgrest_parser::{UpdateParams, parse_filter, LogicCondition};
use std::collections::HashMap;
use serde_json::json;

// Update with filter
let mut set_values = HashMap::new();
set_values.insert("status".to_string(), json!("active"));

let filter = parse_filter("id", "eq.123").unwrap();
let params = UpdateParams::new(set_values)
    .with_filters(vec![LogicCondition::Filter(filter)]);

assert!(params.has_filters());
assert_eq!(params.set_values.len(), 1);

Fields§

§set_values: HashMap<String, Value>

Column-value pairs for the SET clause

§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

Implementations§

Source§

impl UpdateParams

Source

pub fn new(set_values: HashMap<String, Value>) -> Self

Creates new update parameters with the given SET values.

Source

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

Adds WHERE clause filters.

Source

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

Adds ORDER BY clause.

Source

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

Adds LIMIT clause (requires ORDER BY for safety).

Source

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

Specifies columns to return after update (RETURNING clause).

Source

pub fn has_filters(&self) -> bool

Returns true if filters are present.

Source

pub fn is_set_empty(&self) -> bool

Returns true if no columns are being updated.

Trait Implementations§

Source§

impl Clone for UpdateParams

Source§

fn clone(&self) -> UpdateParams

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UpdateParams

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for UpdateParams

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for UpdateParams

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for UpdateParams

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for UpdateParams

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,