Skip to main content

Cte

Struct Cte 

Source
pub struct Cte { /* private fields */ }
Expand description

A Common Table Expression (WITH clause).

Implementations§

Source§

impl Cte

Source

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

Create a new non-recursive CTE.

§Arguments
  • name - The name of the CTE (used to reference it in the main query)
§Example
let recent_orders = Cte::new("recent_orders")
    .as_select("SELECT * FROM orders WHERE created_at > NOW() - INTERVAL '7 days'");
Source

pub fn recursive(name: impl Into<String>) -> Self

Create a new recursive CTE.

Recursive CTEs require an initial (anchor) term and a recursive term joined with UNION ALL.

§Example
// Traverse an employee hierarchy
let hierarchy = Cte::recursive("org_chart")
    .columns(&["id", "name", "level"])
    .as_select("SELECT id, name, 0 FROM employees WHERE manager_id IS NULL")
    .union_all("SELECT e.id, e.name, h.level + 1 FROM employees e JOIN org_chart h ON e.manager_id = h.id");
Source

pub fn columns(self, cols: &[&str]) -> Self

Specify column aliases for the CTE.

§Example
Cte::new("totals")
    .columns(&["category", "total_amount"])
    .as_select("SELECT category, SUM(amount) FROM orders GROUP BY category");
Source

pub fn as_select(self, sql: impl Into<String>) -> Self

Set the CTE query from a raw SQL string.

§Arguments
  • sql - The SQL query for the CTE
Source

pub fn as_select_with_params( self, sql: impl Into<String>, params: Vec<Value>, ) -> Self

Set the CTE query from SQL with parameters.

§Arguments
  • sql - The SQL query for the CTE
  • params - Parameters to bind
Source

pub fn union_all(self, sql: impl Into<String>) -> Self

Add a UNION ALL clause for recursive CTEs.

§Arguments
  • sql - The recursive term SQL
Source

pub fn union_all_with_params( self, sql: impl Into<String>, params: Vec<Value>, ) -> Self

Add a UNION ALL clause with parameters.

Source

pub fn name(&self) -> &str

Get the name of this CTE.

Source

pub fn is_recursive(&self) -> bool

Check if this is a recursive CTE.

Source

pub fn as_ref(&self) -> CteRef

Create a reference to this CTE for use in queries.

§Example
let cte = Cte::new("active_users").as_select("...");
let cte_ref = cte.as_ref();

// Use in expressions
let expr = cte_ref.col("name").eq("Alice");
Source

pub fn build(&self, dialect: Dialect) -> (String, Vec<Value>)

Build the CTE definition SQL.

Returns the SQL for use in a WITH clause and the parameters.

Trait Implementations§

Source§

impl Clone for Cte

Source§

fn clone(&self) -> Cte

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 Cte

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Cte

§

impl RefUnwindSafe for Cte

§

impl Send for Cte

§

impl Sync for Cte

§

impl Unpin for Cte

§

impl UnsafeUnpin for Cte

§

impl UnwindSafe for Cte

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> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more