DiscordPHP-MTG Documentation

Database

in package

• Application

A local copy of MTGJSON's AllPrintings SQLite build, kept current from the API. MTGJSON has no query endpoint — it publishes whole files — so card and set searches run here instead of over HTTP.

Tags

link

https://mtgjson.com/downloads/all-files/#allprintings

since

1.0.0

Table of Contents

Constants

DEFAULT_REFRESH_INTERVAL  : int = 86400

Seconds between `Meta.json` checks by default: MTGJSON rebuilds daily.

FILE  : string = 'AllPrintings.sqlite'

The file name of the installed build.

INDEXES  : array<string|int, string> = ['CREATE INDEX IF NOT EXISTS "idx_cardIdentifie...

Indexes added to each build after download, for lookups MTGJSON does not index itself.

JSON_COLUMNS  : array<string, array<string|int, string>> = ['cards' => ['leadershipSkills', 'relatedCards'...

Columns the SQL build stores as JSON text, by table.

LIST_COLUMNS  : array<string, array<string|int, string>> = ['cards' => ['artistIds', 'attractionLights', '...

Columns the SQL build stores as `", "`-joined lists, by table.

Properties

$browser  : Browser

$columns  : array<string, array<string, string>>

Declared column types, by table, read lazily with `PRAGMA table_info`.

$date  : string|null

The date (`meta.date`) of the open build.

$http  : Http

$logger  : LoggerInterface

$loop  : LoopInterface

$opening  : PromiseInterface|null

The pending first install, shared by every caller of {@see ready()}.

$path  : string

$pdo  : PDO|null

The open read-only connection, or null while closed.

$refreshing  : PromiseInterface|null

The pending refresh, shared by every caller of {@see refresh()}.

$refreshInterval  : int

$timer  : TimerInterface|null

The periodic refresh timer.

$version  : string|null

The version (`meta.version`) of the open build.

Methods

__construct()  : mixed

close()  : void

Closes the connection and stops the refresh timer. The next query reopens it.

decode()  : array<string|int, mixed>

Decodes a row of `$table` into MTGJSON's JSON shape: list and JSON columns become arrays, `BOOLEAN` columns become `bool`, and null or empty scalars are dropped.

getColumns()  : array<string, string>

The columns of a table in the open build, with their declared types.

getDate()  : string|null

The date (`meta.date`) of the open build, e.g. `2026-10-03`.

getPath()  : string

Where the build is kept.

getVersion()  : string|null

The version (`meta.version`) of the open build, e.g. `5.3.0+20261003`.

isOpen()  : bool

Whether a build is open.

query()  : PromiseInterface<string|int, array<string|int, array<string|int, mixed>>>

Runs a read query against the build, opening (or downloading) it first.

ready()  : PromiseInterface<string|int, PDO>

Opens the build, downloading it first if there is none on disk, and starts the refresh timer.

refresh()  : PromiseInterface<string|int, bool>

Checks `Meta.json` and installs MTGJSON's current build if it is newer than the open one (or always, when forced).

select()  : array<string|int, array<string|int, mixed>>

Runs a read query against the open build, synchronously. Callers must have waited for {@see ready()}.

disconnect()  : void

Drops the connection so the file can be replaced.

download()  : PromiseInterface<string|int, void>

Streams a gzipped file, inflating it to `$target` chunk by chunk so it is never held in memory.

inflateTo()  : PromiseInterface<string|int, void>

Inflates a gzip body stream into an open file.

install()  : PromiseInterface<string|int, string>

Downloads, verifies and swaps in MTGJSON's current build.

label()  : string

What this build is called in logs and errors.

open()  : void

Opens the build at {@see $path} read-only and reads its version.

prepare()  : string

Checks a downloaded build and adds the extra indexes.

refreshQuietly()  : void

Refreshes, logging rather than throwing on failure; the open build stays in use.

remoteVersion()  : PromiseInterface<string|int, ?string>

The version of the build currently published, from `Meta.json`.

schedule()  : void

Starts the refresh timer, and checks right away if the build on disk is already older than one interval.

source()  : string

Where the gzipped build is downloaded from.