Skip to content

Commit f6d26e8

Browse files
author
Metabase Docs bot
committed
[auto] adding content to ah-docs-saml->master
1 parent 228c8d8 commit f6d26e8

File tree

15 files changed

+477
-190
lines changed

15 files changed

+477
-190
lines changed

‎_docs/master/api.html

Lines changed: 55 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -2318,7 +2318,6 @@
23182318
},
23192319
"metabase.legacy-mbql.schema.IntGreaterThanZeroOrNumericExpression" : {
23202320
"oneOf" : [ {
2321-
"description" : "Must be a positive integer.",
23222321
"type" : "integer",
23232322
"minimum" : 1
23242323
}, {
@@ -2616,12 +2615,10 @@
26162615
"type" : "object",
26172616
"properties" : {
26182617
"items" : {
2619-
"description" : "Must be a positive integer.",
26202618
"type" : "integer",
26212619
"minimum" : 1
26222620
},
26232621
"page" : {
2624-
"description" : "Must be a positive integer.",
26252622
"type" : "integer",
26262623
"minimum" : 1
26272624
}
@@ -2915,9 +2912,7 @@
29152912
"type" : "object",
29162913
"properties" : {
29172914
"database" : {
2918-
"description" : "Must be a positive integer.",
2919-
"type" : "integer",
2920-
"minimum" : 1
2915+
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
29212916
},
29222917
"display-name" : {
29232918
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -2929,9 +2924,7 @@
29292924
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
29302925
},
29312926
"snippet-id" : {
2932-
"description" : "Must be a positive integer.",
2933-
"type" : "integer",
2934-
"minimum" : 1
2927+
"$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
29352928
},
29362929
"snippet-name" : {
29372930
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -2947,9 +2940,7 @@
29472940
"type" : "object",
29482941
"properties" : {
29492942
"card-id" : {
2950-
"description" : "Must be a positive integer.",
2951-
"type" : "integer",
2952-
"minimum" : 1
2943+
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
29532944
},
29542945
"display-name" : {
29552946
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -3654,6 +3645,10 @@
36543645
"type" : "integer",
36553646
"minimum" : 1
36563647
},
3648+
"metabase.lib.schema.id.snippet" : {
3649+
"type" : "integer",
3650+
"minimum" : 1
3651+
},
36573652
"metabase.lib.schema.id.table" : {
36583653
"type" : "integer",
36593654
"minimum" : 1
@@ -3821,14 +3816,49 @@
38213816
"type" : "string",
38223817
"enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable" ]
38233818
},
3824-
"metabase.lib.schema.metadata..column.validate-expression-source" : {
3825-
"description" : "Only allow `:lib/expression-name` when `:lib/source` is `:source/expressions`. If it's anything else, it probably\n means it's getting incorrectly propagated from a previous stage (QUE-1342)."
3819+
"metabase.lib.schema.metadata..column.validate-for-source" : {
3820+
"description" : "Do additional validation for column metadata based on `:lib/source`.",
3821+
"oneOf" : [ {
3822+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-card"
3823+
}, {
3824+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-native"
3825+
}, {
3826+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-previous-stage"
3827+
}, {
3828+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-table-defaults"
3829+
}, {
3830+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-aggregations"
3831+
}, {
3832+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-joins"
3833+
}, {
3834+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-expressions"
3835+
}, {
3836+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable"
3837+
}, { } ]
3838+
},
3839+
"metabase.lib.schema.metadata..column.validate-for-source-aggregations" : {
3840+
"allOf" : [ ]
3841+
},
3842+
"metabase.lib.schema.metadata..column.validate-for-source-card" : {
3843+
"allOf" : [ ]
3844+
},
3845+
"metabase.lib.schema.metadata..column.validate-for-source-expressions" : {
3846+
"allOf" : [ ]
3847+
},
3848+
"metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable" : {
3849+
"allOf" : [ ]
3850+
},
3851+
"metabase.lib.schema.metadata..column.validate-for-source-joins" : {
3852+
"allOf" : [ ]
38263853
},
3827-
"metabase.lib.schema.metadata..column.validate-native-column" : {
3828-
"description" : "Certain keys cannot possibly be set when a column comes from directly from native query results, for example\n `:lib/breakout?` or join aliases"
3854+
"metabase.lib.schema.metadata..column.validate-for-source-native" : {
3855+
"allOf" : [ ]
38293856
},
3830-
"metabase.lib.schema.metadata..column.validate-table-defaults-column" : {
3831-
"description" : "A column with :lib/source :source/table-defaults cannot possibly have a join alias."
3857+
"metabase.lib.schema.metadata..column.validate-for-source-previous-stage" : {
3858+
"allOf" : [ ]
3859+
},
3860+
"metabase.lib.schema.metadata..column.validate-for-source-table-defaults" : {
3861+
"allOf" : [ ]
38323862
},
38333863
"metabase.lib.schema.metadata..column.visibility-type" : {
38343864
"type" : "string",
@@ -3843,7 +3873,7 @@
38433873
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
38443874
},
38453875
"fk-join-alias" : {
3846-
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
3876+
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
38473877
},
38483878
"lib/external-remap" : {
38493879
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
@@ -3883,7 +3913,7 @@
38833913
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
38843914
},
38853915
"fk-field-name" : {
3886-
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
3916+
"type" : "string"
38873917
},
38883918
"name" : {
38893919
"type" : "string"
@@ -3948,9 +3978,6 @@
39483978
"lib/original-name" : {
39493979
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
39503980
},
3951-
"lib/hack-original-name" : {
3952-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
3953-
},
39543981
"semantic-type" : {
39553982
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
39563983
},
@@ -3968,11 +3995,7 @@
39683995
}, {
39693996
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.kebab-cased-map"
39703997
}, {
3971-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-expression-source"
3972-
}, {
3973-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-native-column"
3974-
}, {
3975-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-table-defaults-column"
3998+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
39763999
} ]
39774000
},
39784001
"metabase.lib.schema.metadata.deduplicated-name" : {
@@ -4108,7 +4131,7 @@
41084131
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
41094132
},
41104133
"fk-join-alias" : {
4111-
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
4134+
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
41124135
},
41134136
"lib/external-remap" : {
41144137
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
@@ -4148,7 +4171,7 @@
41484171
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
41494172
},
41504173
"fk-field-name" : {
4151-
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
4174+
"type" : "string"
41524175
},
41534176
"name" : {
41544177
"type" : "string"
@@ -4213,9 +4236,6 @@
42134236
"lib/original-name" : {
42144237
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
42154238
},
4216-
"lib/hack-original-name" : {
4217-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
4218-
},
42194239
"semantic-type" : {
42204240
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
42214241
},
@@ -4233,11 +4253,7 @@
42334253
}, {
42344254
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.kebab-cased-map"
42354255
}, {
4236-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-expression-source"
4237-
}, {
4238-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-native-column"
4239-
}, {
4240-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-table-defaults-column"
4256+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
42414257
} ]
42424258
}, {
42434259
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
@@ -20037,8 +20053,7 @@
2003720053
"name" : "q",
2003820054
"required" : false,
2003920055
"schema" : {
20040-
"type" : "string",
20041-
"minLength" : 1
20056+
"type" : "string"
2004220057
}
2004320058
}, {
2004420059
"in" : "query",

‎_docs/master/configuring-metabase/config-template.md

Lines changed: 47 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,15 @@ layout: new-docs
1111

1212
# Metabase config file template
1313

14-
You can generate the following config file template by changing into the top-level Metabase directory and running:
14+
You can generate the following docs by changing into the top-level Metabase directory and running:
1515

1616
```
1717
clojure -M:doc:ee config-template
1818
```
1919

2020
The template lists example `database`, `user`, and `settings` sections for the [config file](./config-file).
2121

22+
2223
```yaml
2324
# A config file template for Metabase.
2425
# You'll need to update (or remove) the `users` and `databases` sections.
@@ -33,45 +34,45 @@ The template lists example `database`, `user`, and `settings` sections for the [
3334
version: 1
3435
config:
3536
users:
36-
- first_name: First
37-
last_name: Person
38-
password: metabot1
39-
email: [email protected]
40-
- first_name: Normal
41-
last_name: Person
42-
password: metabot1
43-
email: [email protected]
44-
- first_name: Admin
45-
last_name: Person
46-
password: metabot1
47-
is_superuser: true
48-
email: [email protected]
37+
- first_name: First
38+
last_name: Person
39+
password: metabot1
40+
email: [email protected]
41+
- first_name: Normal
42+
last_name: Person
43+
password: metabot1
44+
email: [email protected]
45+
- first_name: Admin
46+
last_name: Person
47+
password: metabot1
48+
is_superuser: true
49+
email: [email protected]
4950
databases:
50-
- name: Sample PostgreSQL
51-
engine: postgres
52-
details:
53-
host: postgres-data
54-
port: 5432
55-
user: metabase
56-
password: metasample123
57-
dbname: sample
58-
- name: Sample MySQL
59-
engine: mysql
60-
details:
61-
host: mysql-data
62-
port: 3306
63-
user: metabase
64-
password: metasample123
65-
dbname: sample
51+
- name: Sample PostgreSQL
52+
engine: postgres
53+
details:
54+
host: postgres-data
55+
port: 5432
56+
user: metabase
57+
password: metasample123
58+
dbname: sample
59+
- name: Sample MySQL
60+
engine: mysql
61+
details:
62+
host: mysql-data
63+
port: 3306
64+
user: metabase
65+
password: metasample123
66+
dbname: sample
6667
api-keys:
67-
- name: Admin API key
68-
group: admin
69-
creator: [email protected]
70-
key: mb_firsttestapikey123
71-
- name: All Users API key
72-
group: all-users
73-
creator: [email protected]
74-
key: mb_secondtestapikey456
68+
- name: Admin API key
69+
group: admin
70+
creator: [email protected]
71+
key: mb_firsttestapikey123
72+
- name: All Users API key
73+
group: all-users
74+
creator: [email protected]
75+
key: mb_secondtestapikey456
7576
settings:
7677
admin-email: null
7778
aggregated-query-row-limit: null
@@ -109,6 +110,7 @@ config:
109110
application-name: Metabase
110111
attachment-row-limit: null
111112
attachment-table-row-limit: 20
113+
audit-max-retention-days: null
112114
bcc-enabled: true
113115
breakout-bin-width: 10.0
114116
breakout-bins-num: 8
@@ -163,7 +165,9 @@ config:
163165
health-check-logging-enabled: true
164166
help-link: metabase
165167
help-link-custom-destination: https://www.metabase.com/help/premium
168+
http-channel-host-strategy: external-only
166169
humanization-strategy: simple
170+
install-analytics-database: true
167171
jdbc-data-warehouse-max-connection-pool-size: 15
168172
jwt-attribute-email: email
169173
jwt-attribute-firstname: first_name
@@ -175,7 +179,7 @@ config:
175179
jwt-identity-provider-uri: null
176180
jwt-shared-secret: null
177181
jwt-user-provisioning-enabled: true
178-
landing-page: ""
182+
landing-page: ''
179183
landing-page-illustration: default
180184
landing-page-illustration-custom: null
181185
ldap-attribute-email: mail
@@ -197,6 +201,7 @@ config:
197201
ldap-user-filter: (&(objectClass=inetOrgPerson)(|(uid={login})(mail={login})))
198202
ldap-user-provisioning-enabled: true
199203
license-token-missing-banner-dismissal-timestamp: []
204+
load-analytics-content: true
200205
loading-message: doing-science
201206
login-page-illustration: default
202207
login-page-illustration-custom: null
@@ -247,13 +252,15 @@ config:
247252
search-engine: appdb
248253
search-language: null
249254
search-typeahead-enabled: true
255+
send-email-on-first-login-from-new-device: true
250256
send-new-sso-user-admin-email: null
251257
session-cookie-samesite: lax
252258
session-cookies: null
253259
session-timeout: null
254260
setup-embedding-autoenabled: false
255261
setup-license-active-at-setup: false
256262
show-database-syncing-modal: null
263+
show-google-sheets-integration: null
257264
show-homepage-data: true
258265
show-homepage-xrays: true
259266
show-metabase-links: true
@@ -271,6 +278,7 @@ config:
271278
start-of-week: sunday
272279
subscription-allowed-domains: null
273280
surveys-enabled: true
281+
sync-leaf-fields-limit: 1000
274282
synchronous-batch-updates: false
275283
unaggregated-query-row-limit: null
276284
uploads-settings: null

0 commit comments

Comments
 (0)