Struct Database

pub struct Database { /* private fields */ }

Implementations

impl Database

pub async fn select(&self, columns: Option<&str>) -> Result<JsValue, JsValue>

impl Database

pub fn select_(&self, columns: Option<&str>) -> Database

impl Database

pub async fn order( &self, column: &str, options: JsValue, ) -> Result<JsValue, JsValue>

Order the query

Order query result by column.

#[derive(Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
struct OrderOptions {
    foreign_table: String,
    nulls_first: bool,
    ascending: bool,
}
let data: JsValue = client
.get()
.from("countries")
.select_(Some("name, cities ( name )"))
.order(
   "name",
   serde_wasm_bindgen::to_value(&OrderOptions {
    foreign_table: "cities".to_string(),
    nulls_first: false,
    ascending: true,
   }).unwrap(),
)
.await.unwrap();

impl Database

pub fn order_(&self, column: &str, options: JsValue) -> Database

impl Database

pub async fn limit(&self, count: u32) -> Result<JsValue, JsValue>

Limit the query

Limit the query result by count.

impl Database

pub fn limit_(&self, count: u32) -> Database

impl Database

pub async fn range(&self, from: u32, to: u32) -> Result<JsValue, JsValue>

Limit the query to a range

Limit the query result by from and to inclusively.

impl Database

pub fn range_(&self, from: u32, to: u32) -> Database

impl Database

pub async fn single(&self) -> Result<JsValue, JsValue>

Retrieve the query as one row

Return data as a single object instead of an array of objects.

impl Database

pub async fn maybe_single(&self) -> Result<JsValue, JsValue>

Retrieve the query as 0-1 rows

Return data as a single object instead of an array of objects.

impl Database

pub async fn csv(&self) -> Result<JsValue, JsValue>

Retrieve the query as a CSV string

Return data as a string in CSV format.

let csv = client.get().from("countries").select_(Some("*")).csv().await.unwrap();

impl Database

pub async fn eq( &self, column: &str, value: &JsValue, ) -> Result<JsValue, JsValue>

Column is equal to a value

Match only rows where column is equal to value.

impl Database

pub fn eq_(&self, column: &str, value: &JsValue) -> Database

impl Database

pub async fn neq( &self, column: &str, value: &JsValue, ) -> Result<JsValue, JsValue>

Column is not equal to a value

Match only rows where column is not equal to value.

impl Database

pub fn neq_(&self, column: &str, value: &JsValue) -> Database

impl Database

pub async fn gt( &self, column: &str, value: &JsValue, ) -> Result<JsValue, JsValue>

Column is greater than a value

Match only rows where column is greater than value.

impl Database

pub fn gt_(&self, column: &str, value: &JsValue) -> Database

impl Database

pub async fn gte( &self, column: &str, value: &JsValue, ) -> Result<JsValue, JsValue>

Column is greater than or equal to a value

Match only rows where column is greater than or equal to value.

impl Database

pub fn gte_(&self, column: &str, value: &JsValue) -> Database

impl Database

pub async fn lt( &self, column: &str, value: &JsValue, ) -> Result<JsValue, JsValue>

Column is less than a value

Match only rows where column is less than value.

impl Database

pub fn lt_(&self, column: &str, value: &JsValue) -> Database

impl Database

pub async fn lte( &self, column: &str, value: &JsValue, ) -> Result<JsValue, JsValue>

Column is less than or equal to a value

Match only rows where column is less than or equal to value.

impl Database

pub fn lte_(&self, column: &str, value: &JsValue) -> Database

impl Database

pub async fn like( &self, column: &str, pattern: &str, ) -> Result<JsValue, JsValue>

Column matches a pattern

Match only rows where column matches pattern case-sensitively.

impl Database

pub fn like_(&self, column: &str, pattern: &str) -> Database

impl Database

pub async fn ilike( &self, column: &str, pattern: &str, ) -> Result<JsValue, JsValue>

Column matches a case-insensitive pattern

Match only rows where column matches pattern case-insensitively.

client.from("countries").select(None).ilike(&"name", &"%alba%").await;

impl Database

pub fn ilike_(&self, column: &str, pattern: &str) -> Database

impl Database

pub async fn is( &self, column: &str, value: &JsValue, ) -> Result<JsValue, JsValue>

Column is a value

Match only rows where column IS value.

// check for nullness
client.from("countries").select(None).is("name", JsValue::NULL);
// or check for true of false
client.from("countries").select(None).is("name", JsValue::TRUE);

impl Database

pub fn is_(&self, column: &str, value: &JsValue) -> Database

impl Database

pub async fn in( &self, column: &str, values: Vec<JsValue>, ) -> Result<JsValue, JsValue>

Column is in an array

Match only rows where column is included in the values array.

impl Database

pub fn in_(&self, column: &str, values: Vec<JsValue>) -> Database

impl Database

pub async fn contains( &self, column: &str, value: JsValue, ) -> Result<JsValue, JsValue>

Column contains every element in a value

Only relevant for jsonb, array, and range columns. Match only rows where column contains every element appearing in value.

impl Database

pub fn contains_(&self, column: &str, value: JsValue) -> Database

impl Database

