baserow_rs/api/table_operations.rs
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 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
use crate::{
api::{client::BaserowClient, table::RowRequestBuilder},
BaserowTable,
};
use async_trait::async_trait;
use reqwest::{header::AUTHORIZATION, StatusCode};
use serde_json::Value;
use std::{collections::HashMap, error::Error};
/// Trait defining the public operations available on a Baserow table
///
/// This trait provides the core CRUD operations for working with Baserow tables.
/// All operations are async and return Results to handle potential errors.
///
/// # Example
/// ```no_run
/// use baserow_rs::{ConfigBuilder, Baserow, BaserowTableOperations, api::client::BaserowClient};
/// use std::collections::HashMap;
/// use serde_json::Value;
///
/// #[tokio::main]
/// async fn main() {
/// let config = ConfigBuilder::new()
/// .base_url("https://api.baserow.io")
/// .api_key("your-api-key")
/// .build();
///
/// let baserow = Baserow::with_configuration(config);
/// let table = baserow.table_by_id(1234);
///
/// // Create a new record
/// let mut data = HashMap::new();
/// data.insert("Name".to_string(), Value::String("Test".to_string()));
/// let result = table.create_one(data).await.unwrap();
/// }
/// ```
#[async_trait]
pub trait BaserowTableOperations {
/// Automatically maps the table fields to their corresponding types
///
/// This method fetches the table schema and sets up field mappings for type conversion.
/// Call this before performing operations if you need type-safe field access.
async fn auto_map(self) -> Result<BaserowTable, Box<dyn Error>>;
/// Returns a builder for constructing complex table queries
///
/// The builder allows you to add filters, sorting, and pagination to your queries.
/// Use this when you need more control over how you fetch rows from the table.
///
/// # Example
/// ```no_run
/// use baserow_rs::{ConfigBuilder, Baserow, BaserowTableOperations, OrderDirection, api::client::BaserowClient};
///
/// #[tokio::main]
/// async fn main() {
/// let config = ConfigBuilder::new()
/// .base_url("https://api.baserow.io")
/// .api_key("your-api-key")
/// .build();
///
/// let baserow = Baserow::with_configuration(config);
/// let table = baserow.table_by_id(1234);
///
/// let results = table.rows()
/// .order_by("Created", OrderDirection::Desc)
/// .get()
/// .await
/// .unwrap();
/// }
/// ```
fn rows(self) -> RowRequestBuilder;
/// Creates a single record in the table
///
/// # Arguments
/// * `data` - A map of field names to values representing the record to create
///
/// # Returns
/// The created record including any auto-generated fields (like ID)
async fn create_one(
self,
data: HashMap<String, Value>,
) -> Result<HashMap<String, Value>, Box<dyn Error>>;
/// Retrieves a single record from the table by ID
///
/// # Arguments
/// * `id` - The unique identifier of the record to retrieve
///
/// # Returns
/// The requested record if found
async fn get_one(self, id: u64) -> Result<HashMap<String, Value>, Box<dyn Error>>;
/// Updates a single record in the table
///
/// # Arguments
/// * `id` - The unique identifier of the record to update
/// * `data` - A map of field names to new values
///
/// # Returns
/// The updated record
async fn update(
self,
id: u64,
data: HashMap<String, Value>,
) -> Result<HashMap<String, Value>, Box<dyn Error>>;
/// Deletes a single record from the table
///
/// # Arguments
/// * `id` - The unique identifier of the record to delete
async fn delete(self, id: u64) -> Result<(), Box<dyn Error>>;
}
#[async_trait]
impl BaserowTableOperations for BaserowTable {
async fn auto_map(mut self) -> Result<BaserowTable, Box<dyn Error>> {
let id = self.id.ok_or("Table ID is missing")?;
let baserow = self.baserow.clone().ok_or("Baserow instance is missing")?;
let fields = baserow.table_fields(id).await?;
let mut mapper = crate::mapper::TableMapper::new();
mapper.map_fields(fields.clone());
self.mapper = Some(mapper);
Ok(self)
}
fn rows(self) -> RowRequestBuilder {
RowRequestBuilder::new()
.with_baserow(self.baserow.clone().unwrap())
.with_table(self.clone())
}
async fn create_one(
self,
data: HashMap<String, Value>,
) -> Result<HashMap<String, Value>, Box<dyn Error>> {
let baserow = self.baserow.expect("Baserow instance is missing");
let url = format!(
"{}/api/database/rows/table/{}/",
&baserow.configuration.base_url,
self.id.unwrap()
);
let mut req = baserow.client.post(url);
if baserow.configuration.jwt.is_some() {
req = req.header(
AUTHORIZATION,
format!("JWT {}", &baserow.configuration.jwt.unwrap()),
);
} else if baserow.configuration.database_token.is_some() {
req = req.header(
AUTHORIZATION,
format!("Token {}", &baserow.configuration.database_token.unwrap()),
);
}
let resp = req.json(&data).send().await?;
match resp.status() {
StatusCode::OK => Ok(resp.json::<HashMap<String, Value>>().await?),
_ => Err(Box::new(resp.error_for_status().unwrap_err())),
}
}
async fn get_one(self, id: u64) -> Result<HashMap<String, Value>, Box<dyn Error>> {
let baserow = self.baserow.expect("Baserow instance is missing");
let url = format!(
"{}/api/database/rows/table/{}/{}/",
&baserow.configuration.base_url,
self.id.unwrap(),
id
);
let mut req = baserow.client.get(url);
if baserow.configuration.jwt.is_some() {
req = req.header(
AUTHORIZATION,
format!("JWT {}", &baserow.configuration.jwt.unwrap()),
);
} else if baserow.configuration.database_token.is_some() {
req = req.header(
AUTHORIZATION,
format!("Token {}", &baserow.configuration.database_token.unwrap()),
);
}
let resp = req.send().await?;
match resp.status() {
StatusCode::OK => Ok(resp.json::<HashMap<String, Value>>().await?),
_ => Err(Box::new(resp.error_for_status().unwrap_err())),
}
}
async fn update(
self,
id: u64,
data: HashMap<String, Value>,
) -> Result<HashMap<String, Value>, Box<dyn Error>> {
let baserow = self.baserow.expect("Baserow instance is missing");
let url = format!(
"{}/api/database/rows/table/{}/{}/",
&baserow.configuration.base_url,
self.id.unwrap(),
id
);
let mut req = baserow.client.patch(url);
if baserow.configuration.jwt.is_some() {
req = req.header(
AUTHORIZATION,
format!("JWT {}", &baserow.configuration.jwt.unwrap()),
);
} else if baserow.configuration.database_token.is_some() {
req = req.header(
AUTHORIZATION,
format!("Token {}", &baserow.configuration.database_token.unwrap()),
);
}
let resp = req.json(&data).send().await?;
match resp.status() {
StatusCode::OK => Ok(resp.json::<HashMap<String, Value>>().await?),
_ => Err(Box::new(resp.error_for_status().unwrap_err())),
}
}
async fn delete(self, id: u64) -> Result<(), Box<dyn Error>> {
let baserow = self.baserow.expect("Baserow instance is missing");
let url = format!(
"{}/api/database/rows/table/{}/{}/",
&baserow.configuration.base_url,
self.id.unwrap(),
id
);
let mut req = baserow.client.delete(url);
if baserow.configuration.jwt.is_some() {
req = req.header(
AUTHORIZATION,
format!("JWT {}", &baserow.configuration.jwt.unwrap()),
);
} else if baserow.configuration.database_token.is_some() {
req = req.header(
AUTHORIZATION,
format!("Token {}", &baserow.configuration.database_token.unwrap()),
);
}
let resp = req.send().await?;
match resp.status() {
StatusCode::OK => Ok(()),
_ => Err(Box::new(resp.error_for_status().unwrap_err())),
}
}
}