Struct SelectBuilder 

pub struct SelectBuilder<T> { /* private fields */ }

Builder for SELECT queries. Implements both Filterable and Modifiable.

Implementations

impl<T> SelectBuilder<T>

pub fn schema(self, schema: &str) -> SelectBuilder<T>

Override the schema for this query.

pub fn explain(self) -> SelectBuilder<T>

Wrap the SELECT in EXPLAIN (ANALYZE, FORMAT JSON).

pub fn explain_with(self, options: ExplainOptions) -> SelectBuilder<T>

Wrap the SELECT in EXPLAIN with custom options.

pub fn head(self) -> SelectBuilder<T>

Switch to head/count-only mode.

pub fn csv(self) -> CsvSelectBuilder

Switch to CSV output mode. Returns a CsvSelectBuilder that executes the query and returns the raw CSV text.

pub fn geojson(self) -> GeoJsonSelectBuilder

Switch to GeoJSON output mode. Returns a GeoJsonSelectBuilder that executes the query and returns a serde_json::Value (GeoJSON FeatureCollection).

impl<T> SelectBuilder<T>

where T: DeserializeOwned + Send,

pub async fn execute(self) -> SupabaseResponse<T>

Execute the SELECT query and return results.

Trait Implementations

impl<T> Filterable for SelectBuilder<T>

fn filters_mut(&mut self) -> &mut Vec<FilterCondition>

Get a mutable reference to the filter list.

fn params_mut(&mut self) -> &mut ParamStore

Get a mutable reference to the parameter store.

fn eq(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column = value

fn neq(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column != value

fn gt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column > value

fn gte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column >= value

fn lt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column < value

fn lte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column <= value

fn like(self, column: &str, pattern: impl IntoSqlParam) -> Self

Filter: column LIKE pattern

fn ilike(self, column: &str, pattern: impl IntoSqlParam) -> Self

Filter: column ILIKE pattern (case-insensitive)

fn is(self, column: &str, value: IsValue) -> Self

Filter: column IS NULL / IS NOT NULL / IS TRUE / IS FALSE

fn in_<V>(self, column: &str, values: Vec<V>) -> Self

where V: IntoSqlParam,

Filter: column IN (val1, val2, …)

fn contains(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column @> value (contains)

fn contained_by(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column <@ value (contained by)

fn overlaps(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column && value (overlaps)

fn range_gt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column >> value (range strictly greater than)

fn range_gte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column &> value (range greater than or equal)

fn range_lt(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column << value (range strictly less than)

fn range_lte(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column &< value (range less than or equal)

fn range_adjacent(self, column: &str, value: impl IntoSqlParam) -> Self

Filter: column -|- value (range adjacent)

fn text_search( self, column: &str, query: impl IntoSqlParam, search_type: TextSearchType, config: Option<&str>, ) -> Self

Full-text search filter.

fn not(self, f: impl FnOnce(FilterCollector<'_>) -> FilterCollector<'_>) -> Self

Negate a filter condition using a closure.

fn or_filter( self, f: impl FnOnce(FilterCollector<'_>) -> FilterCollector<'_>, ) -> Self

OR filter: combine multiple conditions with OR.

fn match_filter(self, pairs: Vec<(&str, impl IntoSqlParam + Clone)>) -> Self

Match multiple column=value pairs (all must match).

fn filter(self, raw_sql: &str) -> Self

Raw filter escape hatch. The string should be a valid SQL boolean expression.

impl<T> Modifiable for SelectBuilder<T>

fn parts_mut(&mut self) -> &mut SqlParts

Get a mutable reference to the SQL parts.

fn order(self, column: &str, direction: OrderDirection) -> Self

Order by a column.

fn order_with_nulls( self, column: &str, direction: OrderDirection, nulls: NullsPosition, ) -> Self

Order by a column with explicit nulls positioning.

fn limit(self, count: i64) -> Self

Limit the number of rows returned.

fn range(self, from: i64, to: i64) -> Self

Set the range of rows to return (offset..offset+limit).

fn single(self) -> Self

Expect exactly one row. Returns error if 0 or >1 rows.

fn maybe_single(self) -> Self

Expect zero or one row. Returns error if >1 rows.

fn count(self) -> Self

Request an exact row count.

fn count_option(self, option: CountOption) -> Self

Request a row count with a specific counting strategy.