Skip to content
Snippets Groups Projects
Unverified Commit b337f510 authored by Jeff Bruemmer's avatar Jeff Bruemmer Committed by GitHub
Browse files

docs - frontmatter (#23272)

parent 5253f8cb
No related branches found
No related tags found
No related merge requests found
Showing
with 101 additions and 27 deletions
---
title: Setting default formatting for your data
---
## Setting default formatting for your data
There are Metabase users around the world, each with different preferences for how dates, times, numbers, and currencies should be formatted and displayed. Metabase allows you to customize these formatting options at three different levels:
......@@ -31,4 +35,4 @@ Lastly, you can override all formatting settings in any specific saved question
---
## Next: caching query results
Metabase makes it easy to [automatically cache results](14-caching.md) for queries that take a long time to run.
Metabase makes it easy to [automatically cache results](14-caching.md) for queries that take a long time to run.
\ No newline at end of file
---
title: Custom Maps
---
## Custom Maps
By default, Metabase uses OpenStreetMaps for map visualizations, but there are a few customization options.
......@@ -37,4 +41,4 @@ GeoJSON, we recommend that you start [here](https://geojson.org/).
## Next: editing metadata
Taking just a few minutes to edit and add info to your database’s metadata can greatly enhance your experience with
Metabase. Let’s learn how to [edit your metadata](03-metadata-editing.md).
Metabase. Let’s learn how to [edit your metadata](03-metadata-editing.md).
\ No newline at end of file
---
title: Application permissions
---
# Application permissions
{% include plans-blockquote.html feature="Application permissions" %}
......@@ -40,4 +44,4 @@ This setting determines who can set up:
- [Dashboard subscriptions](../users-guide/dashboard-subscriptions.md)
- [Alerts](../users-guide/15-alerts.md)
People will need to be in groups with either view or edit access to the collection that contains the dashboard or question in order to set up alerts. See [Collection permissions](06-collections.md).
People will need to be in groups with either view or edit access to the collection that contains the dashboard or question in order to set up alerts. See [Collection permissions](06-collections.md).
\ No newline at end of file
---
title: Data permissions
---
# Data permissions
This page covers permissions for databases and tables. If you haven't already, check out our [Permissions overview][permissions-overview].
......@@ -110,4 +114,4 @@ This setting defines whether a person can edit the connection settings for the d
[permissions-overview]: 05-setting-permissions.md
[sandbox-columns]: /learn/permissions/data-sandboxing-column-permissions.html
[sandbox-rows]: /learn/permissions/data-sandboxing-row-permissions.html
[sql-snippet-folders]: ../enterprise-guide/sql-snippets.md
[sql-snippet-folders]: ../enterprise-guide/sql-snippets.md
\ No newline at end of file
---
title: Connecting to AWS's Relational Database Service (RDS)
---
## Connecting to AWS's Relational Database Service (RDS)
RDS offers several databases that Metabase officially supports, including PostgreSQL, MySQL, MariaDB, Oracle, and SQL server.
......@@ -14,5 +18,4 @@ Here's how to get connection information for databases on Amazon's RDS:
- **Port**. Find the port parameter under Security and Network.
- **Username**. Find this under Configuration Details.
- **Database Name**. Find this under Configuration Details
- **Password**. Ask your database administrator for the password.
- **Password**. Ask your database administrator for the password.
\ No newline at end of file
---
title: Working with Google BigQuery in Metabase
---
# Working with Google BigQuery in Metabase
This page provides information on how to create and manage a connection to a Google [BigQuery](https://cloud.google.com/bigquery) dataset, including one that uses [files stored in Google Drive](https://cloud.google.com/bigquery/external-data-drive) as a data source, like Google Sheets (GSheets).
......@@ -174,4 +178,4 @@ If you're having trouble with your BigQuery connection, you can check out this [
- [Managing databases](https://www.metabase.com/docs/latest/administration-guide/01-managing-databases.html)
- [Metadata editing](https://www.metabase.com/docs/latest/administration-guide/03-metadata-editing.html)
- [Models](../../users-guide/models.md)
- [Setting data access permissions](https://www.metabase.com/docs/latest/administration-guide/05-setting-permissions.html)
- [Setting data access permissions](https://www.metabase.com/docs/latest/administration-guide/05-setting-permissions.html)
\ No newline at end of file
## Working with Google Analytics in Metabase
---
title: Working with Google Analytics in Metabase
---
# Working with Google Analytics in Metabase
This page provides information on how to create and manage a connection to a [Google Analytics][google-analytics] dataset.
......@@ -104,4 +108,4 @@ If you're having trouble, see the guides under [Troubleshooting data sources][tr
[google-oauth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[google-service-accounts]: https://cloud.google.com/iam/docs/service-accounts
[sync-docs]: ../../administration-guide/01-managing-databases.html#choose-when-metabase-syncs-and-scans
[troubleshooting-data-sources]: .../troubleshooting-guide/index.html#data-sources
\ No newline at end of file
[troubleshooting-data-sources]: ../../troubleshooting-guide/index.html#data-sources
---
title: H2
---
## H2
H2 is a lightweight, in-memory database; it’s perfect for getting spun up quickly, but not so good for long-term usage. By default, Metabase uses H2 to store its internal data. The Sample Database included with Metabase is also an H2 database.
## Avoid using H2 as your application database in production
If you want to run Metabase in production, we recommend that you [migrate off H2](/docs/latest/operations-guide/migrating-from-h2.html).
If you want to run Metabase in production, we recommend that you [migrate off H2](/docs/latest/operations-guide/migrating-from-h2.html).
\ No newline at end of file
---
title: Working with MongoDB in Metabase
---
# Working with MongoDB in Metabase
This article covers:
......@@ -111,4 +115,4 @@ One workaround is to include all possible keys in the first document of the coll
## Further reading
See our troubleshooting guide for [troubleshooting your connection](../../troubleshooting-guide/datawarehouse.md).
See our troubleshooting guide for [troubleshooting your connection](../../troubleshooting-guide/datawarehouse.md).
\ No newline at end of file
---
title: Working with MySQL in Metabase
---
# Working with MySQL in Metabase
This page includes some helpful info for connecting Metabase to your MySQL database.
......@@ -59,5 +63,4 @@ mysql:
volumes:
- $PWD/mysql:/var/lib/mysql
command: ['--default-authentication-plugin=mysql_native_password']
```
```
\ No newline at end of file
---
title: Working with Oracle in Metabase
---
# Working with Oracle in Metabase
## Downloading the Oracle JDBC Driver JAR
......@@ -58,4 +62,4 @@ For example, if you're running Metabase from a directory called `/app/`, you sho
## When running from Docker
The process for adding plugins when running via Docker is similar, but you'll need to mount the `plugins` directory. Refer to instructions [here](../../operations-guide/running-metabase-on-docker.html#adding-external-dependencies-or-plugins) for more details.
The process for adding plugins when running via Docker is similar, but you'll need to mount the `plugins` directory. Refer to instructions [here](../../operations-guide/running-metabase-on-docker.html#adding-external-dependencies-or-plugins) for more details.
\ No newline at end of file
---
title: Connecting to a PostgreSQL database
---
# Connecting to a PostgreSQL database
In addition to specifying the host, port, database name and user credentials for the database connection, you have the option of securing that connection.
......@@ -89,5 +93,4 @@ Postgres JSON fields don’t have schema, so Metabase can’t rely on table meta
The problem is that if the keys in the JSON vary record to record, the first ten thousand rows may not capture all the keys used by JSON objects in that JSON field. To get Metabase to infer all the JSON keys, you'll need to add the additional keys to the JSON objects in the first ten thousand row.
[ssl-modes]: https://jdbc.postgresql.org/documentation/head/ssl-client.html
[ssh-tunnel]: ../ssh-tunnel-for-database-connections.html
[ssh-tunnel]: ../ssh-tunnel-for-database-connections.html
\ No newline at end of file
---
title: Redshift
---
# Redshift
## Connection information
......@@ -31,5 +35,4 @@ Let's say you have three schemas: foo, bar, and baz.
- If you have **Only these...** set, and enter the string `b*`, you'll sync with bar and baz.
- If you have **All except...** set, and enter the string `b*`, you'll just sync foo.
Note that only the `*` wildcard is supported; you can't use other special characters or regexes.
Note that only the `*` wildcard is supported; you can't use other special characters or regexes.
\ No newline at end of file
---
title: Snowflake
---
# Snowflake
## Schemas
......@@ -31,4 +35,4 @@ Here are some gotchas to look out for when connecting to Snowflake:
- **The `Role` and `Schema` fields are optional**. Specifying a role will override the database user's default role. For example, if the database user is `REPORTER` with default role `REPORTER`, but the user also has access to role `REPORTERPRODUCT`, then filling in `REPORTERPRODUCT` in the `Role` field will ensure that the `REPORTERPRODUCT` role is used instead of the user's default `REPORTER` role. If no schema is passed, then all schema available to that user and role will be listed as folders in the Metabase UI.
- **All other fields must be entered in upper case**. Excluding the password.
- **All other fields must be entered in upper case**. Excluding the password.
\ No newline at end of file
---
title: Working with Vertica in Metabase
---
# Working with Vertica in Metabase
Starting in v0.20.0, Metabase provides a driver for connecting to Vertica databases. Under the hood, Metabase uses Vertica's JDBC driver;
......@@ -33,4 +37,4 @@ For example, if you're running Metabase from a directory called `/app/`, you sho
### When running from Docker
The process for adding plugins when running via Docker is similar, but you'll need to mount the `plugins` directory. Refer to instructions [here](../../operations-guide/running-metabase-on-docker.html#adding-external-dependencies-or-plugins) for more details.
The process for adding plugins when running via Docker is similar, but you'll need to mount the `plugins` directory. Refer to instructions [here](../../operations-guide/running-metabase-on-docker.html#adding-external-dependencies-or-plugins) for more details.
\ No newline at end of file
---
title: Languages and localization
---
# Languages and localization
## Supported languages
......@@ -79,6 +83,4 @@ If you need to, you can change the first day of the week for your instance (the
- `Unit of currency:` if you do most of your business in a particular currency, you can specify that here.
- `Currency label style:` whether you want to have your currencies labeled with a symbol, a code (like `USD`), or its full name.
- `Where to display the unit of currency:` this pertains specifically to tables, and lets you choose if you want the currency labels to appear only in the column heading, or next to each value in the column.
- `Where to display the unit of currency:` this pertains specifically to tables, and lets you choose if you want the currency labels to appear only in the column heading, or next to each value in the column.
\ No newline at end of file
---
title: Securing database connections using an SSL certificate
---
## Securing database connections using an SSL certificate
If you'd like to connect your Metabase Cloud or self-hosted instance to a database, you can secure the connection using Secure Socket Layer (SSL) encryption with a certificate.
......@@ -78,4 +82,4 @@ If a truststore is provided to verify credentials, the client (your Metabase) ca
### Keystores
If a keystore is used to provide credentials, then the server (the database server) can request the client (your Metabase) authenticate itself using that keystore. Keystores are used less frequently, and in some cases it's impossible to use a keystore (Amazon's RDS forbids keystores, for example). But you may want to use a keystore if you're hosting on prem.
If a keystore is used to provide credentials, then the server (the database server) can request the client (your Metabase) authenticate itself using that keystore. Keystores are used less frequently, and in some cases it's impossible to use a keystore (Amazon's RDS forbids keystores, for example). But you may want to use a keystore if you're hosting on prem.
\ No newline at end of file
---
title: SSH tunneling in Metabase
---
## SSH tunneling in Metabase
Metabase can connect to some databases by first establishing a connection to a server in between Metabase and a data warehouse, then connecting to the data warehouse using that connection as a bridge. This makes connecting to some data warehouses possible in situations that would otherwise prevent the use of Metabase.
......@@ -71,4 +75,4 @@ This allows you to use the full array of features included in SSH. If you find y
### Further reading
For more on connecting a database to Metabase, see [Adding and managing databases](01-managing-databases.md).
For more on connecting a database to Metabase, see [Adding and managing databases](01-managing-databases.md).
\ No newline at end of file
---
title: Setting up Single Sign-on (SSO)
---
## Setting up Single Sign-on (SSO)
We recommend that you set up [Single Sign-on][sso-def] for your Metabase installation.
......@@ -31,4 +35,4 @@ With paid versions, you have more options to help manage lots of people and grou
[saml-google]: ../enterprise-guide/saml-google.html
[saml-keycloak]: ../enterprise-guide/saml-keycloak.html
[saml-other-idps]: ../enterprise-guide/authenticating-with-saml.html#documentation-for-other-common-idps
[sso-def]: /glossary/sso.html
[sso-def]: /glossary/sso.html
\ No newline at end of file
---
title: Administration Guide
---
# Administration Guide
Are you in charge of managing Metabase for your organization? Then you're in the right spot. You are the chosen one.
......@@ -43,4 +47,4 @@ See [how to install Metabase](../operations-guide/installing-metabase.md).
## Embedding and sharing with public links
- [Sharing dashboards and questions with public links](12-public-links.md)
- [Embedding Metabase in other Applications](13-embedding.md)
- [Embedding Metabase in other Applications](13-embedding.md)
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment