Card

Dashboard

DashboardCard

DatasetQuery

About Parameters

Time

Locations

About Visualizations

Area Chart

Bar Chart

Combo Chart

Funnel

Gauge

Line Chart

Object Detail

Pie Chart

Pivot Table

Progress

Row Chart

Scalar

Scatter

Smart Scalar

Table

Text

Waterfall Chart

<h1>DatasetQuery</h1>
<p><em>This page describes <code>native</code> queries.</em></p>
<p>DatasetQuery is attribute of <a href="/metadocs/docs/data-structures/card">Card</a>, and just an object not a separate model.</p>
<h2>Attributes</h2>
<h3>NativeDatasetQuery</h3>
<p>Since we will be using native queries in most cases, this can be considered almost identical to DatasetQuery.</p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>type</td>
<td>'native'</td>
<td></td>
</tr>
<tr>
<td>database</td>
<td>number</td>
<td>database id</td>
</tr>
<tr>
<td>native</td>
<td><a href="#native-query">NativeQuery</a></td>
<td></td>
</tr>
</tbody>
</table>
<h3>NativeQuery</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>query</td>
<td>string</td>
<td>Query body like SQL</td>
<td>""</td>
</tr>
<tr>
<td>template-tags</td>
<td><code>{ [key: string]: TemplateTag }</code></td>
<td><a href="#template-tag">TemplateTag</a></td>
<td>{}</td>
</tr>
</tbody>
</table>
<h3>TemplateTag</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>string</td>
<td>UUID v4 format random id</td>
</tr>
<tr>
<td>name</td>
<td>string</td>
<td>Used as a key for mapping with filters on the dashboard.</td>
</tr>
<tr>
<td>display-name</td>
<td>string</td>
<td>Display name</td>
</tr>
<tr>
<td>type</td>
<td><code>text</code> | <code>date</code> | <code>number</code> | <code>dimension</code></td>
<td></td>
</tr>
<tr>
<td>dimension</td>
<td><code>['field-id', field-id]</code></td>
<td><code>field-id</code> is ID on <code>metabase_field</code> table.Required if <code>type === dimension</code>.</td>
</tr>
<tr>
<td>widget-type</td>
<td>string</td>
<td><code>category</code>, <code>date/*</code>, etc. See <a href="/metadocs/docs/parameters">Parameters</a> for types list.Required if <code>type === dimension</code>.</td>
</tr>
</tbody>
</table>
<h2>Source Code</h2>
<ul>
<li><a href="https://github.com/metabase/metabase/blob/v0.38.3/frontend/src/metabase-lib/lib/queries/NativeQuery.js">Frontend NativeQuery</a></li>
<li><a href="https://github.com/metabase/metabase/blob/v0.38.3/frontend/src/metabase-types/types/Query.js#L52">Frontend Query type definition</a></li>
<li><a href="https://github.com/metabase/metabase/blob/v0.38.3/frontend/src/metabase-types/types/Parameter.js">Frontend Parameter type definition</a></li>
</ul>


Name	Type	Description	Default
query	string	Query body like SQL	""
template-tags	`{ [key: string]: TemplateTag }`	TemplateTag	{}

Name	Type	Description
id	string	UUID v4 format random id
name	string	Used as a key for mapping with filters on the dashboard.
display-name	string	Display name
type	`text` \| `date` \| `number` \| `dimension`
dimension	`['field-id', field-id]`	`field-id` is ID on `metabase_field` table.Required if `type === dimension`.
widget-type	string	`category`, `date/*`, etc. See Parameters for types list.Required if `type === dimension`.

Name	Type	Description
type	'native'
database	number	database id
native	NativeQuery