Struct HyperQueryBuilder

Source

pub struct HyperQueryBuilder;

Expand description

HyperDB-specific SQL dialect backend for sea-query.

Generates SQL compatible with HyperDB’s dialect, as documented at https://developer.salesforce.com/docs/data/data-cloud-query-guide/references/dc-sql-reference/select.html.

§Delegation Strategy

HyperDB’s SQL dialect is largely PostgreSQL-compatible — identifier quoting, placeholder syntax ($1, $2, ...), operator precedence, and DDL/DML syntax all match PostgreSQL. Rather than duplicating that logic, this builder delegates to PostgresQueryBuilder for all operations.

As Hyper’s dialect evolves (e.g., Hyper-specific type names, functions, or DDL extensions), individual trait methods will be overridden to emit Hyper-specific syntax while the rest continues to delegate.

Notable HyperDB SQL features:

Optional FROM clause for simple expressions
DISTINCT ON extension
Standard UNION, INTERSECT, EXCEPT operations
Zero-column result tables

§Examples

use sea_query::{Query, Expr, ExprTrait, Iden};
use sea_query_hyperdb::HyperQueryBuilder;

#[derive(Iden)]
enum Users {
    Table,
    Name,
    Age,
}

let sql = Query::select()
    .column(Users::Name)
    .from(Users::Table)
    .and_where(Expr::col(Users::Age).gt(18))
    .to_string(HyperQueryBuilder);

