Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#77760)

github-automation-metabase16a8399a5ca9
diff --git a/docs/api.json b/docs/api.json
index 6482b665f21..b1c9e700fc9 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -8684,6 +8684,9 @@
"lib/stage-metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
+ "pivot" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.pivot"
+ },
"breakout" : {
"$ref" : "#/components/schemas/metabase.lib.schema.breakouts"
},
@@ -9884,7 +9887,7 @@
"metabase.lib.schema.metadata..column.source" : {
"description" : "`:lib/source` -- where a column came from with respect to the current stage.\n\n Traditionally, `:lib/source` meant something slightly different -- it denoted what part of the current stage a\n column came from, and thus included two additional options -- `:source/fields`, for columns used by `:fields`, and\n `:source/breakouts`, for columns used in `:breakout`. This was not really useful information and made `:lib/source`\n itself useless for determining if a column was 'inherited' or not (i.e., whether it came from a previous stage,\n source card, or a join, and should get field name refs instead of field ID refs --\n see [[metabase.lib.field.util/inherited-column?]]).",
"type" : "string",
- "enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable" ]
+ "enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable", "source/pivot-grouping" ]
},
"metabase.lib.schema.metadata..column.validate-for-source" : {
"description" : "Do additional validation for column metadata based on `:lib/source`.",
@@ -9904,6 +9907,8 @@
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-expressions"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-pivot-grouping"
}, { } ]
},
"metabase.lib.schema.metadata..column.validate-for-source-aggregations" : {
@@ -9924,6 +9929,9 @@
"metabase.lib.schema.metadata..column.validate-for-source-native" : {
"allOf" : [ ]
},
+ "metabase.lib.schema.metadata..column.validate-for-source-pivot-grouping" : {
+ "allOf" : [ ]
+ },
"metabase.lib.schema.metadata..column.validate-for-source-previous-stage" : {
"allOf" : [ ]
},
@@ -11091,6 +11099,32 @@
"type" : "string",
"enum" : [ "none", "number", "text", "date", "boolean", "date/single", "id", "category", "location/city", "location/state", "location/zip_code", "location/country", "date/range", "date/month-year", "date/quarter-year", "date/relative", "date/all-options", "temporal-unit", "number/!=", "number/<=", "number/=", "number/>=", "number/between", "string/!=", "string/=", "string/contains", "string/does-not-contain", "string/ends-with", "string/starts-with", "boolean/=" ]
},
+ "metabase.lib.schema.pivot" : {
+ "description" : "Pivot intent. `:rows` and `:columns` are sequences of UUIDs that reference `:lib/uuid` values on breakouts of the\n stage that carries this clause. `:show-row-totals` and `:show-column-totals` default to `true` when absent.",
+ "type" : "object",
+ "properties" : {
+ "columns" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ }
+ },
+ "rows" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ }
+ },
+ "show-column-totals" : {
+ "type" : "boolean"
+ },
+ "show-row-totals" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "rows", "columns" ]
+ },
+ "metabase.lib.schema.pivot-only-on-last-stage" : { },
"metabase.lib.schema.query" : {
"allOf" : [ {
"description" : "Valid MBQL 5 query.",
@@ -11138,6 +11172,8 @@
"required" : [ "stages" ]
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.pivot-only-on-last-stage"
}, {
"allOf" : [ ]
} ]
@@ -14033,6 +14069,8 @@
"required" : [ "lib/metadata", "stages" ]
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.util.unique-uuids"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.pivot-only-on-last-stage"
}, {
"allOf" : [ ]
} ]
@@ -15439,7 +15477,7 @@
"put" : {
"operationId" : "put-api-agent-v1-dashboard-id",
"summary" : "PUT /api/agent/v1/dashboard/{id}",
- "description" : "Update a dashboard. Patch semantics - only fields you pass are changed.\n\n Metadata: `name`, `description`, `collection_id`, `archived`. Dashcard mutations\n are submitted under `dashcards` as a list of\n `{action: add|add_heading|add_text|update_text|remove|move, ...}` entries applied in\n order. `add` requires `card_id`; `add_heading` and `add_text` require `text` (Markdown\n for text cards); `update_text`, `remove`, and `move` require `dashcard_id`.",
+ "description" : "Update a dashboard. Patch semantics - only fields you pass are changed.\n\n Metadata: `name`, `description`, `collection_id`, `archived`. Archiving is a soft delete - there\n is no delete endpoint. It can be reversed by setting `archived: false`.\n Dashcard mutations are submitted under `dashcards` as a list of\n `{action: add|add_heading|add_text|update_text|remove|move, ...}` entries applied in\n order. `add` requires `card_id`; `add_heading` and `add_text` require `text` (Markdown\n for text cards); `update_text`, `remove`, and `move` require `dashcard_id`.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -15706,7 +15744,7 @@
"put" : {
"operationId" : "put-api-agent-v1-question-id",
"summary" : "PUT /api/agent/v1/question/{id}",
- "description" : "Update a saved question (card). Patch semantics - only fields that you pass are changed.\n\n Set `collection_id` to move the card to a different collection. Set `archived: true` to archive.\n Pass `query` (a query_handle from construct_query or construct_native_query, or a base64 query\n string) to replace the underlying query. Replacing it with a native (raw SQL) query requires\n native-query permission on the target database.",
+ "description" : "Update a saved question (card). Patch semantics - only fields that you pass are changed.\n\n Set `collection_id` to move the card to a different collection. Set `archived: true` to archive.\n Archiving is a soft delete - there is no delete endpoint. It can be reversed by setting\n `archived: false`.\n Pass `query` (a query_handle from construct_query or construct_native_query, or a base64 query\n string) to replace the underlying query. Replacing it with a native (raw SQL) query requires\n native-query permission on the target database.",
"parameters" : [ {
"in" : "path",
"name" : "id",
@@ -25574,7 +25612,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered" ]
+ "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered", "dwh-rent", "etl-connections" ]
}
} ],
"responses" : {
@@ -25625,7 +25663,7 @@
"required" : true,
"schema" : {
"type" : "string",
- "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered" ]
+ "enum" : [ "metabase-ai", "metabase-ai-tiered", "metabase-ai-managed", "python-execution", "transforms", "transforms-basic", "transforms-advanced", "transforms-basic-metered", "transforms-advanced-metered", "dwh-rent", "etl-connections" ]
}
} ],
"responses" : {
@@ -35153,6 +35191,40 @@
"tags" : [ "/api/embed" ]
}
},
+ "/api/eval-trace/{session-id}" : {
+ "get" : {
+ "operationId" : "get-api-eval-trace-session-id",
+ "summary" : "GET /api/eval-trace/{session-id}",
+ "description" : "Return the captured eval trace as JSONL (one span per line) for `session-id`. Superuser-only;\n served only when `MB_AI_EVAL_CAPTURE` is enabled.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "session-id",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1,
+ "maxLength" : 200
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : { }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/eval-trace" ]
+ }
+ },
"/api/field/table-ids" : {
"post" : {
"operationId" : "post-api-field-table-ids",
@@ -37501,14 +37573,29 @@
"schema" : {
"type" : "object",
"properties" : {
+ "message" : {
+ "type" : "string",
+ "minLength" : 1
+ },
+ "metabot_id" : {
+ "type" : "string"
+ },
+ "eval_session_id" : {
+ "oneOf" : [ {
+ "allOf" : [ {
+ "type" : "string",
+ "maxLength" : 200
+ }, {
+ "type" : "string",
+ "pattern" : "\\A[A-Za-z0-9][A-Za-z0-9._-]*\\z"
+ } ]
+ }, {
+ "type" : "null"
+ } ]
+ },
"context" : {
"$ref" : "#/components/schemas/metabase.metabot.context.context"
},
- "conversation_id" : {
- "description" : "value must be a valid UUID.",
- "type" : "string",
- "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
- },
"debug" : {
"oneOf" : [ {
"type" : "boolean"
@@ -37516,6 +37603,9 @@
"type" : "null"
} ]
},
+ "profile_id" : {
+ "type" : "string"
+ },
"history" : {
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.metabot.schema.messages"
@@ -37523,15 +37613,10 @@
"type" : "null"
} ]
},
- "message" : {
+ "conversation_id" : {
+ "description" : "value must be a valid UUID.",
"type" : "string",
- "minLength" : 1
- },
- "metabot_id" : {
- "type" : "string"
- },
- "profile_id" : {
- "type" : "string"
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
},
"state" : {
"type" : "object",
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 5b94cf97ab1..c442af7ed52 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -242,6 +242,7 @@ config:
persisted-model-refresh-cron-schedule: 0 0 0/6 * * ? *
persisted-models-enabled: false
premium-embedding-token: null
+ query-caching-max-concurrent-writes: 0
query-caching-max-kb: 2000
query-caching-max-ttl: 3024000.0
queue-backend: quartz
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 600f6bf5e06..fae41b17a02 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -1580,6 +1580,15 @@ Allow persisting models into the source database.
Token for premium features. Go to the MetaStore to get yours!
+### `MB_QUERY_CACHING_MAX_CONCURRENT_WRITES`
+
+- Type: integer
+- Default: `0`
+
+Maximum number of queries that can write their results to the query cache at the same time; 0 means no limit. Queries over the limit run normally but skip caching that run, bounding the CPU and memory spent storing results during a burst of cache misses. Each concurrent write buffers a result capped by query-caching-max-kb (2 MB by default), so e.g. a limit of 32 bounds the worst-case burst cost at roughly 200 MB including growth transients.
+
+Maximum number of queries that can write their results to the query cache at the same time; 0 (the default) means no limit. Queries over the limit run normally but skip caching that run, bounding the CPU and memory spent storing results during a burst of cache misses. E.g. a limit of 32 bounds the worst-case burst cost at roughly 200 MB.
+
### `MB_QUERY_CACHING_MAX_KB`
- Type: integer