Skip to content

Commit

Permalink
adding config screenshot
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrohr committed Feb 7, 2025
1 parent 51e35e5 commit 123ca8b
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/how_to_connect_to_the_datastore.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ We provide two instances of the ClickhouseDB:

Both are available using the port 8123. The endpoints above are just addresses, clicking on them will not lead to any page.

The production instance has our current data, which was tested and validated. The development instance has our current work in progress, work and it is usually used to share ideas with other groups before the final work is officially released in production.
The production instance has our current publicly available data. The development instance has our current work in progress and it is usually used to share ideas with other groups before the final content is officially released in production.

There are several forms to connect to a Clickhouse database.

Expand All @@ -21,10 +21,18 @@ clickhouse-client --host=datastore.catalog.igvf.org --port=8123 --user=<username

Please contact our group to receive a username and password.

We recommend using a client interface to interact with our database. It is easier and doesn't require much more knowledge of Clickhouse to explore our data.
We recommend using a database management tool to interact with our database. It is easier and doesn't require much more knowledge of Clickhouse to explore the data.

One free client that supports connection to ClickhouseDB is DBVisualizer (https://www.dbvis.com/).

To set up DBVisualizer, create a new Database Connection and select Clickhouse.

As the database server name, use: `datastore.catalog.igvf.org` or `datastore-dev.catalog.igvf.org`, for the database port use `8123`, and for the database value, use `igvf`. Next, add your credentials to Userid and Password.

Here is the configuration screenshot for DBVisualizer Free version 24.2.2:

![DBVisualizer Configuration](imgs/clickhouse-dbvisualizer.png)

Once the connection is established, you should be able to explore all available tables and run queries.

For more information about how you can query the data, please check the official ClickhouseDB documentation at https://clickhouse.com/docs/en/guides/writing-queries.
Binary file added docs/imgs/clickhouse-dbvisualizer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 123ca8b

Please sign in to comment.