metabase.mbql.schema — metabase/mbql 1.2.0

Schema for validating a normalized MBQL query. This is also the definitive grammar for MBQL, wow!

!= clj

Schema for a valid != clause.

* clj

Schema for a valid * clause.

+ clj

Schema for a valid + clause.

- clj

Schema for a valid - clause.

/ clj

Schema for a valid / clause.

< clj

Schema for a valid < clause.

<= clj

Schema for a valid <= clause.

= clj

Schema for a valid = clause.

> clj

Schema for a valid > clause.

>= clj

Schema for a valid >= clause.

absolute-datetime clj

Schema for a valid absolute-datetime clause.

ag:* clj

Schema for a valid * clause.

ag:+ clj

Schema for a valid + clause.

ag:- clj

Schema for a valid - clause.

ag:div clj

Schema for a valid / clause.

Aggregation clj

Schema for anything that is a valid :aggregation clause.

aggregation clj

Schema for a valid aggregation clause.

and clj

Schema for a valid and clause.

asc clj

Schema for a valid asc clause.

avg clj

Schema for a valid avg clause.

between clj

Schema for a valid between clause.

BinnableField clj

Schema for any sort of field clause that can be wrapped by a binning-strategy clause.

binning-strategy clj

Schema for a valid binning-strategy clause.

BinningStrategyName clj

Schema for a valid value for the strategy-name param of a binning-strategy clause.

contains clj

Schema for a valid contains clause.

Context clj

Schema for info.context; used for informational purposes to record how a query was executed.

count clj

Schema for a valid count clause.

count-where clj

Schema for a valid count-where clause.

cum-count clj

Schema for a valid cum-count clause.

cum-sum clj

Schema for a valid cum-sum clause.

DatabaseID clj

Schema for a valid :database ID, in the top-level 'outer' query. Either a positive integer (referring to an actual Database), or the saved questions virtual ID, which is a placeholder used for queries using the :source-table "card__id" shorthand for a source query resolved by middleware (since clients might not know the actual DB for that source query.)

datetime-field clj

Schema for a valid datetime-field clause.

DatetimeFieldUnit clj

Schema for all valid datetime bucketing units.

DateTimeValue clj

Schema for a datetime value drivers will personally have to handle, either an absolute-datetime form or a relative-datetime form.

desc clj

Schema for a valid desc clause.

distinct clj

Schema for a valid distinct clause.

does-not-contain clj

Schema for a valid does-not-contain clause.

ends-with clj

Schema for a valid ends-with clause.

expression clj

Schema for a valid expression clause.

Field clj

Schema for anything that refers to a Field, from the common [:field-id <id>] to variants like :datetime-field or :fk-> or an expression reference [:expression <name>].

field-id clj

Schema for a valid field-id clause.

field-literal clj

Schema for a valid field-literal clause.

FieldOrAggregationReference clj

Schema for any type of valid Field clause, or for an indexed reference to an aggregation clause.

FieldOrExpressionDef clj

Schema for anything that is accepted as a top-level expression definition, either an arithmetic expression such as a :+ clause or a Field clause such as :field-id.

Fields clj

Schema for valid values of the MBQL :fields clause.

Filter clj

Schema for a valid MBQL :filter clause.

fk-> clj

Schema for a valid fk-> clause.

Info clj

Schema for query :info dictionary, which is used for informational purposes to record information about how a query was executed in QueryExecution and other places. It is considered bad form for middleware to change its behavior based on this information, don't do it!

inside clj

Schema for a valid inside clause.

interval clj

Schema for a valid interval clause.

is-null clj

Schema for a valid is-null clause.

Join clj

Perform the equivalent of a SQL JOIN with another Table or nested :source-query. JOINs are either explicitly specified in the incoming query, or implicitly generated when one uses a :fk-> clause. In the top-level query, you can reference Fields from the joined table or nested query by the :fk-> clause for implicit joins; for explicit joins, you must specify :alias yourself; you can then reference Fields by using a :joined-field clause, e.g.

