CteRef

Struct CteRef 

Source
pub struct CteRef<'a> {
    pub name: Cow<'a, str>,
    pub columns: SmallVec<[Cow<'a, str>; 8]>,
    pub query: Cow<'a, str>,
    pub recursive: bool,
    pub materialized: Option<bool>,
}
Expand description

A zero-copy CTE definition that accepts column slices.

This is more efficient than Cte when working with static column lists.

§Example

use prax_query::zero_copy::CteRef;
use prax_query::sql::DatabaseType;

// Column names are borrowed from a static slice
let cte = CteRef::new("active_users")
    .columns(&["id", "name", "email"])
    .query("SELECT id, name, email FROM users WHERE active = true");

let sql = cte.to_sql(DatabaseType::PostgreSQL);

Fields§

§name: Cow<'a, str>

CTE name.

§columns: SmallVec<[Cow<'a, str>; 8]>

Column aliases (borrowed from slice).

§query: Cow<'a, str>

The defining query.

§recursive: bool

Whether this is recursive.

§materialized: Option<bool>

Materialization hint (PostgreSQL).

Implementations§

Source§

impl<'a> CteRef<'a>

Source

pub fn new(name: &'a str) -> Self

Create a new CTE with a borrowed name.

Source

pub fn owned(name: String) -> Self

Create a new CTE with an owned name.

Source

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

Set column aliases from a slice (zero-copy).

Source

pub fn columns_owned<I, S>(self, cols: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Set column aliases (owned).

Source

pub fn column(self, col: &'a str) -> Self

Add a single column (borrowed).

Source

pub fn query(self, q: &'a str) -> Self

Set the defining query (borrowed).

Source

pub fn query_owned(self, q: String) -> Self

Set the defining query (owned).

Source

pub fn recursive(self) -> Self

Mark as recursive CTE.

Source

pub fn materialized(self, mat: bool) -> Self

Set materialization hint (PostgreSQL).

Source

pub fn is_zero_copy(&self) -> bool

Check if this CTE uses only borrowed data.

Source

pub fn to_sql(&self, db_type: DatabaseType) -> String

Generate the CTE definition SQL.

Source

pub fn to_owned_cte(&self) -> Cte

Convert to owned Cte.

Trait Implementations§

Source§

impl<'a> Clone for CteRef<'a>

Source§

fn clone(&self) -> CteRef<'a>

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<'a> Debug for CteRef<'a>

Source§

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

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

impl<'a> Default for CteRef<'a>

Source§

fn default() -> CteRef<'a>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for CteRef<'a>

§

impl<'a> RefUnwindSafe for CteRef<'a>

§

impl<'a> Send for CteRef<'a>

§

impl<'a> Sync for CteRef<'a>

§

impl<'a> Unpin for CteRef<'a>

§

impl<'a> UnwindSafe for CteRef<'a>

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: 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> 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