pub async fn contained_by( &self, column: &str, value: JsValue, ) -> Result<JsValue, JsValue>

Contained by value

Only relevant for jsonb, array, and range columns. Match only rows where every element appearing in column is contained by value.

impl Database

pub fn contained_by_(&self, column: &str, value: JsValue) -> Database

impl Database

pub async fn range_gt( &self, column: &str, range: &str, ) -> Result<JsValue, JsValue>

Greater than a range

Only relevant for range columns. Match only rows where every element in column is greater than any element in range.

impl Database

pub fn range_gt_(&self, column: &str, range: &str) -> Database

impl Database

pub async fn range_gte( &self, column: &str, range: &str, ) -> Result<JsValue, JsValue>

Greater than or equal to a range

Only relevant for range columns. Match only rows where every element in column is either contained in range or greater than any element in range.

impl Database

pub fn range_gte_(&self, column: &str, range: &str) -> Database

impl Database

pub async fn range_lt( &self, column: &str, range: &str, ) -> Result<JsValue, JsValue>

Less than a range

Only relevant for range columns. Match only rows where every element in column is less than any element in range.

impl Database

pub fn range_lt_(&self, column: &str, range: &str) -> Database

impl Database

pub async fn range_lte( &self, column: &str, range: &str, ) -> Result<JsValue, JsValue>

Less than or equal to a range

Only relevant for range columns. Match only rows where every element in column is either contained in range or less than any element in range.

impl Database

pub fn range_lte_(&self, column: &str, range: &str) -> Database

impl Database

pub async fn range_adjacent( &self, column: &str, range: &str, ) -> Result<JsValue, JsValue>

Mutually exclusive to a range

Only relevant for range columns. Match only rows where column is mutually exclusive to range and there can be no element between the two ranges.

impl Database

pub fn range_adjacent_(&self, column: &str, range: &str) -> Database

impl Database

pub async fn overlaps( &self, column: &str, value: JsValue, ) -> Result<JsValue, JsValue>

With a common element

Only relevant for array and range columns. Match only rows where column and value have an element in common.

impl Database

pub fn overlaps_(&self, column: &str, value: JsValue) -> Database

impl Database

pub async fn text_search( &self, column: &str, query: &str, options: JsValue, ) -> Result<JsValue, JsValue>

Match a string

Only relevant for text and tsvector columns. Match only rows where column matches the query string in query.

impl Database

pub fn text_search_( &self, column: &str, query: &str, options: JsValue, ) -> Database

impl Database

pub async fn update(&self, values: &JsValue) -> Result<JsValue, JsValue>

Update data

Perform an UPDATE on the table or view.

impl Database

pub fn update_(&self, values: &JsValue) -> Database

impl Database

pub fn upsert(&self, values: JsValue) -> Database

Upsert data

Perform an UPSERT on the table or view.

impl Database

pub fn delete(&self) -> Database

Delete data

Should always be combined with filters

let client = supabase_js_rs::create_client("https://xyzcompany.supabase.co", "public-anon-key");
let res: Result<JsValue, JsValue> = client.from("countries").delete().eq("id", 1.into_js_result().unwrap()).await;

impl Database

pub async fn insert(&self, values: JsValue) -> Result<JsValue, JsValue>

Insert data

Perform an INSERT into the table or view.

impl Database

pub fn insert_(&self, values: JsValue) -> Database

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

pub fn as_string(&self) -> Option<String>

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

pub fn as_bool(&self) -> Option<bool>

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

pub fn js_in(&self, obj: &JsValue) -> bool

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

pub fn loose_eq(&self, other: &JsValue) -> bool

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

pub fn pow(&self, rhs: &JsValue) -> JsValue

Applies the binary ** JS operator on the two JsValues.

MDN documentation

pub fn lt(&self, other: &JsValue) -> bool

Applies the binary < JS operator on the two JsValues.

MDN documentation

pub fn le(&self, other: &JsValue) -> bool

Applies the binary <= JS operator on the two JsValues.

MDN documentation

pub fn ge(&self, other: &JsValue) -> bool

Applies the binary >= JS operator on the two JsValues.

MDN documentation

pub fn gt(&self, other: &JsValue) -> bool

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<Database> for Database

fn as_ref(&self) -> &Database

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<JsValue> for Database

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl Deref for Database

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<Database> for JsValue

fn from(obj: Database) -> JsValue

Converts to this type from the input type.

impl From<JsValue> for Database

fn from(obj: JsValue) -> Database

Converts to this type from the input type.

impl FromWasmAbi for Database

type Abi = <JsValue as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl<'a> IntoWasmAbi for &'a Database

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl IntoWasmAbi for Database

type Abi = <JsValue as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsCast for Database

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

fn dyn_into<T>(self) -> Result<T, Self>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T

where T: JsCast,

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Performs a zero-cost unchecked cast into a reference to the specified type.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

Test whether this JS value is an instance of the type T.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic check to see whether the JsValue provided is a value of this type.

impl LongRefFromWasmAbi for Database

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Database

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Database

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<'a> OptionIntoWasmAbi for &'a Database

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl OptionIntoWasmAbi for Database

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Database

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Database>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl WasmDescribe for Database

fn describe()