assert!(sql.contains(r#""users""#));

HyperQueryBuilder

Struct HyperQueryBuilder Copy item path

§Delegation Strategy

§Examples

Trait Implementations§

impl Clone for HyperQueryBuilder

fn clone(&self) -> HyperQueryBuilder

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

impl Copy for HyperQueryBuilder

impl Debug for HyperQueryBuilder

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

impl Default for HyperQueryBuilder

fn default() -> HyperQueryBuilder

impl EscapeBuilder for HyperQueryBuilder

fn needs_escape(&self, s: &str) -> bool

fn escape_string(&self, string: &str) -> String

fn write_escaped(&self, buffer: &mut impl Write, string: &str)

fn unescape_string(&self, string: &str) -> String

impl ForeignKeyBuilder for HyperQueryBuilder

fn prepare_table_ref_fk_stmt( &self, table_ref: &TableRef, sql: &mut impl SqlWriter, )

fn prepare_foreign_key_create_statement( &self, create: &ForeignKeyCreateStatement, sql: &mut impl SqlWriter, )

fn prepare_foreign_key_drop_statement( &self, drop: &ForeignKeyDropStatement, sql: &mut impl SqlWriter, )

fn prepare_foreign_key_action( &self, foreign_key_action: &ForeignKeyAction, sql: &mut impl SqlWriter, )

impl GenericBuilder for HyperQueryBuilder

impl IndexBuilder for HyperQueryBuilder

fn prepare_index_create_statement( &self, create: &IndexCreateStatement, sql: &mut impl SqlWriter, )

fn prepare_table_ref_index_stmt( &self, table_ref: &TableRef, sql: &mut impl SqlWriter, )

fn prepare_index_drop_statement( &self, drop: &IndexDropStatement, sql: &mut impl SqlWriter, )

fn prepare_table_index_expression( &self, create: &IndexCreateStatement, sql: &mut impl SqlWriter, )

impl OperLeftAssocDecider for HyperQueryBuilder

fn well_known_left_associative(&self, op: &BinOper) -> bool

impl PrecedenceDecider for HyperQueryBuilder

fn inner_expr_well_known_greater_precedence( &self, inner: &Expr, outer_oper: &Oper, ) -> bool

impl QueryBuilder for HyperQueryBuilder

fn prepare_query_statement( &self, query: &SubQueryStatement, sql: &mut impl SqlWriter, )

fn prepare_select_into(&self, into_table: &SelectInto, sql: &mut impl SqlWriter)

fn prepare_explain_statement( &self, explain: &ExplainStatement, sql: &mut impl SqlWriter, )

fn prepare_value(&self, value: Value, sql: &mut impl SqlWriter)

fn placeholder(&self) -> (&'static str, bool)

fn values_list_tuple_prefix(&self) -> &str

fn prepare_insert_statement( &self, insert: &InsertStatement, sql: &mut impl SqlWriter, )

fn prepare_insert_statement_common( &self, insert: &InsertStatement, sql: &mut impl SqlWriter, )

fn prepare_union_statement( &self, union_type: UnionType, select_statement: &SelectStatement, sql: &mut impl SqlWriter, )

fn prepare_select_statement( &self, select: &SelectStatement, sql: &mut impl SqlWriter, )

fn prepare_select_limit_offset( &self, select: &SelectStatement, sql: &mut impl SqlWriter, )

fn prepare_update_statement( &self, update: &UpdateStatement, sql: &mut impl SqlWriter, )

fn prepare_update_join( &self, _: &[TableRef], _: &ConditionHolder, _: &mut impl SqlWriter, )

fn prepare_update_from(&self, from: &[TableRef], sql: &mut impl SqlWriter)

fn prepare_update_column( &self, _: &Option<Box<TableRef>>, _: &[TableRef], column: &DynIden, sql: &mut impl SqlWriter, )

fn prepare_update_condition( &self, _: &[TableRef], condition: &ConditionHolder, sql: &mut impl SqlWriter, )

fn prepare_update_order_by( &self, update: &UpdateStatement, sql: &mut impl SqlWriter, )

fn prepare_update_limit( &self, update: &UpdateStatement, sql: &mut impl SqlWriter, )

fn prepare_delete_statement( &self, delete: &DeleteStatement, sql: &mut impl SqlWriter, )

fn prepare_delete_order_by( &self, delete: &DeleteStatement, sql: &mut impl SqlWriter, )

fn prepare_delete_limit( &self, delete: &DeleteStatement, sql: &mut impl SqlWriter, )

fn prepare_expr(&self, simple_expr: &Expr, sql: &mut impl SqlWriter)

fn prepare_expr_common(&self, simple_expr: &Expr, sql: &mut impl SqlWriter)

fn prepare_case_statement( &self, stmts: &CaseStatement, sql: &mut impl SqlWriter, )

fn prepare_select_distinct( &self, select_distinct: &SelectDistinct, sql: &mut impl SqlWriter, )

fn prepare_index_hints( &self, _table_ref: &TableRef, _select: &SelectStatement, _sql: &mut impl SqlWriter, )

fn prepare_table_sample( &self, _select: &SelectStatement, _sql: &mut impl SqlWriter, )

fn prepare_select_lock(&self, lock: &LockClause, sql: &mut impl SqlWriter)

fn prepare_select_expr( &self, select_expr: &SelectExpr, sql: &mut impl SqlWriter, )

fn prepare_join_expr(&self, join_expr: &JoinExpr, sql: &mut impl SqlWriter)

fn prepare_join_table_ref(&self, join_expr: &JoinExpr, sql: &mut impl SqlWriter)

fn prepare_table_ref(&self, table_ref: &TableRef, sql: &mut impl SqlWriter)

fn prepare_column_ref(&self, column_ref: &ColumnRef, sql: &mut impl SqlWriter)

fn prepare_un_oper(&self, un_oper: &UnOper, sql: &mut impl SqlWriter)

fn prepare_bin_oper_common(&self, bin_oper: &BinOper, sql: &mut impl SqlWriter)

fn prepare_bin_oper(&self, bin_oper: &BinOper, sql: &mut impl SqlWriter)

fn prepare_sub_query_oper(&self, oper: &SubQueryOper, sql: &mut impl SqlWriter)

fn prepare_logical_chain_oper( &self, log_chain_oper: &LogicalChainOper, i: usize, length: usize, sql: &mut impl SqlWriter, )

fn prepare_function_name_common( &self, function: &Func, sql: &mut impl SqlWriter, )

fn prepare_function_arguments( &self, func: &FunctionCall, sql: &mut impl SqlWriter, )

fn prepare_with_query(&self, query: &WithQuery, sql: &mut impl SqlWriter)

fn prepare_with_clause( &self, with_clause: &WithClause, sql: &mut impl SqlWriter, )

fn prepare_with_clause_recursive_options( &self, with_clause: &WithClause, sql: &mut impl SqlWriter, )

fn prepare_with_clause_common_tables( &self, with_clause: &WithClause, sql: &mut impl SqlWriter, )

fn prepare_with_query_clause_common_table( &self, cte: &CommonTableExpression, sql: &mut impl SqlWriter, )

fn prepare_with_query_clause_materialization( &self, cte: &CommonTableExpression, sql: &mut impl SqlWriter, )

Struct HyperQueryBuilder