Metabase Plugin for Steampipe

Use SQL to query databases, tables, permissions and more from Metabase.

• Get started →
• Documentation: Table definitions & examples
• Community: Join #steampipe on Slack →
• Get involved: Issues

Quick start

Install

Download and install the latest Metabase plugin:

steampipe plugin install ghcr.io/1024pix/metabase

Metabase requires a token or a login username and password.

Configure your account details in ~/.steampipe/config/metabase.spc:

connection "metabase" {
    plugin = "ghcr.io/1024pix/metabase"

    # Your metabase url (required)
    # url = "https://localhost"

    # Username/password is required for requests. Required except if token (see after) is provided.
    # This can also be set via the `METABASE_USER` and `METABASE_PASSWORD` environment variable.
    # user = "my_user"
    # password = "my_password"

    # Token is required for requests. Required except if user/password (see before) is provided.
    # This can also be set via the `METABASE_TOKEN` environment variable.
    # token = "33d0d62a-6a16-3083-ba7b-3bab31bd6612"

    # Skip TLS verification, useful in local test. Optionnal.
    # tls_skip_verify = false
}

Or through environment variables:

export METABASE_USER=janedoe
export METABASE_PASSWORD=my_password

Run steampipe:

steampipe query

List database in your Metabase instance:

select
  id,
  name
from
  metabase_db;

+------+------+
| id   | name |
+------+------+
| 7    | Test |
+------+------+

Developing

Prerequisites:

• Steampipe
• Golang

Clone:

git clone https://github.com/1024pix/steampipe-plugin-metabase.git
cd steampipe-plugin-metabase

Build, which automatically installs the new version to your ~/.steampipe/plugins directory:

make

Configure the plugin:

cp config/* ~/.steampipe/config
vi ~/.steampipe/config/metabase.spc

Try it!

steampipe query
> .inspect metabase

Further reading:

• Writing plugins
• Writing your first table

Contributing

Please see the contribution guidelines and our code of conduct. All contributions are subject to the Apache 2.0 open source license.

help wanted issues:

• Steampipe
• Metabase Plugin