Struct Client

pub struct Client {
    pub(crate) inner: Client,
    pub(crate) url: Url,
    pub(crate) session_id: Option<String>,
}

A Metabase API client.

Fields

inner: Client

url: Url

session_id: Option<String>

Implementations

impl Client

pub fn new<U>(url: U) -> Result<Self, Error>

where U: IntoUrl,

Constructs a new Client that will target a Metabase instance at url.

url must not contain a path nor be a cannot-be-a-base URL.

pub fn set_session_id(&mut self, session_id: String)

Sets the session ID to include in future requests made by this client.

pub async fn session_properties( &self, ) -> Result<SessionPropertiesResponse, Error>

Fetches public, global properties.

The underlying API call is GET /api/session/properties.

pub async fn login( &self, request: &LoginRequest, ) -> Result<LoginResponse, Error>

Requests a session ID for the username and password named in request.

Note that usernames are typically email addresses. To authenticate future requests with the returned session ID, call set_session_id.

The underlying API call is POST /api/session.

pub async fn setup( &self, request: &SetupRequest, ) -> Result<LoginResponse, Error>

Creates a user and database connection if the Metabase instance has not yet been set up.

The request must include the setup_token from a SessionPropertiesResponse. If the setup token returned by Client::session_properties is None, the cluster is already set up, and this request will fail.

The underlying API call is POST /api/setup.

pub async fn databases(&self) -> Result<Vec<Database>, Error>

Fetches the list of databases known to Metabase.

The underlying API call is GET /database.

pub async fn database_metadata( &self, id: usize, ) -> Result<DatabaseMetadata, Error>

Fetches metadata about a particular database.

The underlying API call is GET /database/:id/metadata.

pub(crate) fn api_url(&self, endpoint: &[&str]) -> Url

pub(crate) async fn send_request<T>( &self, req: RequestBuilder, ) -> Result<T, Error>

where T: DeserializeOwned,

Trait Implementations

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.