Skip to content

Commit b4fe053

Browse files
github-automation-metabaseMetabase Docs bot
github-automation-metabase
and
Metabase Docs bot
authored
[auto] adding content to master->master (#735)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent 0c56cb9 commit b4fe053

File tree

298 files changed

+401
-317
lines changed

Some content is hidden

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

298 files changed

+401
-317
lines changed

‎_docs/master/api.html‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17120,7 +17120,7 @@
1712017120
"parameters" : [ ],
1712117121
"responses" : {
1712217122
"2XX" : {
17123-
"description" : "map where {:logs -> <string>, :error (optional) -> <map where {:message -> <function, or function>}>, :output (optional) -> <map where {:rows -> <anything>}>}",
17123+
"description" : "map where {:logs -> <string>, :error (optional) -> <map where {:message -> <function, or function>}>, :output (optional) -> <map where {:cols -> <sequence of map where {:name -> <string>}>, :rows -> <sequence of anything>}>}",
1712417124
"content" : {
1712517125
"application/json" : {
1712617126
"schema" : {
@@ -17141,9 +17141,24 @@
1714117141
"output" : {
1714217142
"type" : "object",
1714317143
"properties" : {
17144-
"rows" : { }
17144+
"cols" : {
17145+
"type" : "array",
17146+
"items" : {
17147+
"type" : "object",
17148+
"properties" : {
17149+
"name" : {
17150+
"type" : "string"
17151+
}
17152+
},
17153+
"required" : [ "name" ]
17154+
}
17155+
},
17156+
"rows" : {
17157+
"type" : "array",
17158+
"items" : { }
17159+
}
1714517160
},
17146-
"required" : [ "rows" ]
17161+
"required" : [ "cols", "rows" ]
1714717162
}
1714817163
},
1714917164
"required" : [ "logs" ]

‎_docs/master/developers-guide/api-changelog.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ layout: new-docs
1111

1212
# Breaking changes to the API interface
1313

14+
## Metabase 0.57.0
15+
16+
- MBQL queries (in Cards and elsewhere) are now serialized as MBQL 5 as opposed to MBQL 4 (aka legacy MBQL) in the
17+
application database and in REST API responses. While we do not officially support editing or introspection of MBQL
18+
via the REST API (please treat it as an opaque object), to support existing usages the `GET /api/card/:id` endpoint
19+
can return the Card `dataset_query` as MBQL 4 if you include the query parameter `?legacy-mbql=true`.
20+
1421
## Metabase 0.55.0
1522

1623
- `POST /api/card/from-csv` has been renamed to `POST /api/upload/csv`.

‎_docs/master/developers-guide/driver-changelog.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ layout: new-docs
5151

5252
- Removed `driver/set-database-used`. Drivers should set default databases in their connection specs instead.
5353

54+
- `metabase.driver.common.table-rows-sample/table-rows-sample`'s optional `:order-by` option should now be something
55+
you can pass to [[metabase.lib.core/order-by]] -- for example a Lib `:metadata/column` or an [MBQL 5]
56+
`metabase.driver-api.core/order-by-clause`.
57+
5458
## Metabase 0.56.3
5559

5660
- Added the driver multi-method `driver/describe-database*` that drivers should now implement instead of `driver/describe-database`.

‎_docs/master/embedding/sdk/api/MetabaseClickActionPluginsConfig.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99
layout: docs-api
1010
---
1111

12-
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MetabaseClickActionPluginsConfig | Embedded analytics SDK API</title><link rel="icon" href="assets/favicon.ico"/>{% include docs/embedded-analytics-sdk-metadata.html %}<meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script defer src="assets/main.js"></script><script defer src="assets/custom.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Embedded analytics SDK API</a><div id="tsd-toolbar-links"><a href="javascript:navigateBack({ fallbackUrl: '/docs/master/embedding/sdk/introduction' })">Back to documentation</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">MetabaseClickActionPluginsConfig</a></li></ul><h1>Type Alias MetabaseClickActionPluginsConfig</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">MetabaseClickActionPluginsConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">clickActions</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">clickedDataPoint</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseDataPointObject.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDataPointObject</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">clickActions</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">clickedDataPoint</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseDataPointObject.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDataPointObject</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">clickActions</span>: <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">clickedDataPoint</span>: <a href="MetabaseDataPointObject.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDataPointObject</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span></h4></li></ul></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="javascript:navigateBack({ fallbackUrl: '/docs/master/embedding/sdk/introduction' })" class="tsd-nav-link">Back to documentation</a></nav><nav class="tsd-navigation"><a href="index.html">Embedded analytics SDK API</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p><script type="text/javascript" src="/gdpr-cookie-notice/dist/script.js"></script><script type="text/javascript" src="/js/cookie-consent.js"></script><link href="/gdpr-cookie-notice/dist/style.css" rel="stylesheet" /><link href="/css/gdpr.css" rel="stylesheet" /></p></footer><div class="overlay"></div></body></html>
12+
<!DOCTYPE html><html class="default" lang="en" data-base="./"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MetabaseClickActionPluginsConfig | Embedded analytics SDK API</title><link rel="icon" href="assets/favicon.ico"/>{% include docs/embedded-analytics-sdk-metadata.html %}<meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><link rel="stylesheet" href="assets/custom.css"/><script defer src="assets/main.js"></script><script defer src="assets/custom.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="index.html" class="title">Embedded analytics SDK API</a><div id="tsd-toolbar-links"><a href="javascript:navigateBack({ fallbackUrl: '/docs/master/embedding/sdk/introduction' })">Back to documentation</a></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="" aria-current="page">MetabaseClickActionPluginsConfig</a></li></ul><h1>Type Alias MetabaseClickActionPluginsConfig</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">MetabaseClickActionPluginsConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">clickActions</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">clickedDataPoint</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseDataPointObject.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDataPointObject</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">onClick</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature" id="__type"><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">clickActions</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">clickedDataPoint</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseDataPointObject.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDataPointObject</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">onClick</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">}</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">clickActions</span>: <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">clickedDataPoint</span>: <a href="MetabaseDataPointObject.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseDataPointObject</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="MetabaseClickAction.html" class="tsd-signature-type tsd-kind-type-alias">MetabaseClickAction</a><span class="tsd-signature-symbol">[]</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">onClick</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">}</span></h4></li></ul></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="javascript:navigateBack({ fallbackUrl: '/docs/master/embedding/sdk/introduction' })" class="tsd-nav-link">Back to documentation</a></nav><nav class="tsd-navigation"><a href="index.html">Embedded analytics SDK API</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p><script type="text/javascript" src="/gdpr-cookie-notice/dist/script.js"></script><script type="text/javascript" src="/js/cookie-consent.js"></script><link href="/gdpr-cookie-notice/dist/style.css" rel="stylesheet" /><link href="/css/gdpr.css" rel="stylesheet" /></p></footer><div class="overlay"></div></body></html>

0 commit comments

Comments
 (0)