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 (#70689)

github-automation-metabase03dd34ec4a04
diff --git a/docs/api.json b/docs/api.json
index 6fdf396c4ff..3eb1b347564 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -5220,6 +5220,179 @@
},
"required" : [ "model-type", "model-id", "decision", "segment", "message", "data", "suggestions" ]
},
+ "metabase-enterprise.replacement.schema.check-replace-source-response" : {
+ "type" : "object",
+ "properties" : {
+ "column_mappings" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column-mapping"
+ }
+ },
+ "errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.error-type"
+ }
+ },
+ "success" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "success" ]
+ },
+ "metabase-enterprise.replacement.schema.column" : {
+ "type" : "object",
+ "properties" : {
+ "base_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "display_name" : {
+ "type" : "string"
+ },
+ "effective_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.field"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "semantic_type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "display_name", "base_type", "effective_type", "semantic_type" ]
+ },
+ "metabase-enterprise.replacement.schema.column-mapping" : {
+ "type" : "object",
+ "properties" : {
+ "errors" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.source-swap.schema.column-error"
+ }
+ },
+ "source" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.column"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }
+ },
+ "metabase-enterprise.replacement.schema.error-type" : {
+ "type" : "string",
+ "enum" : [ "cycle-detected", "database-mismatch", "incompatible-implicit-joins" ]
+ },
+ "metabase-enterprise.replacement.schema.run" : {
+ "type" : "object",
+ "properties" : {
+ "message" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "user_id" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.user"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "progress" : {
+ "oneOf" : [ {
+ "type" : "number"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "target_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ },
+ "is_active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ },
+ "source_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ },
+ "status" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-status"
+ },
+ "source_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "end_time" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "format" : "date-time"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "start_time" : {
+ "type" : "string",
+ "format" : "date-time"
+ }
+ },
+ "required" : [ "id", "status", "is_active", "source_entity_type", "source_entity_id", "target_entity_type", "target_entity_id", "progress", "message", "user_id", "start_time", "end_time" ]
+ },
+ "metabase-enterprise.replacement.schema.run-id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "metabase-enterprise.replacement.schema.run-status" : {
+ "type" : "string",
+ "enum" : [ "pending", "started", "succeeded", "failed", "canceled", "timeout" ]
+ },
+ "metabase-enterprise.replacement.schema.source-entity-id" : {
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ } ]
+ },
+ "metabase-enterprise.replacement.schema.source-entity-type" : {
+ "type" : "string",
+ "enum" : [ "card", "table" ]
+ },
"metabase-enterprise.sandbox.schema.attribute-remappings" : {
"description" : "value must be a valid attribute remappings map (attribute name -> remapped name)",
"oneOf" : [ {
@@ -6347,79 +6520,214 @@
"required" : [ "type", "multiplier", "min_duration_ms" ],
"additionalProperties" : false
},
- "metabase.cache.api.cache-strategy" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee"
- }, {
- "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.oss"
- } ]
- },
- "metabase.channel.models.channel.Channel" : {
- "description" : "Channel schema.",
+ "metabase.cache.api.cache-config-item" : {
"type" : "object",
"properties" : {
- "active" : {
- "type" : "boolean"
- },
- "description" : {
+ "collection" : {
"oneOf" : [ {
- "type" : "string"
+ "type" : "object",
+ "properties" : {
+ "authority_level" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "type" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name" ]
}, {
"type" : "null"
} ]
},
- "details" : {
- "type" : "object",
- "properties" : { }
+ "model" : {
+ "type" : "string",
+ "enum" : [ "root", "database", "dashboard", "question" ]
+ },
+ "model_id" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
},
"name" : {
- "type" : "string"
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
},
- "type" : {
- "type" : "string"
+ "strategy" : {
+ "type" : "object",
+ "properties" : {
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "type" ]
}
},
- "required" : [ "name", "type", "details" ]
+ "required" : [ "model", "model_id", "strategy" ]
},
- "metabase.channel.models.channel.ChannelTemplate" : {
- "description" : "Channel Template schema.",
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "channel_type" : { },
- "details" : {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetails"
+ "metabase.cache.api.cache-config-list-response" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.cache.api.cache-config-item"
}
},
- "required" : [ "channel_type", "details" ]
- }, { } ]
- },
- "metabase.channel.models.channel.ChannelTemplateEmailDetails" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : {
- "path" : {
- "type" : "string"
- },
- "recipient-type" : {
- "enum" : [ "cc", "bcc", "cc", "bcc" ]
- },
- "subject" : {
- "type" : "string"
- },
- "type" : {
- "enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
- }
+ "limit" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
},
- "required" : [ "type", "subject", "path" ]
- }, {
- "type" : "object",
- "properties" : {
- "body" : {
- "type" : "string"
- },
- "recipient-type" : {
- "enum" : [ "cc", "bcc", "cc", "bcc" ]
+ "offset" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "data" ]
+ },
+ "metabase.cache.api.cache-config-store-response" : {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }
+ },
+ "required" : [ "id" ]
+ },
+ "metabase.cache.api.cache-invalidate-response" : {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "object",
+ "properties" : {
+ "count" : {
+ "type" : "integer"
+ },
+ "message" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "count", "message" ]
+ },
+ "status" : {
+ "type" : "integer",
+ "enum" : [ 200, 404 ]
+ }
+ },
+ "required" : [ "status", "body" ]
+ },
+ "metabase.cache.api.cache-strategy" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.ee"
+ }, {
+ "$ref" : "#/components/schemas/metabase.cache.api..cache-strategy.oss"
+ } ]
+ },
+ "metabase.channel.models.channel.Channel" : {
+ "description" : "Channel schema.",
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "type" : "boolean"
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "details" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "type" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "name", "type", "details" ]
+ },
+ "metabase.channel.models.channel.ChannelTemplate" : {
+ "description" : "Channel Template schema.",
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "channel_type" : { },
+ "details" : {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.ChannelTemplateEmailDetails"
+ }
+ },
+ "required" : [ "channel_type", "details" ]
+ }, { } ]
+ },
+ "metabase.channel.models.channel.ChannelTemplateEmailDetails" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "path" : {
+ "type" : "string"
+ },
+ "recipient-type" : {
+ "enum" : [ "cc", "bcc", "cc", "bcc" ]
+ },
+ "subject" : {
+ "type" : "string"
+ },
+ "type" : {
+ "enum" : [ "email/handlebars-resource", "email/handlebars-text", "email/handlebars-resource", "email/handlebars-text" ]
+ }
+ },
+ "required" : [ "type", "subject", "path" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "string"
+ },
+ "recipient-type" : {
+ "enum" : [ "cc", "bcc", "cc", "bcc" ]
},
"subject" : {
"type" : "string"
@@ -9485,91 +9793,299 @@
"description" : "schema for a valid MBQL 4 :value clause",
"allOf" : [ ]
},
- "metabase.lib.metadata.protocols.metadata-provider" : {
- "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
- },
- "metabase.lib.schema..stage.additional" : {
- "oneOf" : [ { }, { } ]
- },
- "metabase.lib.schema..stage.common" : {
+ "metabase.lib-metric.schema..dimension-reference.options" : {
+ "description" : "Options map for dimension references.",
"type" : "object",
"properties" : {
- "lib/stage-metadata" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
+ "binning" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.binning"
+ }, {
+ "type" : "null"
+ } ]
},
- "parameters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ "display-name" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "effective-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.base-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "semantic-type" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "temporal-unit" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib.schema.temporal-bucketing.unit"
+ }, {
+ "type" : "null"
+ } ]
}
}
},
- "metabase.lib.schema..stage.initial" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, { } ]
- },
- "metabase.lib.schema..stage.mbql" : {
+ "metabase.lib-metric.schema.binning" : {
+ "description" : "Schema for `:binning` options passed to a `:dimension` clause.",
"allOf" : [ {
"type" : "object",
"properties" : {
- "source-card" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
- },
- "lib/type" : {
- "const" : "mbql.stage/mbql"
- },
- "lib/stage-metadata" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
- },
- "breakout" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.breakouts"
- },
- "filters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.filters"
- },
- "limit" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.int-greater-than-or-equal-to-zero"
- },
- "joins" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.join.joins"
- },
- "aggregation" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.aggregation.aggregations"
- },
- "fields" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.fields"
- },
- "source-table" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
- },
- "order-by" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.order-by.order-bys"
+ "strategy" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.binning-strategy"
+ }
+ },
+ "required" : [ "strategy" ]
+ }, {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "strategy" : {
+ "const" : "default"
+ }
},
- "page" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.page"
+ "required" : [ "strategy" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "bin-width" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.positive-number"
+ },
+ "strategy" : {
+ "const" : "bin-width"
+ }
},
- "parameters" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ "required" : [ "strategy", "bin-width" ]
+ }, {
+ "type" : "object",
+ "properties" : {
+ "num-bins" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "strategy" : {
+ "const" : "num-bins"
+ }
},
- "expressions" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.expression.expressions"
- }
- },
- "required" : [ "lib/type" ]
+ "required" : [ "strategy", "num-bins" ]
+ } ]
+ } ]
+ },
+ "metabase.lib-metric.schema.binning-strategy" : {
+ "type" : "string",
+ "enum" : [ "bin-width", "default", "num-bins" ]
+ },
+ "metabase.lib-metric.schema.dimension-id" : {
+ "description" : "UUID string identifying a dimension.",
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.uuid"
+ },
+ "metabase.lib-metric.schema.dimension-reference" : {
+ "description" : "Dimension reference clause [:dimension opts uuid].\n Handles normalization from JSON where the tag arrives as a string.",
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "dimension"
}, {
- "$ref" : "#/components/schemas/metabase.lib.schema..stage.valid-refs"
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema..dimension-reference.options"
}, {
- "allOf" : [ ]
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-id"
} ]
},
- "metabase.lib.schema..stage.native" : {
- "allOf" : [ {
- "type" : "object",
- "properties" : {
- "collection" : {
- "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
- },
- "lib/stage-metadata" : {
+ "metabase.lib-metric.schema.expression-leaf" : {
+ "description" : "A leaf node in a metric math expression: either a metric or measure reference.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.metric-expression-ref"
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.measure-expression-ref"
+ } ]
+ },
+ "metabase.lib-metric.schema.filter-clause" : {
+ "description" : "MBQL filter clause with normalization for API input.\n Handles string operators and dimension references."
+ },
+ "metabase.lib-metric.schema.instance-filter" : {
+ "description" : "A filter associated with a specific expression instance via lib/uuid.",
+ "type" : "object",
+ "properties" : {
+ "filter" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.filter-clause"
+ },
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "lib/uuid", "filter" ]
+ },
+ "metabase.lib-metric.schema.instance-filters" : {
+ "description" : "A sequence of per-instance filters.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.instance-filter"
+ }
+ },
+ "metabase.lib-metric.schema.measure-expression-ref" : {
+ "description" : "A measure reference in an expression: [:measure {:lib/uuid uuid} measure-id].",
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "measure"
+ }, {
+ "type" : "object",
+ "properties" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ }, {
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ },
+ "metabase.lib-metric.schema.metric-expression-ref" : {
+ "description" : "A metric reference in an expression: [:metric {:lib/uuid uuid} card-id].",
+ "type" : "array",
+ "prefixItems" : [ {
+ "const" : "metric"
+ }, {
+ "type" : "object",
+ "properties" : {
+ "lib/uuid" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ }
+ },
+ "required" : [ "lib/uuid" ]
+ }, {
+ "type" : "integer",
+ "minimum" : 1
+ } ]
+ },
+ "metabase.lib-metric.schema.metric-math-expression" : {
+ "description" : "A recursive metric math expression tree.\n Can be a leaf (metric/measure ref) or an arithmetic expression [op opts expr expr ...]\n with at least 2 operands.\n Note: uses :fn validator for arithmetic to avoid Malli's recursive seqex limitation.",
+ "anyOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.expression-leaf"
+ }, {
+ "type" : "array"
+ } ]
+ },
+ "metabase.lib-metric.schema.typed-projection" : {
+ "description" : "A projection associated with a specific source type and ID.",
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "projection" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.dimension-reference"
+ }
+ },
+ "type" : {
+ "type" : "string",
+ "enum" : [ "metric", "measure" ]
+ }
+ },
+ "required" : [ "type", "id", "projection" ]
+ },
+ "metabase.lib-metric.schema.typed-projections" : {
+ "description" : "A sequence of typed projections.",
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.typed-projection"
+ }
+ },
+ "metabase.lib.metadata.protocols.metadata-provider" : {
+ "description" : "Schema for something that satisfies the [[metabase.lib.metadata.protocols/MetadataProvider]] protocol."
+ },
+ "metabase.lib.schema..stage.additional" : {
+ "oneOf" : [ { }, { } ]
+ },
+ "metabase.lib.schema..stage.common" : {
+ "type" : "object",
+ "properties" : {
+ "lib/stage-metadata" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
+ },
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ }
+ }
+ },
+ "metabase.lib.schema..stage.initial" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, { } ]
+ },
+ "metabase.lib.schema..stage.mbql" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "source-card" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.card"
+ },
+ "lib/type" : {
+ "const" : "mbql.stage/mbql"
+ },
+ "lib/stage-metadata" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
+ },
+ "breakout" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.breakouts"
+ },
+ "filters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.filters"
+ },
+ "limit" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.int-greater-than-or-equal-to-zero"
+ },
+ "joins" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.join.joins"
+ },
+ "aggregation" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.aggregation.aggregations"
+ },
+ "fields" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.fields"
+ },
+ "source-table" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.id.table"
+ },
+ "order-by" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.order-by.order-bys"
+ },
+ "page" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.page"
+ },
+ "parameters" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.parameter.parameters"
+ },
+ "expressions" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.expression.expressions"
+ }
+ },
+ "required" : [ "lib/type" ]
+ }, {
+ "$ref" : "#/components/schemas/metabase.lib.schema..stage.valid-refs"
+ }, {
+ "allOf" : [ ]
+ } ]
+ },
+ "metabase.lib.schema..stage.native" : {
+ "allOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "collection" : {
+ "$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
+ },
+ "lib/stage-metadata" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.stage"
},
"lib/type" : {
@@ -12581,10 +13097,33 @@
"type" : "string",
"enum" : [ "days", "hours", "minutes", "seconds", "milliseconds", "microseconds", "nanoseconds" ]
},
+ "metabase.measures.api.RemappedValueResponse" : {
+ "description" : "Response schema for dimension remapping endpoint.\n Returns [value] if no remapping, or [value, display-name] if remapped.",
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ { } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ { }, {
+ "type" : "string"
+ } ]
+ } ]
+ },
"metabase.measures.api.measure" : {
"description" : "Schema for a Measure entity as returned from the API.",
"type" : "object",
"properties" : {
+ "dimension_mappings" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"entity_id" : {
"oneOf" : [ {
"type" : "string"
@@ -12592,6 +13131,13 @@
"type" : "null"
} ]
},
+ "result_column_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
"id" : {
"description" : "value must be an integer greater than zero.",
"type" : "integer",
@@ -12612,6 +13158,17 @@
"archived" : {
"type" : "boolean"
},
+ "dimensions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"updated_at" : { },
"table_id" : {
"description" : "value must be an integer greater than zero.",
@@ -12638,51 +13195,288 @@
},
"required" : [ "id", "name", "table_id", "definition", "archived", "creator_id", "created_at", "updated_at" ]
},
- "metabase.notification.api.notification.NotificationApiInput" : {
- "description" : "Notification schema for API input. Like FullyHydratedNotification but restricts templates\n to user-provided types only (no handlebars-resource).",
- "oneOf" : [ {
- "oneOf" : [ {
+ "metabase.metrics.api.BreakoutValuesResponse" : {
+ "type" : "object",
+ "properties" : {
+ "col" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "values" : {
+ "type" : "array",
+ "items" : { }
+ }
+ },
+ "required" : [ "values", "col" ]
+ },
+ "metabase.metrics.api.DatasetRequest" : {
+ "description" : "Schema for POST /dataset request body.",
+ "type" : "object",
+ "properties" : {
+ "definition" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.Definition"
+ }
+ },
+ "required" : [ "definition" ]
+ },
+ "metabase.metrics.api.DatasetResponse" : {
+ "description" : "Schema for POST /dataset response.",
+ "type" : "object",
+ "properties" : {
+ "data" : {
"type" : "object",
"properties" : {
- "creator" : {
- "oneOf" : [ {
- "type" : "object",
- "properties" : { }
- }, {
- "type" : "null"
- } ]
+ "cols" : {
+ "type" : "array",
+ "items" : { }
},
- "handlers" : {
+ "rows" : {
"type" : "array",
- "items" : {
- "type" : "object",
- "properties" : {
- "active" : {
- "oneOf" : [ {
- "type" : "boolean"
- }, {
- "type" : "null"
- } ]
- },
- "channel" : {
- "oneOf" : [ {
- "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
- }, {
- "type" : "null"
- } ]
- },
- "channel_id" : {
- "oneOf" : [ {
- "description" : "value must be an integer greater than zero.",
- "type" : "integer",
- "minimum" : 1
- }, {
- "type" : "null"
- } ]
- },
- "channel_type" : { },
- "notification_id" : {
- "description" : "value must be an integer greater than zero.",
+ "items" : { }
+ }
+ },
+ "required" : [ "cols", "rows" ]
+ },
+ "row_count" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "status" : {
+ "enum" : [ "completed", "completed" ]
+ }
+ },
+ "required" : [ "status", "data", "row_count" ]
+ },
+ "metabase.metrics.api.Definition" : {
+ "description" : "Schema for the definition object within a dataset request.\n Uses expression-based contract for metric math support.",
+ "type" : "object",
+ "properties" : {
+ "expression" : {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.metric-math-expression"
+ },
+ "filters" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.instance-filters"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "projections" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.lib-metric.schema.typed-projections"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "expression" ]
+ },
+ "metabase.metrics.api.Metric" : {
+ "description" : "Schema for a Metric in list responses (without hydrated dimensions).",
+ "type" : "object",
+ "properties" : {
+ "collection" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name", "description", "collection_id" ]
+ },
+ "metabase.metrics.api.MetricWithDimensions" : {
+ "description" : "Schema for a Metric in list responses (without hydrated dimensions).",
+ "type" : "object",
+ "properties" : {
+ "dimension_mappings" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "name" : {
+ "type" : "string"
+ }
+ },
+ "required" : [ "id", "name" ]
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "dataset_query" : {
+ "type" : "object",
+ "properties" : { }
+ },
+ "result_column_name" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "id" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "dimensions" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "database_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "collection_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "description" : {
+ "oneOf" : [ {
+ "type" : "string"
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "id", "name", "description", "collection_id" ]
+ },
+ "metabase.metrics.api.RemappedValueResponse" : {
+ "description" : "Response schema for dimension remapping endpoint.\n Returns [value] if no remapping, or [value, display-name] if remapped.",
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ { } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ { }, {
+ "type" : "string"
+ } ]
+ } ]
+ },
+ "metabase.notification.api.notification.NotificationApiInput" : {
+ "description" : "Notification schema for API input. Like FullyHydratedNotification but restricts templates\n to user-provided types only (no handlebars-resource).",
+ "oneOf" : [ {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : {
+ "creator" : {
+ "oneOf" : [ {
+ "type" : "object",
+ "properties" : { }
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "handlers" : {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : {
+ "active" : {
+ "oneOf" : [ {
+ "type" : "boolean"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel" : {
+ "oneOf" : [ {
+ "$ref" : "#/components/schemas/metabase.channel.models.channel.Channel"
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_id" : {
+ "oneOf" : [ {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ }, {
+ "type" : "null"
+ } ]
+ },
+ "channel_type" : { },
+ "notification_id" : {
+ "description" : "value must be an integer greater than zero.",
"type" : "integer",
"minimum" : 1
},
@@ -14368,6 +15162,10 @@
},
"required" : [ "status", "row_count" ]
},
+ "metabase.source-swap.schema.column-error" : {
+ "type" : "string",
+ "enum" : [ "column-type-mismatch", "missing-primary-key", "missing-foreign-key", "foreign-key-mismatch" ]
+ },
"metabase.sync.schedules.ExpandedSchedulesMap" : {
"description" : "value must be a valid map of schedule maps for a DB.",
"type" : "object",
@@ -17663,7 +18461,14 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.cache.api.cache-config-list-response"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -17681,7 +18486,14 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.cache.api.cache-config-store-response"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -17723,7 +18535,14 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "null"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -17830,7 +18649,14 @@
} ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.cache.api.cache-invalidate-response"
+ }
+ }
+ }
},
"4XX" : {
"description" : "Client error response"
@@ -26636,8 +27462,70 @@
"parameters" : [ ],
"responses" : {
"2XX" : {
- "description" : "Successful response"
- },
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "checklist" : {
+ "type" : "object",
+ "properties" : {
+ "enable-tenants" : {
+ "type" : "boolean"
+ },
+ "create-models" : {
+ "type" : "boolean"
+ },
+ "sso-configured" : {
+ "type" : "boolean"
+ },
+ "configure-row-column-security" : {
+ "type" : "boolean"
+ },
+ "create-test-embed" : {
+ "type" : "boolean"
+ },
+ "data-permissions-and-enable-tenants" : {
+ "type" : "boolean"
+ },
+ "embed-production" : {
+ "type" : "boolean"
+ },
+ "create-dashboard" : {
+ "type" : "boolean"
+ },
+ "setup-data-segregation-strategy" : {
+ "type" : "boolean"
+ },
+ "create-tenants" : {
+ "type" : "boolean"
+ },
+ "add-data" : {
+ "type" : "boolean"
+ },
+ "sso-auth-manual-tested" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "add-data", "create-dashboard", "create-models", "configure-row-column-security", "create-test-embed", "embed-production", "sso-configured", "data-permissions-and-enable-tenants", "enable-tenants", "create-tenants", "setup-data-segregation-strategy", "sso-auth-manual-tested" ],
+ "additionalProperties" : false
+ },
+ "data-isolation-strategy" : {
+ "oneOf" : [ {
+ "type" : "string",
+ "enum" : [ "row-column-level-security", "connection-impersonation", "database-routing" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ },
+ "required" : [ "checklist", "data-isolation-strategy" ],
+ "additionalProperties" : false
+ }
+ }
+ }
+ },
"4XX" : {
"description" : "Client error response"
},
@@ -29814,6 +30702,198 @@
"tags" : [ "/api/ee/remote-sync" ]
}
},
+ "/api/ee/replacement/check-replace-source" : {
+ "post" : {
+ "operationId" : "post-api-ee-replacement-check-replace-source",
+ "summary" : "POST /api/ee/replacement/check-replace-source",
+ "description" : "Check whether a source entity can be replaced by a target entity. Returns compatibility\n errors describing column mismatches, type mismatches, primary key mismatches, and foreign\n key mismatches.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.check-replace-source-response"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "source_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "source_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ },
+ "target_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "target_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ }
+ },
+ "required" : [ "source_entity_id", "source_entity_type", "target_entity_id", "target_entity_type" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/replacement" ]
+ }
+ },
+ "/api/ee/replacement/replace-source" : {
+ "post" : {
+ "operationId" : "post-api-ee-replacement-replace-source",
+ "summary" : "POST /api/ee/replacement/replace-source",
+ "description" : "Replace all usages of a source entity with a target entity asynchronously.\n Returns 202 with a run_id for polling. Returns 409 if a replacement is already running.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "body" : {
+ "type" : "object",
+ "properties" : {
+ "run_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ }
+ },
+ "required" : [ "run_id" ],
+ "additionalProperties" : false
+ },
+ "status" : {
+ "const" : 202
+ }
+ },
+ "required" : [ "status", "body" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "source_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "source_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ },
+ "target_entity_id" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-id"
+ },
+ "target_entity_type" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.source-entity-type"
+ }
+ },
+ "required" : [ "source_entity_id", "source_entity_type", "target_entity_id", "target_entity_type" ]
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/ee/replacement" ]
+ }
+ },
+ "/api/ee/replacement/runs/{id}" : {
+ "get" : {
+ "operationId" : "get-api-ee-replacement-runs-id",
+ "summary" : "GET /api/ee/replacement/runs/{id}",
+ "description" : "Get the status of a source replacement run.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/replacement" ]
+ }
+ },
+ "/api/ee/replacement/runs/{id}/cancel" : {
+ "post" : {
+ "operationId" : "post-api-ee-replacement-runs-id-cancel",
+ "summary" : "POST /api/ee/replacement/runs/{id}/cancel",
+ "description" : "Cancel a running source replacement.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase-enterprise.replacement.schema.run-id"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "success" : {
+ "type" : "boolean"
+ }
+ },
+ "required" : [ "success" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/ee/replacement" ]
+ }
+ },
"/api/ee/scim/api_key" : {
"get" : {
"operationId" : "get-api-ee-scim-api_key",
@@ -36143,6 +37223,517 @@
"tags" : [ "/api/measure" ]
}
},
+ "/api/measure/{id}/dimension/{dimension-key}/remapping" : {
+ "get" : {
+ "operationId" : "get-api-measure-id-dimension-dimension-key-remapping",
+ "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/remapping",
+ "description" : "Fetch remapped value for a specific dimension value.\n\n Returns a pair [value, display-name] if remapping exists, or [value] otherwise.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "dimension-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.measures.api.RemappedValueResponse"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/measure" ]
+ }
+ },
+ "/api/measure/{id}/dimension/{dimension-key}/search" : {
+ "get" : {
+ "operationId" : "get-api-measure-id-dimension-dimension-key-search",
+ "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/search",
+ "description" : "Search for values of a dimension that contain the query string.\n\n Returns field values matching the search query in the same format as the field values API.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "dimension-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
+ }, {
+ "in" : "query",
+ "name" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/measure" ]
+ }
+ },
+ "/api/measure/{id}/dimension/{dimension-key}/values" : {
+ "get" : {
+ "operationId" : "get-api-measure-id-dimension-dimension-key-values",
+ "summary" : "GET /api/measure/{id}/dimension/{dimension-key}/values",
+ "description" : "Fetch values for a dimension of a measure.\n\n Returns field values in the same format as the field values API:\n - values: list of [value] or [value, display-name] tuples\n - field_id: the underlying field ID\n - has_more_values: boolean indicating if there are more values",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "dimension-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "has_more_values" : {
+ "type" : "boolean"
+ },
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ { }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ { } ]
+ } ]
+ }
+ }
+ },
+ "required" : [ "has_more_values", "values" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/measure" ]
+ }
+ },
+ "/api/metric" : {
+ "get" : {
+ "operationId" : "get-api-metric",
+ "summary" : "GET /api/metric",
+ "description" : "Get a list of metrics.\n\n Returns metrics (Cards with type='metric') that the current user has read access to,\n filtered by collection visibility permissions.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "data" : {
+ "type" : "array",
+ "items" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.Metric"
+ }
+ },
+ "limit" : {
+ "description" : "value must be an integer greater than zero.",
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "offset" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ },
+ "total" : {
+ "description" : "value must be an integer greater or equal to than zero.",
+ "type" : "integer",
+ "minimum" : 0
+ }
+ },
+ "required" : [ "total", "limit", "offset", "data" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/metric" ]
+ }
+ },
+ "/api/metric/breakout-values" : {
+ "post" : {
+ "operationId" : "post-api-metric-breakout-values",
+ "summary" : "POST /api/metric/breakout-values",
+ "description" : "Fetch distinct breakout dimension values for a metric or measure definition.\n Accepts the same definition format as POST /dataset.\n Returns extracted values and column metadata for the breakout dimension.",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.BreakoutValuesResponse"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.DatasetRequest"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metric" ]
+ }
+ },
+ "/api/metric/dataset" : {
+ "post" : {
+ "operationId" : "post-api-metric-dataset",
+ "summary" : "POST /api/metric/dataset",
+ "description" : "Execute a metric or measure-based query and stream the results.\n\n Request body requires a `definition` object containing:\n - expression: A metric math expression tree (leaf reference or arithmetic)\n Examples: [:metric {:lib/uuid \"a\"} 42], [:- {} [:metric {:lib/uuid \"a\"} 1] [:metric {:lib/uuid \"b\"} 2]]\n - filters (optional): Per-instance filters keyed by :lib/uuid from the expression\n - projections (optional): Typed projections keyed by source type and ID",
+ "parameters" : [ ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.DatasetResponse"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "requestBody" : {
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.DatasetRequest"
+ }
+ }
+ }
+ },
+ "tags" : [ "/api/metric" ]
+ }
+ },
+ "/api/metric/{id}" : {
+ "get" : {
+ "operationId" : "get-api-metric-id",
+ "summary" : "GET /api/metric/{id}",
+ "description" : "Fetch a `Metric` with ID.\n\n Returns the metric with hydrated dimensions and dimension mappings.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.MetricWithDimensions"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/metric" ]
+ }
+ },
+ "/api/metric/{id}/dimension/{dimension-key}/remapping" : {
+ "get" : {
+ "operationId" : "get-api-metric-id-dimension-dimension-key-remapping",
+ "summary" : "GET /api/metric/{id}/dimension/{dimension-key}/remapping",
+ "description" : "Fetch remapped value for a specific dimension value.\n\n Returns a pair [value, display-name] if remapping exists, or [value] otherwise.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "dimension-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
+ }, {
+ "in" : "query",
+ "name" : "value",
+ "required" : true,
+ "schema" : {
+ "type" : "string"
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "$ref" : "#/components/schemas/metabase.metrics.api.RemappedValueResponse"
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/metric" ]
+ }
+ },
+ "/api/metric/{id}/dimension/{dimension-key}/search" : {
+ "get" : {
+ "operationId" : "get-api-metric-id-dimension-dimension-key-search",
+ "summary" : "GET /api/metric/{id}/dimension/{dimension-key}/search",
+ "description" : "Search for values of a dimension that contain the query string.\n\n Returns field values matching the search query in the same format as the field values API.",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "dimension-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
+ }, {
+ "in" : "query",
+ "name" : "query",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "minLength" : 1
+ }
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "array",
+ "items" : {
+ "type" : "array",
+ "items" : {
+ "type" : "string"
+ }
+ }
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/metric" ]
+ }
+ },
+ "/api/metric/{id}/dimension/{dimension-key}/values" : {
+ "get" : {
+ "operationId" : "get-api-metric-id-dimension-dimension-key-values",
+ "summary" : "GET /api/metric/{id}/dimension/{dimension-key}/values",
+ "description" : "Fetch values for a dimension of a metric.\n\n Returns field values in the same format as the field values API:\n - values: list of [value] or [value, display-name] tuples\n - field_id: the underlying field ID\n - has_more_values: boolean indicating if there are more values",
+ "parameters" : [ {
+ "in" : "path",
+ "name" : "id",
+ "required" : true,
+ "schema" : {
+ "type" : "integer",
+ "minimum" : 1
+ },
+ "description" : "value must be an integer greater than zero."
+ }, {
+ "in" : "path",
+ "name" : "dimension-key",
+ "required" : true,
+ "schema" : {
+ "type" : "string",
+ "pattern" : "[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"
+ },
+ "description" : "value must be a valid UUID."
+ } ],
+ "responses" : {
+ "2XX" : {
+ "description" : "Successful response",
+ "content" : {
+ "application/json" : {
+ "schema" : {
+ "type" : "object",
+ "properties" : {
+ "has_more_values" : {
+ "type" : "boolean"
+ },
+ "values" : {
+ "type" : "array",
+ "items" : {
+ "anyOf" : [ {
+ "type" : "array",
+ "prefixItems" : [ { }, {
+ "type" : "string"
+ } ]
+ }, {
+ "type" : "array",
+ "prefixItems" : [ { } ]
+ } ]
+ }
+ }
+ },
+ "required" : [ "has_more_values", "values" ]
+ }
+ }
+ }
+ },
+ "4XX" : {
+ "description" : "Client error response"
+ },
+ "5XX" : {
+ "description" : "Server error response"
+ }
+ },
+ "tags" : [ "/api/metric" ]
+ }
+ },
"/api/model-index" : {
"post" : {
"operationId" : "post-api-model-index",
diff --git a/docs/configuring-metabase/config-template.md b/docs/configuring-metabase/config-template.md
index 2072e96df24..2aa619ab999 100644
--- a/docs/configuring-metabase/config-template.md
+++ b/docs/configuring-metabase/config-template.md
@@ -109,6 +109,7 @@ config:
can-run-adhoc-query-check-threshold: 250
check-for-updates: true
config-from-file-sync-databases: true
+ csv-field-separator: ','
custom-formatting: {}
custom-geojson: null
custom-geojson-enabled: true
@@ -292,6 +293,7 @@ config:
sync-leaf-fields-limit: 1000
synchronous-batch-updates: false
thread-interrupt-escalation-timeout-ms: 0
+ transform-timeout: 240
transforms-enabled: false
unaggregated-query-row-limit: null
uploads-settings: null
diff --git a/docs/configuring-metabase/environment-variables.md b/docs/configuring-metabase/environment-variables.md
index 47a5737186b..a9e96787ba6 100644
--- a/docs/configuring-metabase/environment-variables.md
+++ b/docs/configuring-metabase/environment-variables.md
@@ -316,6 +316,15 @@ Identify when new versions of Metabase are available.
Whether to (asynchronously) sync newly created Databases during config-from-file initialization. By default, true,
but you can disable this behavior if you want to sync it manually or use SerDes to populate its data model.
+### `MB_CSV_FIELD_SEPARATOR`
+
+- Type: string
+- Default: `,`
+- [Exported as](../installation-and-operation/serialization.md): `csv-field-separator`.
+- [Configuration file name](./config-file.md): `csv-field-separator`
+
+Character to use as field separator in CSV exports. Defaults to comma (,). Common alternatives include semicolon (;) for European locales and tab (\t).
+
### `MB_CUSTOM_FORMATTING`
- Type: json
@@ -388,9 +397,12 @@ Timeout in milliseconds for connecting to databases, both Metabase application d
By default, this is 20 minutes.
-Timeout in minutes for databases query execution, both Metabase application database and data connections.
- If you have long-running queries, you might consider increasing this value.
- Adjusting the timeout does not impact Metabase’s frontend.
+Timeout in minutes for the database's query execution, both for the Metabase application database and any data connections.
+ If you have long-running queries, you might consider increasing this value. Adjusting the timeout does not impact Metabase’s frontend.
+
+ This setting also applies to individual queries executed within transforms, so make sure the duration is long enough
+ that it doesn't timeout any long-running queries in your transforms.
+
Please be aware that other services (like Nginx) may still drop long-running queries.
### `MB_DEFAULT_MAPS_ENABLED`
@@ -945,7 +957,9 @@ String used to seed the private key used to validate JWT messages. A hexadecimal
- Default: `true`
- [Configuration file name](./config-file.md): `jwt-user-provisioning-enabled`
-When a user logs in via JWT, create a Metabase account for them automatically if they don't have one.
+Determines what happens when a user logs in via JWT and doesn't have a Metabase account.
+
+When set to `true`, users who log in via JWT will automatically get a Metabase account if they don't have one, or get their existing account reactivated. When set to `false`, only users with active Metabase accounts can log in via JWT.
### `MB_LANDING_PAGE`
@@ -1128,8 +1142,9 @@ User lookup filter. The placeholder '{login}' will be replaced by the user suppl
- Default: `true`
- [Configuration file name](./config-file.md): `ldap-user-provisioning-enabled`
-When we enable LDAP user provisioning, we automatically create a Metabase account on LDAP signin for users who
-don't have one.
+Determines what happens when a user logs in via LDAP and doesn't have a Metabase account.
+
+When set to `true`, users who log in via LDAP will automatically get a Metabase account if they don't have one, or get their existing account reactivated. When set to `false`, only users with active Metabase accounts can log in via LDAP.
### `MB_LICENSE_TOKEN_MISSING_BANNER_DISMISSAL_TIMESTAMP`
@@ -1332,7 +1347,9 @@ JSON containing OIDC provider configurations.
- Default: `true`
- [Configuration file name](./config-file.md): `oidc-user-provisioning-enabled`
-When a user logs in via OIDC, create a Metabase account for them automatically if they don't have one.
+Determines what happens when a user logs in via OIDC and doesn't have a Metabase account.
+
+When set to `true`, users who log in via OIDC will automatically get a Metabase account if they don't have one, or get their existing account reactivated. When set to `false`, only users with active Metabase accounts can log in via OIDC.
### `MB_PERSISTED_MODEL_REFRESH_CRON_SCHEDULE`
@@ -1661,8 +1678,9 @@ Is SAML Single Log Out enabled?
- Default: `true`
- [Configuration file name](./config-file.md): `saml-user-provisioning-enabled`
-When we enable SAML user provisioning, we automatically create a Metabase account on SAML signin for users who
-don't have one.
+Determines what happens when a user logs in via SAML and doesn't have a Metabase account.
+
+When set to `true`, users who log in via SAML will automatically get a Metabase account if they don't have one, or get their existing account reactivated. When set to `false`, only users with active Metabase accounts can log in via SAML.
### `MB_SCIM_ENABLED`
@@ -2035,6 +2053,18 @@ By default, this is 0 and the thread interrupt escalation does not run.
Timeout in milliseconds to wait after query cancellation before escalating to thread interruption.
This is used to free up threads that are stuck waiting for a DB response after a query has been cancelled.
+### `MB_TRANSFORM_TIMEOUT`
+
+> Only available on Metabase [Pro](https://www.metabase.com/product/pro) and [Enterprise](https://www.metabase.com/product/enterprise) plans.
+
+- Type: integer
+- Default: `240`
+
+The timeout for a transform job, in minutes.
+
+Each query executed by a transform is also subject to the MB_DB_QUERY_TIMEOUT_MINUTES timeout,
+ so make sure that value isn't lower, or it will timeout your transform.
+
### `MB_TRANSFORMS_ENABLED`
- Type: boolean