lokavaluto-metabase-sql-scripts

This repository provides a collection of Metabase questions defined through .sql scripts. These SQL files can be imported or executed directly within Metabase to create reusable queries and dashboards for data analysis.

The goal of this repository is to help teams quickly deploy and maintain consistent Metabase analytics across environments.

Lokavaluto's purpose is to pool human and financial resources around the IT issues faced by local currencies. The association relieves local currencies of the need for technical expertise, operational maintenance, technology watch and software development, enabling them to concentrate on their core activity: running and developing local currencies!

This work has been sponsorised by NGI Local for Local european program .

Installation

Prerequisites

Before starting, make sure you have the following installed and configured:

• Metabase (v0.50 or higher)
• Docker (recommended)
• Access to your target databases (e.g., PostgreSQL, MySQL, etc.)
• Proper credentials for connecting Metabase to your data sources

If you want to run Metabase locally using Docker:

docker run -d -p 3000:3000 --name metabase metabase/metabase

Once the container is running, open http://localhost:3000 and complete the initial setup.

---

Configuration

1. Connect Metabase to your databases

From the Metabase Admin panel:

1. Go to Admin Settings → Databases → Add database
2. Fill in your database credentials (host, port, user, password, etc.)
3. Save and test the connection

Make sure the schema you want to query is accessible by the configured user.

WARNING: the SQL script shared here are working ONLY with Metabase connected to :

• an Odoo v16 Postgress database with Lokavaluto's addons
• Comchain or Cyclos transactions backends databases

---

2. Load SQL model from this repository

The file model_transactions_data.sql allows the build of a Metabase model with all the calculated data needed to run queries and display dashboards. You can add them to Metabase manually:

1. Open the SQL file you want to import
2. Copy its content
3. In Metabase, go to “Models”, click on the top left "+"
4. Select "Native querry"
5. Paste the SQL query and save it with a descriptive name

3. Load SQL questions from this repository

Each .sql file in the /queries directory represents a Metabase question. You can add them to Metabase manually:

1. Open the SQL file you want to import
2. Copy its content
3. In Metabase, go to “Ask a Question → Native Query”
4. Select the correct database connection
5. Paste the SQL query and save it with a descriptive name

---

Customization

You can easily adapt the provided SQL scripts to your data model or visualization needs.

• Change schema or table names to match your local configuration.
• Add parameters using Metabase’s variable syntax
• Modify visualization settings (chart type, colors, filters) directly in the Metabase UI.
• Organize questions into collections to group dashboards by theme (e.g., "Transactions", "User Activity", "KYC Data").

If your environment uses multiple data sources (for example Odoo, Cyclos, and Comchain), make sure to adjust the connection ID in your API payloads or within Metabase.

---

Contribution

Contributions are welcome! If you’d like to propose new queries, improve existing ones, or fix issues:

1. Fork the repository
2. Create a new branch for your feature or fix

   git checkout -b feature/new-query

3. Add or modify your .sql scripts in the /queries directory
4. Submit a Pull Request with a clear explanation of your contribution

Guidelines

• Use clear, descriptive filenames (e.g., user_growth_last_30_days.sql)
• Keep queries readable and commented
• Test your queries in Metabase before committing
• Follow the existing project structure and naming conventions

---

Additional Resources

• Metabase Documentation
• Metabase API Reference
• Docker Metabase Image

---

Maintainer:

Lokavaluto - lokavaluto.fr

For any questions or support, please open an issue on GitHub.