1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
//! # postgrest-rs
//!
//! [PostgREST][postgrest] client-side library.
//!
//! This library is a thin wrapper that brings an ORM-like interface to
//! PostgREST.
//!
//! ## Usage
//!
//! Simple example:
//! ```
//! use postgrest::Postgrest;
//!
//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
//! let client = Postgrest::new("https://your.postgrest.endpoint");
//! let resp = client
//! .from("your_table")
//! .select("*")
//! .execute()
//! .await?;
//! let body = resp
//! .text()
//! .await?;
//! # Ok(())
//! # }
//! ```
//!
//! Using filters:
//! ```
//! # use postgrest::Postgrest;
//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
//! # let client = Postgrest::new("https://your.postgrest.endpoint");
//! let resp = client
//! .from("countries")
//! .eq("name", "Germany")
//! .gte("id", "20")
//! .select("*")
//! .execute()
//! .await?;
//! # Ok(())
//! # }
//! ```
//!
//! Updating a table:
//! ```
//! # use postgrest::Postgrest;
//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
//! # let client = Postgrest::new("https://your.postgrest.endpoint");
//! let resp = client
//! .from("users")
//! .eq("username", "soedirgo")
//! .update("{\"organization\": \"supabase\"}")
//! .execute()
//! .await?;
//! # Ok(())
//! # }
//! ```
//!
//! Executing stored procedures:
//! ```
//! # use postgrest::Postgrest;
//! # async fn run() -> Result<(), Box<dyn std::error::Error>> {
//! # let client = Postgrest::new("https://your.postgrest.endpoint");
//! let resp = client
//! .rpc("add", r#"{"a": 1, "b": 2}"#)
//! .execute()
//! .await?;
//! # Ok(())
//! # }
//! ```
//!
//! Check out the [README][readme] for more info.
//!
//! [postgrest]: https://postgrest.org
//! [readme]: https://github.com/supabase/postgrest-rs
mod builder;
mod filter;
pub use builder::Builder;
use reqwest::header::{HeaderMap, HeaderValue, IntoHeaderName};
use reqwest::Client;
pub struct Postgrest {
url: String,
schema: Option<String>,
headers: HeaderMap,
client: Client,
}
impl Postgrest {
/// Creates a Postgrest client.
///
/// # Example
///
/// ```
/// use postgrest::Postgrest;
///
/// let client = Postgrest::new("http://your.postgrest.endpoint");
/// ```
pub fn new<T>(url: T) -> Self
where
T: Into<String>,
{
Postgrest {
url: url.into(),
schema: None,
headers: HeaderMap::new(),
client: Client::new(),
}
}
/// Switches the schema.
///
/// # Note
///
/// You can only switch schemas before you call `from` or `rpc`.
///
/// # Example
///
/// ```
/// use postgrest::Postgrest;
///
/// let client = Postgrest::new("http://your.postgrest.endpoint");
/// client.schema("private");
/// ```
pub fn schema<T>(mut self, schema: T) -> Self
where
T: Into<String>,
{
self.schema = Some(schema.into());
self
}
/// Add arbitrary headers to the request. For instance when you may want to connect
/// through an API gateway that needs an API key header.
///
/// # Example
///
/// ```
/// use postgrest::Postgrest;
///
/// let client = Postgrest::new("https://your.postgrest.endpoint")
/// .insert_header("apikey", "super.secret.key")
/// .from("table");
/// ```
pub fn insert_header(
mut self,
header_name: impl IntoHeaderName,
header_value: impl AsRef<str>,
) -> Self {
self.headers.insert(
header_name,
HeaderValue::from_str(header_value.as_ref()).expect("Invalid header value."),
);
self
}
/// Perform a table operation.
///
/// # Example
///
/// ```
/// use postgrest::Postgrest;
///
/// let client = Postgrest::new("http://your.postgrest.endpoint");
/// client.from("table");
/// ```
pub fn from<T>(&self, table: T) -> Builder
where
T: AsRef<str>,
{
let url = format!("{}/{}", self.url, table.as_ref());
Builder::new(url, self.schema.clone(), self.headers.clone(), &self.client)
}
/// Perform a stored procedure call.
///
/// # Example
///
/// ```
/// use postgrest::Postgrest;
///
/// let client = Postgrest::new("http://your.postgrest.endpoint");
/// client.rpc("multiply", r#"{"a": 1, "b": 2}"#);
/// ```
pub fn rpc<T, U>(&self, function: T, params: U) -> Builder
where
T: AsRef<str>,
U: Into<String>,
{
let url = format!("{}/rpc/{}", self.url, function.as_ref());
Builder::new(url, self.schema.clone(), self.headers.clone(), &self.client).rpc(params)
}
}
#[cfg(test)]
mod tests {
use super::*;
const REST_URL: &str = "http://localhost:3000";
#[test]
fn initialize() {
assert_eq!(Postgrest::new(REST_URL).url, REST_URL);
}
#[test]
fn switch_schema() {
assert_eq!(
Postgrest::new(REST_URL).schema("private").schema,
Some("private".to_string())
);
}
#[test]
fn with_insert_header() {
assert_eq!(
Postgrest::new(REST_URL)
.insert_header("apikey", "super.secret.key")
.headers
.get("apikey")
.unwrap(),
"super.secret.key"
);
}
}