Skip to content
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

Prepare v1.0.2 release changes #45

Merged
merged 3 commits into from
Sep 19, 2023
Merged

Prepare v1.0.2 release changes #45

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
af18813
Prepare v1.0.2 release changes
bobbyiliev Sep 19, 2023
5830f7d
Add a reference for the Metabase cloud
bobbyiliev Sep 19, 2023
683b6a2
Update README.md
bobbyiliev Sep 19, 2023
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
20 changes: 17 additions & 3 deletions README.md
View file
Open in desktop
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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like it's missing a link!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The two links are defined here:

https://github.com/MaterializeInc/metabase-materialize-driver/pull/45/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R52-R53


```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:
bobbyiliev marked this conversation as resolved.
Show resolved Hide resolved

| 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
View file
Open in desktop
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