Struct GenericSQLVirtualServerModel 

pub struct GenericSQLVirtualServerModel(/* private fields */);

A stateless SQL query builder virtual server operations.

This struct generates SQL query strings without executing them, allowing the caller to execute the queries against a SQL connection.

Implementations

impl GenericSQLVirtualServerModel

pub fn new(args: GenericSQLVirtualServerModelArgs) -> Self

Creates a new GenericSQLVirtualServerModel instance.

pub fn view_expand( &self, view_id: &str, config: &ViewConfig, row_index: u32, ) -> GenericSQLResult<String>

Returns the UPDATE showing the children of the row_index-th visible row, each collapsed, whose affected-row count is the rows shown.

Returns

SQL: UPDATE {view_id} SET "__HIDDEN__" = FALSE FROM (...) AS r WHERE ...

pub fn view_collapse( &self, view_id: &str, config: &ViewConfig, row_index: u32, ) -> GenericSQLResult<String>

Returns the UPDATE hiding every descendant of the row_index-th visible row, whose affected-row count is the rows hidden.

Returns

SQL: UPDATE {view_id} SET "__HIDDEN__" = TRUE FROM (...) AS r WHERE ...

pub fn view_set_depth( &self, view_id: &str, config: &ViewConfig, depth: u32, ) -> GenericSQLResult<String>

Returns the UPDATE expanding exactly the rows whose path is no longer than depth.

Returns

SQL: UPDATE {view_id} SET "__HIDDEN__" = ({depth expr} > {depth + 1})

pub fn table_path(&self, parts: &[&str]) -> GenericSQLResult<String>

Renders a hosted table’s relation path - e.g. ["memory", "main", "trades"] - as its entity id: parts joined with ., each quoted only when it is not a bare identifier, so that SQL-safe names read as they always have (memory.trades) and every other name is still a relation reference the builder passes through verbatim.

pub fn quote_entity(&self, entity_id: &str) -> GenericSQLResult<String>

Returns the SQL relation reference for an entity id - a hosted table’s path verbatim, any other name quoted whole - for handlers that build their own queries against an entity.

pub fn get_hosted_tables(&self) -> GenericSQLResult<String>

Returns the SQL query to list all hosted tables.

Returns

SQL: SHOW ALL TABLES

pub fn table_schema(&self, table_id: &str) -> GenericSQLResult<String>

Returns the SQL query to describe a table’s schema.

Arguments

• table_id - The identifier of the table to describe.

Returns

SQL: DESCRIBE {table_id}

pub fn table_size(&self, table_id: &str) -> GenericSQLResult<String>

Returns the SQL query to get the row count of a table.

Arguments

• table_id - The identifier of the table.

Returns

SQL: SELECT COUNT(*) FROM {table_id}

pub fn view_column_size(&self, view_id: &str) -> GenericSQLResult<String>

Returns the SQL query to get the column count of a view.

Arguments

• view_id - The identifier of the view.

Returns

SQL: SELECT COUNT(*) FROM (DESCRIBE {view_id})

pub fn expressions_describe( &self, table_id: &str, config: &ViewConfig, ) -> GenericSQLResult<Option<String>>

Returns the SQL query that plans every expression of config at once against table_id.

Returns

SQL: DESCRIBE (SELECT {expr} AS "{alias}", ... FROM {table_id})

pub fn expression_describe( &self, table_id: &str, expression: &str, ) -> GenericSQLResult<String>

Returns the SQL query that plans one expression against a table.

Returns

SQL: DESCRIBE (SELECT {expression} FROM {table_id})

pub fn table_describe( &self, table_id: &str, config: &ViewConfig, schema: &IndexMap<String, ColumnType>, ) -> GenericSQLResult<Option<String>>

Returns the SQL query that plans the view config would build against table_id, without materializing it.

Returns

SQL: DESCRIBE (SELECT ... GROUP BY ...)

