Struct MtgjsonSdk 

pub struct MtgjsonSdk { /* private fields */ }

The main entry point for the MTGJSON SDK.

Wraps a Connection (which owns the CacheManager and DuckDB database) and exposes domain-specific query interfaces as lightweight borrowing wrappers.

Created via MtgjsonSdk::builder().

Implementations

impl MtgjsonSdk

pub fn builder() -> MtgjsonSdkBuilder

Create a new builder for configuring the SDK.

pub fn cards(&self) -> CardQuery<'_>

Access the card query interface.

Returns a lightweight wrapper that borrows from the underlying connection and provides methods for querying card data.

pub fn sets(&self) -> SetQuery<'_>

Access the set query interface.

pub fn tokens(&self) -> TokenQuery<'_>

Access the token query interface.

pub fn prices(&self) -> PriceQuery<'_>

Access the price query interface.

Requires the prices_today table to have been loaded into DuckDB.

pub fn legalities(&self) -> LegalityQuery<'_>

Access the legality query interface.

pub fn identifiers(&self) -> IdentifierQuery<'_>

Access the identifier query interface.

pub fn decks(&self) -> DeckQuery<'_>

Access the deck query interface.

Deck data is loaded from DeckList.json via the cache manager.

pub fn sealed(&self) -> SealedQuery<'_>

Access the sealed product query interface.

pub fn skus(&self) -> SkuQuery<'_>

Access the TCGplayer SKU query interface.

Requires the tcgplayer_skus table to have been loaded into DuckDB.

pub fn enums(&self) -> EnumQuery<'_>

Access the enum/keyword query interface.

Enum data is loaded from JSON files (Keywords.json, CardTypes.json, EnumValues.json) via the cache manager.

pub fn booster(&self) -> BoosterSimulator<'_>

Access the booster pack simulator.

The simulator reads from the set booster parquet tables to generate randomized booster packs matching real-world distribution rules.

pub fn meta(&self) -> Result<Value>

Load and return the MTGJSON metadata (version, date, etc.).

Fetches Meta.json from the cache (downloading if necessary) and returns the parsed JSON object.

pub fn views(&self) -> Vec<String>

Return the list of currently registered DuckDB view names.

Views are registered lazily on first query, so this list grows as different query interfaces are used.

pub fn sql( &self, query: &str, params: &[String], ) -> Result<Vec<HashMap<String, Value>>>

Execute a raw SQL query against the DuckDB database.

Provides escape-hatch access for queries not covered by the domain-specific interfaces.

Arguments

• query - SQL string with ? positional placeholders.
• params - Parameter values corresponding to the placeholders.

Returns

A vector of rows, each represented as a HashMap<String, serde_json::Value>.

pub fn export_db<P: AsRef<Path>>(&self, path: P) -> Result<PathBuf>

Export the in-memory DuckDB database to a directory on disk.

Uses DuckDB’s EXPORT DATABASE command to write the database contents (schema + data) to the given path.

pub fn refresh(&self) -> Result<bool>

Check for a newer MTGJSON version and reset views if stale.

Returns true if the data was stale and views were reset (meaning subsequent queries will re-download data), or false if already up to date.

pub fn close(self)

Consume the SDK and release all resources.

Closes the DuckDB connection and HTTP client. This is called automatically when the SDK is dropped, but can be invoked explicitly for deterministic cleanup.

pub fn connection(&self) -> &Connection

Return a reference to the underlying Connection for advanced usage.

pub fn connection_mut(&mut self) -> &mut Connection

Return a mutable reference to the underlying Connection.

Trait Implementations

impl Display for MtgjsonSdk

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

Formats the value using the given formatter.