Struct MetabaseClient

pub struct MetabaseClient { /* private fields */ }

The main client for interacting with Metabase API

Implementations

impl MetabaseClient

pub fn new(base_url: impl Into<String>) -> Result<Self>

Creates a new MetabaseClient instance

pub fn base_url(&self) -> &str

Gets the base URL of the client

pub fn is_authenticated(&self) -> bool

Checks if the client is authenticated

pub fn is_cache_enabled(&self) -> bool

Checks if cache is enabled (always false when cache feature is disabled)

pub fn set_cache_enabled(&mut self, _enabled: bool)

Sets the cache enabled state (no-op when cache feature is disabled)

pub async fn authenticate(&mut self, credentials: Credentials) -> Result<()>

Authenticates with the Metabase API

pub async fn logout(&mut self) -> Result<()>

Logs out from the Metabase API

pub async fn health_check(&self) -> Result<HealthStatus>

Performs a health check on the Metabase API

pub async fn get_current_user(&self) -> Result<User>

Gets the current authenticated user

pub async fn get_card(&self, id: i64) -> Result<Card>

Gets a card by ID

pub async fn list_cards( &self, params: Option<CardListParams>, ) -> Result<Vec<Card>>

Lists all cards

pub async fn create_card(&self, card: Card) -> Result<Card>

Creates a new card

pub async fn update_card(&self, id: i64, updates: Value) -> Result<Card>

Updates an existing card

pub async fn delete_card(&self, id: i64) -> Result<()>

Deletes a card

pub async fn get_collection(&self, id: MetabaseId) -> Result<Collection>

Gets a collection by ID

pub async fn list_collections(&self) -> Result<Vec<Collection>>

Lists all collections

pub async fn create_collection( &self, collection: Collection, ) -> Result<Collection>

Creates a new collection

pub async fn update_collection( &self, id: MetabaseId, updates: Value, ) -> Result<Collection>

Updates an existing collection

pub async fn archive_collection(&self, id: MetabaseId) -> Result<Collection>

Archives a collection (Metabase doesn’t delete, only archives)

pub async fn get_dashboard(&self, id: MetabaseId) -> Result<Dashboard>

Gets a dashboard by ID

pub async fn list_dashboards( &self, pagination: Option<Pagination>, ) -> Result<Vec<Dashboard>>

Lists all dashboards

pub async fn create_dashboard(&self, dashboard: Dashboard) -> Result<Dashboard>

Creates a new dashboard

pub async fn update_dashboard( &self, id: MetabaseId, updates: Value, ) -> Result<Dashboard>

Updates an existing dashboard

pub async fn delete_dashboard(&self, id: MetabaseId) -> Result<()>

Deletes a dashboard

pub async fn execute_query(&self, query: DatasetQuery) -> Result<QueryResult>

Executes a dataset query

pub async fn execute_native_query( &self, database: MetabaseId, native_query: NativeQuery, ) -> Result<QueryResult>

Executes a native SQL query

pub async fn execute_card_query( &self, card_id: i64, parameters: Option<Value>, ) -> Result<QueryResult>

Execute a card’s query with optional parameters

pub async fn export_card_query( &self, card_id: i64, format: ExportFormat, parameters: Option<Value>, ) -> Result<Vec<u8>>

Export card query results in specified format

pub async fn execute_card_pivot_query( &self, card_id: i64, parameters: Option<Value>, ) -> Result<QueryResult>

Execute a pivot query for a card

pub async fn get_database_metadata( &self, database_id: MetabaseId, ) -> Result<DatabaseMetadata>

Get database metadata including tables and fields

pub async fn sync_database_schema( &self, database_id: MetabaseId, ) -> Result<SyncResult>

Sync database schema

pub async fn get_database_fields( &self, database_id: MetabaseId, ) -> Result<Vec<Field>>

Get all fields for a database

pub async fn get_database_schemas( &self, database_id: MetabaseId, ) -> Result<Vec<String>>

Get all schemas for a database

pub async fn execute_dataset_query(&self, query: Value) -> Result<QueryResult>

Execute a dataset query with advanced options

pub async fn execute_dataset_native(&self, query: Value) -> Result<QueryResult>

Execute a native query through the dataset endpoint

pub async fn execute_dataset_pivot(&self, query: Value) -> Result<QueryResult>

Execute a pivot dataset query

pub async fn export_dataset( &self, format: ExportFormat, query: Value, ) -> Result<Vec<u8>>

Export dataset query results

pub async fn execute_sql( &self, database_id: MetabaseId, sql: &str, ) -> Result<QueryResult>

Execute a simple SQL query

pub async fn execute_sql_with_params( &self, database_id: MetabaseId, sql: &str, params: HashMap<String, Value>, ) -> Result<QueryResult>

Execute a parameterized SQL query

pub async fn export_sql_query( &self, database_id: MetabaseId, sql: &str, format: ExportFormat, ) -> Result<Vec<u8>>

Export SQL query results in specified format

Trait Implementations

impl Clone for MetabaseClient

fn clone(&self) -> MetabaseClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.