Skip to content

[auto-build] describe-database-wrapping -> master #439

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+475 −199
Open

[auto-build] describe-database-wrapping -> master #439

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 55 additions & 40 deletions _docs/master/api.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2318,7 +2318,6 @@
},
"metabase.legacy-mbql.schema.IntGreaterThanZeroOrNumericExpression" : {
"oneOf" : [ {
"description" : "Must be a positive integer.",
"type" : "integer",
"minimum" : 1
}, {
Expand Down Expand Up @@ -2616,12 +2615,10 @@
"type" : "object",
"properties" : {
"items" : {
"description" : "Must be a positive integer.",
"type" : "integer",
"minimum" : 1
},
"page" : {
"description" : "Must be a positive integer.",
"type" : "integer",
"minimum" : 1
}
Expand Down Expand Up @@ -2915,9 +2912,7 @@
"type" : "object",
"properties" : {
"database" : {
"description" : "Must be a positive integer.",
"type" : "integer",
"minimum" : 1
"$ref" : "#/components/schemas/metabase.lib.schema.id.database"
},
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
Expand All @@ -2929,9 +2924,7 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"snippet-id" : {
"description" : "Must be a positive integer.",
"type" : "integer",
"minimum" : 1
"$ref" : "#/components/schemas/metabase.lib.schema.id.snippet"
},
"snippet-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
Expand All @@ -2947,9 +2940,7 @@
"type" : "object",
"properties" : {
"card-id" : {
"description" : "Must be a positive integer.",
"type" : "integer",
"minimum" : 1
"$ref" : "#/components/schemas/metabase.lib.schema.id.card"
},
"display-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
Expand Down Expand Up @@ -3654,6 +3645,10 @@
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.snippet" : {
"type" : "integer",
"minimum" : 1
},
"metabase.lib.schema.id.table" : {
"type" : "integer",
"minimum" : 1
Expand Down Expand Up @@ -3821,14 +3816,49 @@
"type" : "string",
"enum" : [ "source/card", "source/native", "source/previous-stage", "source/table-defaults", "source/aggregations", "source/joins", "source/expressions", "source/implicitly-joinable" ]
},
"metabase.lib.schema.metadata..column.validate-expression-source" : {
"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)."
"metabase.lib.schema.metadata..column.validate-for-source" : {
"description" : "Do additional validation for column metadata based on `:lib/source`.",
"oneOf" : [ {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-card"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-native"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-previous-stage"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-table-defaults"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-aggregations"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source-joins"
}, {
"$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"
}, { } ]
},
"metabase.lib.schema.metadata..column.validate-for-source-aggregations" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-card" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-expressions" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-implicitly-joinable" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-joins" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-native-column" : {
"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"
"metabase.lib.schema.metadata..column.validate-for-source-native" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-table-defaults-column" : {
"description" : "A column with :lib/source :source/table-defaults cannot possibly have a join alias."
"metabase.lib.schema.metadata..column.validate-for-source-previous-stage" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.validate-for-source-table-defaults" : {
"allOf" : [ ]
},
"metabase.lib.schema.metadata..column.visibility-type" : {
"type" : "string",
Expand All @@ -3843,7 +3873,7 @@
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
},
"fk-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"lib/external-remap" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
Expand Down Expand Up @@ -3883,7 +3913,7 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"fk-field-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
"type" : "string"
},
"name" : {
"type" : "string"
Expand Down Expand Up @@ -3948,9 +3978,6 @@
"lib/original-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
},
"lib/hack-original-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
},
"semantic-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
},
Expand All @@ -3968,11 +3995,7 @@
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-expression-source"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-native-column"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-table-defaults-column"
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
} ]
},
"metabase.lib.schema.metadata.deduplicated-name" : {
Expand Down Expand Up @@ -4108,7 +4131,7 @@
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.visibility-type"
},
"fk-join-alias" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
"$ref" : "#/components/schemas/metabase.lib.schema.join.alias"
},
"lib/external-remap" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.remapping.external"
Expand Down Expand Up @@ -4148,7 +4171,7 @@
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
},
"fk-field-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.non-blank-string"
"type" : "string"
},
"name" : {
"type" : "string"
Expand Down Expand Up @@ -4213,9 +4236,6 @@
"lib/original-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
},
"lib/hack-original-name" : {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.original-name"
},
"semantic-type" : {
"$ref" : "#/components/schemas/metabase.lib.schema.common.semantic-or-relation-type"
},
Expand All @@ -4233,11 +4253,7 @@
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata.kebab-cased-map"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-expression-source"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-native-column"
}, {
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-table-defaults-column"
"$ref" : "#/components/schemas/metabase.lib.schema.metadata..column.validate-for-source"
} ]
}, {
"$ref" : "#/components/schemas/metabase.legacy-mbql.schema.legacy-column-metadata"
Expand Down Expand Up @@ -20037,8 +20053,7 @@
"name" : "q",
"required" : false,
"schema" : {
"type" : "string",
"minLength" : 1
"type" : "string"
}
}, {
"in" : "query",
Expand Down
86 changes: 47 additions & 39 deletions _docs/master/configuring-metabase/config-template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,15 @@ layout: new-docs

# Metabase config file template

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

```
clojure -M:doc:ee config-template
```

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


```yaml
# A config file template for Metabase.
# You'll need to update (or remove) the `users` and `databases` sections.
Expand All @@ -33,45 +34,45 @@ The template lists example `database`, `user`, and `settings` sections for the [
version: 1
config:
users:
- first_name: First
last_name: Person
password: metabot1
email: [email protected]
- first_name: Normal
last_name: Person
password: metabot1
email: [email protected]
- first_name: Admin
last_name: Person
password: metabot1
is_superuser: true
email: [email protected]
- first_name: First
last_name: Person
password: metabot1
email: [email protected]
- first_name: Normal
last_name: Person
password: metabot1
email: [email protected]
- first_name: Admin
last_name: Person
password: metabot1
is_superuser: true
email: [email protected]
databases:
- name: Sample PostgreSQL
engine: postgres
details:
host: postgres-data
port: 5432
user: metabase
password: metasample123
dbname: sample
- name: Sample MySQL
engine: mysql
details:
host: mysql-data
port: 3306
user: metabase
password: metasample123
dbname: sample
- name: Sample PostgreSQL
engine: postgres
details:
host: postgres-data
port: 5432
user: metabase
password: metasample123
dbname: sample
- name: Sample MySQL
engine: mysql
details:
host: mysql-data
port: 3306
user: metabase
password: metasample123
dbname: sample
api-keys:
- name: Admin API key
group: admin
creator: [email protected]
key: mb_firsttestapikey123
- name: All Users API key
group: all-users
creator: [email protected]
key: mb_secondtestapikey456
- name: Admin API key
group: admin
creator: [email protected]
key: mb_firsttestapikey123
- name: All Users API key
group: all-users
creator: [email protected]
key: mb_secondtestapikey456
settings:
admin-email: null
aggregated-query-row-limit: null
Expand Down Expand Up @@ -109,6 +110,7 @@ config:
application-name: Metabase
attachment-row-limit: null
attachment-table-row-limit: 20
audit-max-retention-days: null
bcc-enabled: true
breakout-bin-width: 10.0
breakout-bins-num: 8
Expand Down Expand Up @@ -163,7 +165,9 @@ config:
health-check-logging-enabled: true
help-link: metabase
help-link-custom-destination: https://www.metabase.com/help/premium
http-channel-host-strategy: external-only
humanization-strategy: simple
install-analytics-database: true
jdbc-data-warehouse-max-connection-pool-size: 15
jwt-attribute-email: email
jwt-attribute-firstname: first_name
Expand All @@ -175,7 +179,7 @@ config:
jwt-identity-provider-uri: null
jwt-shared-secret: null
jwt-user-provisioning-enabled: true
landing-page: ""
landing-page: ''
landing-page-illustration: default
landing-page-illustration-custom: null
ldap-attribute-email: mail
Expand All @@ -197,6 +201,7 @@ config:
ldap-user-filter: (&(objectClass=inetOrgPerson)(|(uid={login})(mail={login})))
ldap-user-provisioning-enabled: true
license-token-missing-banner-dismissal-timestamp: []
load-analytics-content: true
loading-message: doing-science
login-page-illustration: default
login-page-illustration-custom: null
Expand Down Expand Up @@ -247,13 +252,15 @@ config:
search-engine: appdb
search-language: null
search-typeahead-enabled: true
send-email-on-first-login-from-new-device: true
send-new-sso-user-admin-email: null
session-cookie-samesite: lax
session-cookies: null
session-timeout: null
setup-embedding-autoenabled: false
setup-license-active-at-setup: false
show-database-syncing-modal: null
show-google-sheets-integration: null
show-homepage-data: true
show-homepage-xrays: true
show-metabase-links: true
Expand All @@ -271,6 +278,7 @@ config:
start-of-week: sunday
subscription-allowed-domains: null
surveys-enabled: true
sync-leaf-fields-limit: 1000
synchronous-batch-updates: false
unaggregated-query-row-limit: null
uploads-settings: null
Expand Down
Loading