Skip to main content

AnalyzeQueryResult

Struct AnalyzeQueryResult 

Source
pub struct AnalyzeQueryResult {
Show 15 fields pub warnings: Vec<String>, pub synced_rows: Option<RowsByQuery>, pub synced_row_count: f64, pub start: f64, pub end: f64, pub elapsed: Option<f64>, pub after_permissions: Option<String>, pub vended_row_counts: Option<RowCountsBySource>, pub vended_rows: Option<RowsBySource>, pub sqlite_plans: Option<OrderedMap<Vec<String>>>, pub read_rows: Option<RowsBySource>, pub read_row_counts_by_query: Option<RowCountsBySource>, pub read_row_count: Option<f64>, pub db_scans_by_query: Option<RowCountsBySource>, pub join_plans: Option<Vec<PlanDebugEvent>>,
}
Expand description

The server’s analysis of a query (AnalyzeQueryResult in packages/zero-protocol/src/analyze-query-result.ts).

Fields§

§warnings: Vec<String>

What the server warns about the query.

§synced_rows: Option<RowsByQuery>

The rows synced, by table, when asked for.

§synced_row_count: f64

How many rows were synced.

§start: f64

When the analysis started, in ms.

§end: f64

When it ended, in ms.

§elapsed: Option<f64>

How long it took, in ms.

§after_permissions: Option<String>

The query after the permissions applied, as ZQL.

§vended_row_counts: Option<RowCountsBySource>

The rows each source vended, counted.

§vended_rows: Option<RowsBySource>

The rows each source vended, when asked for.

§sqlite_plans: Option<OrderedMap<Vec<String>>>

SQLite’s query plans, by query.

§read_rows: Option<RowsBySource>

The rows read, by source and query.

§read_row_counts_by_query: Option<RowCountsBySource>

The rows read, counted by source and query.

§read_row_count: Option<f64>

How many rows were read.

§db_scans_by_query: Option<RowCountsBySource>

The database scans, counted by source and query.

§join_plans: Option<Vec<PlanDebugEvent>>

The planner’s debug events, when asked for.

Implementations§

Source§

impl AnalyzeQueryResult

Source

pub fn from_json(v: &Value) -> Self

The result of the JSON the server sent, already checked against analyzeQueryResultSchema.

Source

pub fn to_json(&self) -> Value

The result as JSON, as the server sent it.

Trait Implementations§

Source§

impl Clone for AnalyzeQueryResult

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 AnalyzeQueryResult

Source§

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

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

impl Default for AnalyzeQueryResult

Source§

fn default() -> Self

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

impl PartialEq for AnalyzeQueryResult

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 AnalyzeQueryResult

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

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.