Skip to content

Commit 228c8d8

Browse files
github-automation-metabaseMetabase Docs bot
github-automation-metabase
and
Metabase Docs bot
authored
[auto] adding content to add-alias-info-MLv2-v3->master (#412)
Co-authored-by: Metabase Docs bot <[email protected]>
1 parent 441d325 commit 228c8d8

File tree

12 files changed

+211
-449
lines changed

12 files changed

+211
-449
lines changed

‎_docs/master/api.html

Lines changed: 40 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -2318,6 +2318,7 @@
23182318
},
23192319
"metabase.legacy-mbql.schema.IntGreaterThanZeroOrNumericExpression" : {
23202320
"oneOf" : [ {
2321+
"description" : "Must be a positive integer.",
23212322
"type" : "integer",
23222323
"minimum" : 1
23232324
}, {
@@ -2615,10 +2616,12 @@
26152616
"type" : "object",
26162617
"properties" : {
26172618
"items" : {
2619+
"description" : "Must be a positive integer.",
26182620
"type" : "integer",
26192621
"minimum" : 1
26202622
},
26212623
"page" : {
2624+
"description" : "Must be a positive integer.",
26222625
"type" : "integer",
26232626
"minimum" : 1
26242627
}
@@ -2912,7 +2915,9 @@
29122915
"type" : "object",
29132916
"properties" : {
29142917
"database" : {
2915-
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
2918+
"description" : "Must be a positive integer.",
2919+
"type" : "integer",
2920+
"minimum" : 1
29162921
},
29172922
"display-name" : {
29182923
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -2924,7 +2929,9 @@
29242929
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
29252930
},
29262931
"snippet-id" : {
2927-
"$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
2932+
"description" : "Must be a positive integer.",
2933+
"type" : "integer",
2934+
"minimum" : 1
29282935
},
29292936
"snippet-name" : {
29302937
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -2940,7 +2947,9 @@
29402947
"type" : "object",
29412948
"properties" : {
29422949
"card-id" : {
2943-
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
2950+
"description" : "Must be a positive integer.",
2951+
"type" : "integer",
2952+
"minimum" : 1
29442953
},
29452954
"display-name" : {
29462955
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
@@ -3645,10 +3654,6 @@
36453654
"type" : "integer",
36463655
"minimum" : 1
36473656
},
3648-
"metabase.lib.schema.id.snippet" : {
3649-
"type" : "integer",
3650-
"minimum" : 1
3651-
},
36523657
"metabase.lib.schema.id.table" : {
36533658
"type" : "integer",
36543659
"minimum" : 1
@@ -3816,49 +3821,14 @@
38163821
"type" : "string",
38173822
"enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable" ]
38183823
},
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" : [ ]
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)."
38533826
},
3854-
"metabase.lib.schema.metadata..column.validate-for-source-native" : {
3855-
"allOf" : [ ]
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"
38563829
},
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" : [ ]
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."
38623832
},
38633833
"metabase.lib.schema.metadata..column.visibility-type" : {
38643834
"type" : "string",
@@ -3873,7 +3843,7 @@
38733843
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
38743844
},
38753845
"fk-join-alias" : {
3876-
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
3846+
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
38773847
},
38783848
"lib/external-remap" : {
38793849
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
@@ -3913,7 +3883,7 @@
39133883
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
39143884
},
39153885
"fk-field-name" : {
3916-
"type" : "string"
3886+
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
39173887
},
39183888
"name" : {
39193889
"type" : "string"
@@ -3978,6 +3948,9 @@
39783948
"lib/original-name" : {
39793949
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
39803950
},
3951+
"lib/hack-original-name" : {
3952+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
3953+
},
39813954
"semantic-type" : {
39823955
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
39833956
},
@@ -3995,7 +3968,11 @@
39953968
}, {
39963969
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.kebab-cased-map"
39973970
}, {
3998-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
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"
39993976
} ]
40003977
},
40013978
"metabase.lib.schema.metadata.deduplicated-name" : {
@@ -4131,7 +4108,7 @@
41314108
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
41324109
},
41334110
"fk-join-alias" : {
4134-
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
4111+
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
41354112
},
41364113
"lib/external-remap" : {
41374114
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
@@ -4171,7 +4148,7 @@
41714148
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
41724149
},
41734150
"fk-field-name" : {
4174-
"type" : "string"
4151+
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
41754152
},
41764153
"name" : {
41774154
"type" : "string"
@@ -4236,6 +4213,9 @@
42364213
"lib/original-name" : {
42374214
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
42384215
},
4216+
"lib/hack-original-name" : {
4217+
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
4218+
},
42394219
"semantic-type" : {
42404220
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
42414221
},
@@ -4253,7 +4233,11 @@
42534233
}, {
42544234
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.kebab-cased-map"
42554235
}, {
4256-
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
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"
42574241
} ]
42584242
}, {
42594243
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
@@ -20053,7 +20037,8 @@
2005320037
"name" : "q",
2005420038
"required" : false,
2005520039
"schema" : {
20056-
"type" : "string"
20040+
"type" : "string",
20041+
"minLength" : 1
2005720042
}
2005820043
}, {
2005920044
"in" : "query",

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

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

1212
# Metabase config file template
1313

14-
You can generate the following docs by changing into the top-level Metabase directory and running:
14+
You can generate the following config file template 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-
2322
```yaml
2423
# A config file template for Metabase.
2524
# You'll need to update (or remove) the `users` and `databases` sections.
@@ -34,45 +33,45 @@ The template lists example `database`, `user`, and `settings` sections for the [
3433
version: 1
3534
config:
3635
users:
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]
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]
5049
databases:
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
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
6766
api-keys:
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
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
7675
settings:
7776
admin-email: null
7877
aggregated-query-row-limit: null
@@ -110,7 +109,6 @@ config:
110109
application-name: Metabase
111110
attachment-row-limit: null
112111
attachment-table-row-limit: 20
113-
audit-max-retention-days: null
114112
bcc-enabled: true
115113
breakout-bin-width: 10.0
116114
breakout-bins-num: 8
@@ -165,9 +163,7 @@ config:
165163
health-check-logging-enabled: true
166164
help-link: metabase
167165
help-link-custom-destination: https://www.metabase.com/help/premium
168-
http-channel-host-strategy: external-only
169166
humanization-strategy: simple
170-
install-analytics-database: true
171167
jdbc-data-warehouse-max-connection-pool-size: 15
172168
jwt-attribute-email: email
173169
jwt-attribute-firstname: first_name
@@ -179,7 +175,7 @@ config:
179175
jwt-identity-provider-uri: null
180176
jwt-shared-secret: null
181177
jwt-user-provisioning-enabled: true
182-
landing-page: ''
178+
landing-page: ""
183179
landing-page-illustration: default
184180
landing-page-illustration-custom: null
185181
ldap-attribute-email: mail
@@ -201,7 +197,6 @@ config:
201197
ldap-user-filter: (&(objectClass=inetOrgPerson)(|(uid={login})(mail={login})))
202198
ldap-user-provisioning-enabled: true
203199
license-token-missing-banner-dismissal-timestamp: []
204-
load-analytics-content: true
205200
loading-message: doing-science
206201
login-page-illustration: default
207202
login-page-illustration-custom: null
@@ -252,15 +247,13 @@ config:
252247
search-engine: appdb
253248
search-language: null
254249
search-typeahead-enabled: true
255-
send-email-on-first-login-from-new-device: true
256250
send-new-sso-user-admin-email: null
257251
session-cookie-samesite: lax
258252
session-cookies: null
259253
session-timeout: null
260254
setup-embedding-autoenabled: false
261255
setup-license-active-at-setup: false
262256
show-database-syncing-modal: null
263-
show-google-sheets-integration: null
264257
show-homepage-data: true
265258
show-homepage-xrays: true
266259
show-metabase-links: true
@@ -278,7 +271,6 @@ config:
278271
start-of-week: sunday
279272
subscription-allowed-domains: null
280273
surveys-enabled: true
281-
sync-leaf-fields-limit: 1000
282274
synchronous-batch-updates: false
283275
unaggregated-query-row-limit: null
284276
uploads-settings: null

0 commit comments

Comments
 (0)