Skip to content

Commit

Permalink
Prepare v1.0.2 release changes (#45)
Browse files Browse the repository at this point in the history
Co-authored-by: Marta Paes <[email protected]>
  • Loading branch information
bobbyiliev and morsapaes authored Sep 19, 2023
1 parent 1601ab5 commit 6c28d8c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,37 @@ The `metabase-materialize-driver` lets
[Metabase](https://github.com/metabase/metabase) connect to an instance of
[Materialize](https://github.com/MaterializeInc/materialize).

![Choose Materialize from database dropdown](https://github-production-user-asset-6210df.s3.amazonaws.com/21223421/262440951-6439ee5f-2aad-4742-ad54-e7548323f7b7.png)
![Choose Materialize from database dropdown](https://github-production-user-asset-6210df.s3.amazonaws.com/21223421/268976090-6ed5b4b0-abb0-48dc-862f-b2284cb878d7.png)

## To Use the Driver

### With Metabase Cloud

As a Metabase partner driver, the Materialize driver is
included in [Metabase Cloud](https://www.metabase.com/docs/latest/cloud/start) offering.
To use it, simply select Materialize from the database dropdown when adding a new database.

### With Docker

We provide a pre-built Docker image of Metabase including this driver as
[materialize/metabase][] on Docker Hub. To use it, run:

```bash
docker run -p 3000:3000 materialize/metabase
```

### With self-hosted Metabase

To use the `metabase-materialize-driver` with an existing Metabase
installation, copy a `.jar` file from one of our [releases][] into the
`/plugins` directory of your Metabase instance. Metabase will register the
driver automatically! (For deployment-specific details, please consult the
following sections.)

Once the Materialize driver is registered, use the following information to
connect:
### Connecting to Materialize

Select Materialize from the database dropdown when adding a new database.
Next, use the following information to connect:

| Field | Value |
| ----------------- | ---------------------- |
Expand All @@ -35,6 +47,7 @@ connect:
| Cluster name | **default** |
| Database username | Materialize user. |
| Database password | App-specific password. |
| SSL | **Enabled** |

[releases]: https://github.com/MaterializeInc/metabase-materialize-driver/releases
[materialize/metabase]: https://hub.docker.com/repository/docker/materialize/metabase
Expand All @@ -46,6 +59,7 @@ Metabase Release | Driver Version
v0.46.7 | v0.1.0
v0.47.0 | v1.0.0
v0.47.1 | v1.0.1
v0.47.1 | v1.0.2

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion resources/metabase-plugin.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Reference: https://github.com/metabase/metabase/wiki/Metabase-Plugin-Manifest-Reference
info:
name: Metabase Materialize Driver
version: 1.0.1
version: 1.0.2
description: Allows Metabase to connect to Materialize.
contact-info:
name: Materialize Inc.
Expand Down

0 comments on commit 6c28d8c

Please sign in to comment.