https://github.com/1024pix/steampipe-plugin-metabase
Use SQL to query databases, tables, permissions and more from Metabase
https://github.com/1024pix/steampipe-plugin-metabase
pix-captains
Last synced: 14 days ago
JSON representation
Use SQL to query databases, tables, permissions and more from Metabase
- Host: GitHub
- URL: https://github.com/1024pix/steampipe-plugin-metabase
- Owner: 1024pix
- License: apache-2.0
- Created: 2023-06-15T14:02:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:05:26.000Z (6 months ago)
- Last Synced: 2025-03-27T07:21:55.675Z (about 1 month ago)
- Topics: pix-captains
- Language: Go
- Homepage:
- Size: 1.22 MB
- Stars: 4
- Watchers: 12
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Metabase Plugin for Steampipe
Use SQL to query databases, tables, permissions and more from Metabase.
- **[Get started →](https://hub.steampipe.io/plugins/1024pix/metabase)**
- Documentation: [Table definitions & examples](https://hub.steampipe.io/plugins/1024pix/metabase/tables)
- Community: [Join #steampipe on Slack →](https://turbot.com/community/join)
- Get involved: [Issues](https://github.com/1024pix/steampipe-plugin-metabase/issues)
## Quick start
### Install
Download and install the latest Metabase plugin:
```bash
steampipe plugin install ghcr.io/1024pix/metabase
```
Metabase requires a [token](https://www.metabase.com/learn/administration/metabase-api#authenticate-your-requests-with-a-session-token) or a login username and password.
Configure your account details in `~/.steampipe/config/metabase.spc`:
```hcl
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:
```sh
export METABASE_USER=janedoe
export METABASE_PASSWORD=my_password
```
Run steampipe:
```shell
steampipe query
```
List database in your Metabase instance:
```sql
select
id,
name
from
metabase_db;
```
```
+------+------+
| id | name |
+------+------+
| 7 | Test |
+------+------+
```
## Developing
Prerequisites:
- [Steampipe](https://steampipe.io/downloads)
- [Golang](https://golang.org/doc/install)
Clone:
```sh
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](https://steampipe.io/docs/develop/writing-plugins)
- [Writing your first table](https://steampipe.io/docs/develop/writing-your-first-table)
## Contributing
Please see the [contribution guidelines](https://github.com/turbot/steampipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/steampipe/blob/main/CODE_OF_CONDUCT.md). All contributions are subject to the [Apache 2.0 open source license](https://github.com/1024pix/steampipe-plugin-metabase/blob/main/LICENSE).
`help wanted` issues:
- [Steampipe](https://github.com/turbot/steampipe/labels/help%20wanted)
- [Metabase Plugin](https://github.com/1024pix/steampipe-plugin-metabase/labels/help%20wanted)