Struct TesseraClient 

pub struct TesseraClient { /* private fields */ }

A synchronous client for the Tessera API.

Call TesseraClient::new with an explicit API key or rely on $TESSERA_API_KEY.

Panics

The constructor builds a private tokio runtime (needed for Polars cloud reads), so a TesseraClient must not be constructed or used from inside another async runtime — use crate::AsyncTesseraClient there instead.

Implementations

impl TesseraClient

pub fn new(api_key: Option<&str>) -> Result<Self, TesseraError>

Create a client with defaults, resolving the key from api_key or $TESSERA_API_KEY.

Errors

Returns TesseraError::Configuration when no API key can be resolved.

pub fn from_config(config: ClientConfig) -> Result<Self, TesseraError>

Create a client from a fully-specified ClientConfig.

Errors

Returns TesseraError::Network when the HTTP client or tokio runtime cannot be built.

pub fn config(&self) -> &ClientConfig

The resolved configuration this client was built with.

pub fn close(&mut self)

Close the underlying HTTP connection pool.

pub fn datasets(&self) -> Result<DatasetsResponse, TesseraError>

List every dataset visible to your plan.

Errors

Returns any TesseraError the API or transport raises.

pub fn partitions( &self, asset: &str, coin: Option<&str>, month: Option<&str>, ) -> Result<PartitionsResponse, TesseraError>

List the partitions of asset, optionally filtered by coin/month.

Errors

Returns any TesseraError the API or transport raises.

pub fn download_url( &self, asset: &str, coin: &str, month: &str, ) -> Result<DownloadResponse, TesseraError>

Mint a short-lived presigned download URL for one partition.

Errors

Returns any TesseraError the API or transport raises.

pub fn partition_refs( &self, asset: &str, coin: impl IntoCoins, month: impl IntoMonths, ) -> Result<Vec<PartitionRef>, TesseraError>

Expand (asset, coins, months) into concrete partition references.

Errors

Returns TesseraError::InvalidArgument on empty/invalid arguments.

pub fn scan( &self, asset: &str, coin: impl IntoCoins, month: impl IntoMonths, columns: Option<&[&str]>, ) -> Result<LazyFrame, TesseraError>

Lazily scan one or more partitions into a Polars LazyFrame.

URLs are minted now but the data is read on .collect(). Because presigned URLs expire (~15 min), collect promptly; for long-lived graphs re-run scan to refresh.

Errors

Returns any TesseraError the API or transport raises.

pub fn read( &self, asset: &str, coin: impl IntoCoins, month: impl IntoMonths, columns: Option<&[&str]>, ) -> Result<DataFrame, TesseraError>

Eagerly read one or more partitions into a Polars DataFrame.

Errors

Returns any TesseraError the API or transport raises, including TesseraError::PresignExpired for rejected presigned URLs.

pub fn to_duckdb( &self, asset: &str, coin: impl IntoCoins, month: impl IntoMonths, columns: Option<&[&str]>, ) -> Result<Connection, TesseraError>

Open one or more partitions as an in-memory DuckDB connection exposing a tessera view for SQL querying.

Errors

Returns any TesseraError the API or transport raises.

Trait Implementations

impl Debug for TesseraClient

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

Formats the value using the given formatter.

impl Drop for TesseraClient

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.