Skip to main content

Plan

Struct Plan 

Source
#[non_exhaustive]
pub struct Plan { pub declares: Vec<Vec<String>>, pub queries: Vec<PlanEntry>, pub notes: Vec<String>, pub dropped: Vec<(String, String)>, }
Expand description

A migration plan: what to declare, and what becomes of each query.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
assert_eq!(p.declares.len(), 1);
assert_eq!(p.queries.len(), 3);
assert_eq!(p.unserved(), 1);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§declares: Vec<Vec<String>>

TABLE.DECLARE argv per table, declaration order.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
assert_eq!(p.declares[0][..2], ["TABLE.DECLARE", "orders"]);
§queries: Vec<PlanEntry>

Every CREATE VIEW, served or not, declaration order.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
assert_eq!(p.queries.len(), 3);
§notes: Vec<String>

Honest-mapping notes, as crate::Compilation::notes.

let p = kevy_sql::plan("CREATE TABLE ev (id bigint PRIMARY KEY, at timestamp);")?;
assert!(p.notes.iter().any(|n| n.contains("ev.at: timestamp → str")));
§dropped: Vec<(String, String)>

Tables (and stray indexes) that could NOT be declared: (name, named reason). The charter’s migration bar reads “every type either moved or named” — this is the named half.

let p = kevy_sql::plan(
    "CREATE TABLE users (id bigint PRIMARY KEY, email text);
     CREATE TABLE billing (id bigint PRIMARY KEY, amount money);",
)?;
assert_eq!(p.declares.len(), 1); // users still declares
assert_eq!(p.dropped[0].0, "billing");
assert!(p.dropped[0].1.contains("money"));

Implementations§

Source§

impl Plan

Source

pub fn unserved(&self) -> usize

How many queries cannot be served as declared.

let p = kevy_sql::plan(
    "CREATE TABLE orders (id bigint PRIMARY KEY, user_id bigint, status text);
     CREATE INDEX ON orders (user_id);
     CREATE VIEW mine AS SELECT * FROM orders WHERE user_id = 7;
     CREATE VIEW by_user AS SELECT * FROM orders WHERE user_id = $1;
     CREATE VIEW paid AS SELECT * FROM orders WHERE status = 'paid';",
)?;
assert_eq!(p.unserved(), 1);

Trait Implementations§

Source§

impl Clone for Plan

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Plan

Source§

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

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

impl Eq for Plan

Source§

impl Hash for Plan

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Plan

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Plan

Auto Trait Implementations§

§

impl Freeze for Plan

§

impl RefUnwindSafe for Plan

§

impl Send for Plan

§

impl Sync for Plan

§

impl Unpin for Plan

§

impl UnsafeUnpin for Plan

§

impl UnwindSafe for Plan

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.