pub fn table_describe_unordered( &self, table_id: &str, config: &ViewConfig, schema: &IndexMap<String, ColumnType>, ) -> GenericSQLResult<Option<String>>

As Self::table_describe, for a source with no natural row order - a table made by Self::view_make_table in a dialect whose create_entity is a view, which row_id_expr cannot address.

pub fn view_delete(&self, view_id: &str) -> GenericSQLResult<String>

Returns the SQL query to delete a view.

Arguments

• view_id - The identifier of the view to delete.

Returns

SQL: DROP {drop_entity} IF EXISTS {view_id}

pub fn table_make_view( &self, table_id: &str, view_id: &str, config: &ViewConfig, schema: &IndexMap<String, ColumnType>, ) -> GenericSQLResult<String>

Returns the SQL query to create a view from a table with the given configuration.

Arguments

• table_id - The identifier of the source table.
• view_id - The identifier for the new view.
• config - The view configuration specifying columns, group_by, split_by, etc.
• schema - The schema of the source table (column names to types).

Returns

SQL: CREATE TABLE {view_id} AS (...)

pub fn table_make_view_unordered( &self, table_id: &str, view_id: &str, config: &ViewConfig, schema: &IndexMap<String, ColumnType>, ) -> GenericSQLResult<String>

As Self::table_make_view, for a source with no natural row order - a table made by Self::view_make_table in a dialect whose create_entity is a view, which row_id_expr cannot address - so an unsorted view takes the source’s own order and windows never read row_id_expr.

pub fn view_make_table( &self, view_id: &str, table_id: &str, config: &ViewConfig, view_schema: &IndexMap<String, ColumnType>, schema: Option<&IndexMap<String, ColumnType>>, ) -> GenericSQLResult<String>

Returns the SQL query to create a table from a view, with the view’s row path unrolled into key columns named after their group_by columns and aggregates of those columns qualified by their aggregate.

Arguments

• view_id - The identifier of the source view.
• table_id - The identifier for the new table.
• config - The configuration the view was created with.
• view_schema - The schema of the view’s relation.
• schema - The columns of the new table, in place of the view’s.

Returns

SQL: CREATE TABLE {table_id} AS (SELECT ... FROM {view_id})

pub fn view_get_data( &self, view_id: &str, config: &ViewConfig, viewport: &ViewPort, schema: &IndexMap<String, ColumnType>, ) -> GenericSQLResult<String>

Returns the SQL query to fetch data from a view with the given viewport.

Arguments

• view_id - The identifier of the view.
• config - The view configuration.
• viewport - The viewport specifying row/column ranges.
• schema - The schema of the view (column names to types).

Returns

SQL: SELECT ... FROM {view_id} LIMIT ... OFFSET ...

pub fn view_schema(&self, view_id: &str) -> GenericSQLResult<String>

Returns the SQL query to describe a view’s schema.

Arguments

• view_id - The identifier of the view.

Returns

SQL: DESCRIBE {view_id}

pub fn view_size(&self, view_id: &str) -> GenericSQLResult<String>

Returns the SQL query to get the (visible) row count of a view.

Arguments

• view_id - The identifier of the view.

Returns

SQL: SELECT COUNT(*) FROM {view_id}

pub fn view_get_min_max( &self, view_id: &str, column_name: &str, config: &ViewConfig, ) -> GenericSQLResult<String>

Returns the SQL query to get the min and max values of a column.

Arguments

• view_id - The identifier of the view.
• column_name - The name of the column.
• config - The view configuration.

Returns

SQL: SELECT MIN("column_name"), MAX("column_name") FROM {view_id} When the view uses ROLLUP grouping (non-flat mode with group_by), a WHERE __GROUPING_ID__ = 0 clause is added to exclude non-leaf rows.

Trait Implementations

impl Clone for GenericSQLVirtualServerModel

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenericSQLVirtualServerModel

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

Formats the value using the given formatter.

impl Default for GenericSQLVirtualServerModel

fn default() -> Self

Returns the “default value” for a type.