Skip to content

Commit d195c06

Browse files
author
Metabase Docs bot
committed
[auto] adding content to worker-and-drivers-transforms->master
1 parent 13db8b2 commit d195c06

File tree

171 files changed

+814
-8767
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

171 files changed

+814
-8767
lines changed

_docs/master/api.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16909,7 +16909,7 @@
1690916909
}
1691016910
}, {
1691116911
"in" : "query",
16912-
"name" : "payload_type",
16912+
"name" : "pyaload_type",
1691316913
"required" : false,
1691416914
"schema" : {
1691516915
"type" : "string",

_docs/master/dashboards/filters.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ redirect_from:
1616

1717
![Dashboard Filters](./images/filters.png)
1818

19-
Instead of creating duplicate dashboards to show different cuts of the same data (like a different dashboard for each quarter), you can add filter or parameter widgets to let people change _what_ data is displayed (filter the data), or _how_ it's displayed (parameterize the data).
19+
Instead of creating duplicate dashboards to show different cuts of the same data (like a different dashboard for each quarter), you can add filter or parameter widgets to let people change _what_ data is displayed (filter the data), or _how_ its displayed (parameterize the data).
2020

2121
## Filter and parameter widgets
2222

23-
There are two basic types of widgets you can add. The type of filter or parameter widget you choose determines how the widget works, including which fields you can connect to the widget.
23+
There are two basic types of widgets you can add. The type of filter or parameter widget you choose determines how the widget works, including which fields you'll can connect to the widget.
2424

2525
### Filter widgets
2626

@@ -57,7 +57,7 @@ There are two basic types of widgets you can add. The type of filter or paramete
5757
5. [Configure your filter](#editing-a-filter).
5858
6. **Save** your changes.
5959

60-
If the filter isn't connected to any of the cards on the current tab, Metabase won't display the filter.
60+
If the filter isn't connected any of the cards on the current tab, Metabase won't display the filter.
6161

6262
### When to add a widget to a heading or card
6363

@@ -83,11 +83,11 @@ When picking a Date picker filter, Metabase will prompt you to pick an operator:
8383
- Relative Date
8484
- All Options
8585

86-
Single Date and Date Range will provide a calendar widget, while the other options provide slightly different dropdown interfaces for picking values. To get a widget that's just like the date picker in the query builder, choose "All Options".
86+
Single Date and Date Range will provide a calendar widget, while the other options all provide slightly different dropdown interfaces for picking values. To get a widget that's just like the date picker in the query builder, choose All options.
8787

8888
### Issues with connecting to a date variable
8989

90-
If you get a message like "A date variable in this card can only be connected to a time type with the Single date option," you can handle it in a couple of ways.
90+
If you get a message like "A date variable in this card can only be connectedd to a time type with the single date option", you can handle it in a couple of ways.
9191

9292
- **If you want a date picker where people can select multiple dates**, you'll need to change the variable in your SQL code to a [field filter](../questions/native-editor/field-filters).
9393
- **If you want the filter widget to just take a single date**, you'll need to change the dashboard filter widget's type to "Single date".
@@ -132,7 +132,7 @@ Additionally, you can select an operator for the location filter:
132132

133133
## ID filter
134134

135-
The ID filter provides a simple input box where you can type the ID of a user, order, and so on.
135+
The ID filter provides a simple input box where you can type the ID of a user, order, etc.
136136

137137
You can give people the option to pick one value or multiple values.
138138

@@ -148,7 +148,7 @@ You can choose from:
148148

149149
## Text or category filter
150150

151-
A flexible filter type that lets you create either a dropdown menu or an input box to filter on any text or category field in your cards. Options include:
151+
A flexible filter type that will let you create either a dropdown menu or an input box to filter on any text or category field in your cards. Options include:
152152

153153
- **Is**. Select one or more values from a list or search box. Use **Is** when you just want to plug a value into a variable. For multiple values, the card must be a question built using the query builder, a native/SQL question using a [field filter](../questions/native-editor/field-filters), or a basic variable set to [multiple values](../questions/native-editor/basic-sql-parameters#basic-variable-that-allows-people-to-select-multiple-values).
154154
- **Is not**. Exclude one or more specific values.
@@ -171,9 +171,9 @@ A boolean filter allows people to filter data based on true/false values.
171171

172172
For each widget that you add, you'll need to tell Metabase which column the filter should update for each card.
173173

174-
Click a card's dropdown menu to select the field that you want the widget to filter on.
174+
Click on a card's dropdown menu to select the field that you want the widget to filter on.
175175

176-
Here we've wired up a text filter to the "Event types" card, telling Metabase that the column to filter on should be the `Analytics.Event.Button.Label` field:
176+
Here we've wired up a Text filter to the "Event types" card, telling Metabase that the column to filter on should be the `Analytics.Event.Button.Label` field:
177177

178178
![Wiring up a dashboard filter to a card](./images/wiring-cards.png)
179179

@@ -182,17 +182,17 @@ Which cards you can connect a filter or parameter widget to depends on:
182182
- Whether the card has a relevant field (i.e., the field the widget is filtering).
183183
- Where the widget is located: on the dashboard, heading card, or question card. Only dashboard widgets can be connected to cards across all [dashboard tabs](./introduction#dashboard-tabs). Widgets on heading and question cards are restricted to the cards on their respective tabs.
184184

185-
## Filtering dashboards with native/SQL questions
185+
## Auto-connecting filters to cards
186186

187-
To connect a dashboard filter widget to a card with a question created with the native editor, you'll need to [add a field filter or basic variable to your query](../questions/native-editor/sql-parameters).
187+
If there are other cards that also have the field you select, Metabase will offer to automatically connect the filter to those cards too (including to relevant cards on other tabs). If you later add a card with the selected field, Metabase will also try to connect that filter to the new card.
188188

189-
For parameters, check out [Time grouping parameters](../questions/native-editor/time-grouping-parameters).
189+
To undo this auto-connecting of cards, click on the toast that pops up when Metabase auto-connects the cards, or manually disconnect the cards by clicking on the "X" next to the connected field.
190190

191-
## Auto-connecting filters to cards
191+
## Filtering dashboards with native/SQL questions
192192

193-
If there are other cards that also have the field you select, Metabase will offer to automatically connect the filter to those cards too (including relevant cards on other tabs). If you later add a card with the selected field, Metabase will also try to connect that filter to the new card.
193+
For filters, you'll need to [add a variable or field filter to your query](../questions/native-editor/sql-parameters).
194194

195-
To undo this auto-connecting of cards, click the notification that pops up when Metabase auto-connects the cards, or manually disconnect the cards by clicking the "X" next to the connected field.
195+
For parameters, check out [Time grouping parameters](../questions/native-editor/time-grouping-parameters).
196196

197197
## Wiring up dashboard filters to text cards
198198

@@ -209,10 +209,10 @@ You might want to require a filter value if:
209209

210210
## Editing a filter
211211

212-
To edit a dashboard filter's settings:
212+
To edit a filter's settings:
213213

214214
1. Click the **pencil** icon to enter dashboard editing mode.
215-
2. Click the filter you want to edit.
215+
2. Click the **gear** icon on the filter you want to edit.
216216

217217
From this filter editing view, you can wire up dashboard cards to the filter, or use the filter settings sidebar to:
218218

@@ -226,14 +226,14 @@ From this filter editing view, you can wire up dashboard cards to the filter, or
226226

227227
### Rename filter
228228

229-
1. In dashboard edit mode, click the filter you want to edit.
229+
1. In dashboard edit mode, click your filter's **gear** icon.
230230
2. Change the label text.
231231

232232
Renaming the filter only affects the filter's display; the label has no effect on which columns Metabase filters.
233233

234234
### Set filter input type
235235

236-
1. In dashboard edit mode, click the filter you want to edit.
236+
1. In dashboard edit mode, click your filter's **gear** icon.
237237
2. From the filter settings sidebar, set **How should people filter on this column?**:
238238

239239
- [Dropdown list](#dropdown-list)
@@ -242,9 +242,9 @@ Renaming the filter only affects the filter's display; the label has no effect o
242242

243243
#### Dropdown list
244244

245-
A list of all the possible values in a column. People can use checkboxes to select more than one value on [multi-select filters](#make-a-multi-select-filter). If you want the list of filter values to load instantly (from cache), you should choose the dropdown widget.
245+
A list of all of the possible values in a column. People can use checkboxes to select more than one value on [multi-select filters](#make-a-multi-select-filter). You should choose the dropdown widget if you want the list of filter values to load instantly (from cache).
246246

247-
If you're not seeing the **Dropdown list** option and your dashboard filter is based on a column from a:
247+
If you're not seeing the **Dropdown list** option, and your dashboard filter is based on a column from a:
248248

249249
- Table or model built with the query builder: an admin will need to [enable the dropdown widget](../data-modeling/metadata-editing#changing-a-search-box-filter-to-a-dropdown-filter) for that column from Metabase's **Admin settings**.
250250
- Model built with a SQL query: go to your [model's metadata settings](../data-modeling/models#add-metadata-to-columns-in-a-model), find your column, and set the **Database column this maps to**.
@@ -253,7 +253,7 @@ If you're not seeing the **Dropdown list** option and your dashboard filter is b
253253

254254
A search box that suggests a list of matching filter values as you type. The suggestion list will display checkboxes for [multi-select filters](#make-a-multi-select-filter).
255255

256-
The search box is a good choice for most columns containing labels, categories, statuses, and so on. It's the default filter widget for columns with fewer than 100 unique values.
256+
The search box is a good choice for most columns containing labels, categories, statuses, and so on. It's is the default filter widget for columns with less than 100 unique values.
257257

258258
#### Plain input box
259259

@@ -263,32 +263,32 @@ Useful for looking up partial matches (such as the ["contains" filter](#text-or-
263263

264264
### Set a default filter value
265265

266-
1. In dashboard edit mode, click the filter you want to edit.
266+
1. In dashboard edit mode, click your filter's **gear** icon.
267267
2. From the sidebar, choose a value from the **Default value** input field.
268268

269-
For example, you might want to set a default filter value like "Active," so that when people load your dashboard, they only see data for "Active" records (not "Inactive," "Canceled," and so on).
269+
For example, you might want to set a default filter value like "Active", so that when people load your dashboard, they only see data for "Active" records (not "Inactive", "Cancelled", etc).
270270

271271
### Remove a filter
272272

273-
1. In dashboard edit mode, click the filter you want to edit.
273+
1. In dashboard edit mode, click your filter's **gear** icon.
274274
2. From the sidebar, click **Remove**.
275275

276276
If you accidentally remove a filter, just click **Cancel** in the top-right to exit dashboard edit mode without saving your changes.
277277

278278
### Reorder filters
279279

280-
In dashboard edit mode, click the grabber handle (six dots) on the left side of a filter widget, then drag the widget to a different position.
280+
In dashboard edit mode, click on the grabber handle (six dots) on the left side of a filter widget, then drag the widget to a different position.
281281

282282
### Make a multi-select filter
283283

284-
1. In dashboard edit mode, click the filter you want to edit.
284+
1. In dashboard edit mode, click your filter's **gear** icon.
285285
2. From the sidebar, find **People can pick** and select "Multiple values".
286286

287287
A multi-select filter with the widget type [Dropdown list](#dropdown-list) or [Search box](#search-box) will display a list of values with checkboxes.
288288

289289
### Change a filter's selectable values
290290

291-
1. In dashboard edit mode, click the filter you want to edit.
291+
1. In dashboard edit mode, click your filter's **gear** icon.
292292
2. From the sidebar, find **How should users filter on this column?**.
293293
3. Select "Dropdown list".\*
294294
4. Click **Edit** (to the right of "Dropdown list") to specify where the values should come from:
@@ -310,9 +310,9 @@ By default, each time you change the value in a filter on a dashboard, the dashb
310310

311311
If a dashboard is particularly large or slow, or you have multiple filters that you want to adjust before the dashboard refreshes its results, you may want to tell Metabase when to apply those filters and refresh the dashboard.
312312

313-
To turn off the automatic application of filters:
313+
To turn off the automatic application of filters.
314314

315-
1. View the dashboard (not in edit mode) and click the three-dot menu **...**.
315+
1. Click on the three-dot menu **...**.
316316
2. Select **Edit settings**.
317317
3. In the **General** section, toggle off **Auto-apply filters**.
318318

@@ -322,7 +322,7 @@ With auto-apply turned off, each time you change a value in a filter, you'll nee
322322

323323
## Using filter widgets
324324

325-
Once you've added a filter to your dashboard, click the filter widget to select a value and activate the filter. To stop filtering, click the blue X.
325+
Once you've added a filter to your dashboard, just click on the filter widget to select a value and activate the filter. To stop filtering, just click the blue X.
326326

327327
Your active filter will only apply to your view of the dashboard. If someone else is viewing the same dashboard link at the same time, they won't see your filter.
328328

2.92 KB
Loading
66.9 KB
Loading
-19.1 KB
Loading
-10.6 KB
Loading

_docs/master/data-modeling/json-unfolding.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,8 @@ For example, if you upload a CSV with JSON in it, you might need to update the d
7373

7474
## Databases that support JSON unfolding
7575

76-
- [BigQuery](../databases/connections/postgresql): automatically enabled, applies to `STRUCT` types only.
77-
78-
If your data is stored in the [STRUCT data type](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#struct_type) in BigQuery, you can query the table's nested fields. This is enabled by default. However, Metabase won't unfold JSON stored in BigQuery as the `JSON` type. This is because in BigQuery, nested fields are _part of the table definition itself_, so when Metabase syncs with your BigQuery database, it'll be able to get metadata about any of your tables, including tables with nested fields. Querying nested fields, however, doesn't extend to arrays (REPEATED (STRUCT)) in BigQuery.
79-
80-
- [Druid (JDBC)](../databases/connections/druid)
81-
- [MongoDB](../databases/connections/mysql): automatically enabled for all nested fields.
82-
- [MySQL](../databases/connections/mysql)
8376
- [PostgreSQL](../databases/connections/postgresql)
77+
- [MySQL](../databases/connections/mysql)
78+
- [Druid (JDBC)](../databases/connections/druid)
79+
80+
A note on [BigQuery](../databases/connections/bigquery): Metabase supports the [STRUCT data type](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#struct_type) in BigQuery, but it won't unfold JSON stored in BigQuery as the `JSON` type. If your data is stored in the `STRUCT` type in BigQuery, you can query the table's nested fields. Some background here: BigQuery differs from other databases in that nested fields are _part of the table definition itself_. So when Metabase syncs with your BigQuery database, it'll be able to get metadata about any of your tables, including tables with nested fields. Querying nested fields, however, doesn't extend to arrays (REPEATED (STRUCT)) in BigQuery.

_docs/master/databases/connections/athena.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -216,14 +216,6 @@ If Metabase also needs to create tables, you'll need additional AWS Glue permiss
216216

217217
There aren't (yet) any model features available for Athena.
218218

219-
## Database routing
220-
221-
With database routing, an admin can build a question once using a single data connection, and the question will run its query against a different data connection with the same schema depending on who is viewing the question.
222-
223-
Admittedly, the name "database routing" is misleading for Athena, because the term "database" in Athena is closer to "schema" in other databases. You _can't_ use database routing to route queries between different _databases_ in Athena, but you _can_ route between different data _connections_, e.g., different regions or buckets, or different IAM users, or different data sources/catalogs.
224-
225-
See [Database routing](../../permissions/database-routing).
226-
227219
## Danger zone
228220

229221
See [Danger Zone](../danger-zone).

_docs/master/databases/connections/bigquery.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -170,8 +170,6 @@ There aren't (yet) any model features available for BigQuery.
170170

171171
## Database routing
172172

173-
With database routing, an admin can build a question once using one database, and the question will run its query against a different database with the same schema depending on who is viewing the question.
174-
175173
Database routing for BigQuery works between BigQuery **projects** with identical schemas.
176174

177175
See [Database routing](../../permissions/database-routing).

_docs/master/databases/connections/databricks.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,6 @@ A fingerprinting query examines the first 10,000 rows from each column and uses
108108

109109
There aren't (yet) any model features available for Databricks.
110110

111-
## Database routing
112-
113-
With database routing, an admin can build a question once using one database, and the question will run its query against a different database with the same schema depending on who is viewing the question.
114-
115-
When **multi-catalog is not enabled**, you can route between catalogs on the same host. If multi-catalog is enabled, then you can only route between databases on separate hosts.
116-
117-
See [Database routing](../../permissions/database-routing).
118-
119111
## Danger zone
120112

121113
See [Danger zone](../danger-zone).

0 commit comments

Comments
 (0)