[:joined-field "my_join_alias" [:field-id 1]] ; for joins against other Tabless [:joined-field "my_join_alias" [:field-literal "my_field"]] ; for joins against nested queries

joined-field clj

Schema for a valid joined-field clause.

JoinField clj

Schema for any valid Field that is, or wraps, a :joined-field clause.

JoinFields clj

Schema for valid values of a join :fields clause.

Joins clj

Schema for a valid sequence of Joins. Must be a non-empty sequence, and :alias, if specified, must be unique.

JoinStrategy clj

Strategy that should be used to perform the equivalent of a SQL JOIN against another table or a nested query. These correspond 1:1 to features of the same name in driver features lists; e.g. you should check that the current driver supports :full-join before generating a Join clause using that strategy.

LiteralDateString clj

Schema for an ISO-8601-formatted date string literal.

LiteralDatetimeString clj

Schema for an ISO-8601-formattedor datetime string literal.

LiteralTimeString clj

Schema for an ISO-8601-formatted time string literal.

max clj

Schema for a valid max clause.

MBQLQuery clj

Schema for a valid, normalized MBQL [inner] query.

metric clj

Schema for a valid metric clause.

min clj

Schema for a valid min clause.

named clj

Schema for a valid named clause.

NamedAggregationOptions clj

Schema for optional options map for the :named aggregation clause.

NativeQuery clj

Schema for a valid, normalized native [inner] query.

not clj

Schema for a valid not clause.

not-null clj

Schema for a valid not-null clause.

or clj

Schema for a valid or clause.

OrderBy clj

Schema for an order-by clause subclause.

Query clj

Schema for an [outer] query, e.g. the sort of thing you'd pass to the query processor or save in Card.dataset_query.

relative-datetime clj

Schema for a valid relative-datetime clause.

ResolvedBinningStrategyOptions clj

Schema for map of options tacked on to the end of binning-strategy clauses by the binning middleware.

saved-questions-virtual-database-id clj

The ID used to signify that a database is 'virtual' rather than physical.

A fake integer ID is used so as to minimize the number of changes that need to be made on the frontend -- by using something that would otherwise be a legal ID, nothing need change there, and the frontend can query against this 'database' none the wiser. (This integer ID is negative which means it will never conflict with a real database ID.)

This ID acts as a sort of flag. The relevant places in the middleware can check whether the DB we're querying is this 'virtual' database and take the appropriate actions.

segment clj

Schema for a valid segment clause.

share clj

Schema for a valid share clause.

source-table-card-id-regex clj

Pattern that matches card__id strings that can be used as the :source-table of MBQL queries.

SourceQuery clj

Schema for a valid value for a :source-query clause.

SourceQueryMetadata clj

Schema for the expected keys for a single column in :source-metadata (:source-metadata is a sequence of these entries), if it is passed in to the query.

This metadata automatically gets added for all source queries that are referenced via the card__id :source-table form; for explicit :source-querys you should usually include this information yourself when specifying explicit :source-querys.

SourceTable clj

Schema for a valid value for the :source-table clause of an MBQL query.

starts-with clj

Schema for a valid starts-with clause.

stddev clj

Schema for a valid stddev clause.

sum clj

Schema for a valid sum clause.

sum-where clj

Schema for a valid sum-where clause.

TemporalLiteralString clj

Schema for either a literal datetime string, literal date string, or a literal time string.

time clj

Schema for a valid time clause.

time-interval clj

Schema for a valid time-interval clause.

TimeUnit clj

Valid unit for time bucketing.

validate-query clj

(validate-query query)

Compiled schema validator for an [outer] Metabase query. (Pre-compling a validator is more efficient; use this instead of calling (s/validate Query query) or similar.

value clj

Schema for a valid value clause.

ValueTypeInfo clj

Type info about a value in a :value clause. Added automatically by wrap-value-literals middleware to values in filter clauses based on the Field in the clause.