|
1 |
| -# Accio |
| 1 | +<p align="center"> |
| 2 | + <img src="https://imgur.com/xUamgKl.png" width="1000" > |
| 3 | +</p> |
2 | 4 |
|
3 |
| -This project is a metric layer framework which follow Postgres Wire Protocol to communicate with its client. |
4 |
| -Its codebase is based on [Trino](https://github.com/trinodb/trino) project and the part of |
5 |
| -Postgres Wire Protocol in [CrateDB](https://github.com/crate/crate) project. |
| 5 | +<p align="center"> |
| 6 | + <a aria-label="Canner" href="https://cannerdata.com/"> |
| 7 | + <img src="https://img.shields.io/badge/%F0%9F%A7%A1-Made%20by%20Canner-orange?style=for-the-badge"> |
| 8 | + </a> |
| 9 | + <a aria-label="License" href="https://github.com/Canner/vulcan-sql/blob/develop/LICENSE"> |
| 10 | + <img alt="" src="https://img.shields.io/github/license/canner/vulcan-sql?color=orange&style=for-the-badge"> |
| 11 | + </a> |
| 12 | + <a aria-label="Join the community on GitHub" href="https://discord.gg/ztDz8DCmG4"> |
| 13 | + <img alt="" src="https://img.shields.io/badge/-JOIN%20THE%20COMMUNITY-orange?style=for-the-badge&logo=discord&logoColor=white&labelColor=grey&logoWidth=20"> |
| 14 | + </a> |
| 15 | +</p> |
6 | 16 |
|
7 |
| -# How to build |
| 17 | +## What is Accio |
8 | 18 |
|
9 |
| -```shell |
10 |
| -mvn clean install -DskipTests |
11 |
| -``` |
| 19 | +Define relationships, metrics, and expressions consistently with [Accio](https://www.getaccio.ai/). Experience a unified data view and let us generate on-demand SQL for a |
| 20 | +composable, reusable approach. |
12 | 21 |
|
13 |
| -# How to Run |
| 22 | +Accio unites your data in one expansive view, putting an end to scattered metrics and inconsistent queries. We enable the definition of relationships and easy computation of |
| 23 | +metrics. By generating SQL on-demand, we ensure a consistent, composable, and reusable approach, making data analytics smoother and more efficient. |
14 | 24 |
|
15 |
| -## Required Configuration |
| 25 | + |
16 | 26 |
|
17 |
| -- `etc/config.properties` |
| 27 | +## Examples |
18 | 28 |
|
19 |
| -for bigquery settings |
| 29 | +Need Inspiration?! Discover a [selected compilation of examples](https://www.getaccio.ai/docs/example/tpch) showcasing the use of Accio! |
20 | 30 |
|
21 |
| -``` |
22 |
| -node.environment= |
23 |
| -bigquery.project-id= # The target BigQuery project |
24 |
| -bigquery.credentials-key= # based 64 credentials key |
25 |
| -bigquery.location= # BigQuery execution region |
26 |
| -bigquery.bucket-name= # GCS bucket name |
27 |
| -duckdb.storage.access-key= # GCS storage access key |
28 |
| -duckdb.storage.secret-key= # GCS storage secret key |
29 |
| -accio.file= # accio mdl json file path |
30 |
| -``` |
| 31 | +## Installation |
31 | 32 |
|
32 |
| -- VM options |
| 33 | +Please visit [the installation guide](https://www.getaccio.ai/docs/get-started/installation). |
33 | 34 |
|
34 |
| -``` |
35 |
| --Dconfig=etc/config.properties # the path of config file |
36 |
| -``` |
| 35 | +## How Accio works? |
| 36 | + |
| 37 | +💻 **Modeling** |
| 38 | + |
| 39 | +Accio introduces a powerful Model Definition Language (MDL) enabling you to shape your data effortlessly. Transform your tables into `Models` and establish connections |
| 40 | +using `Relations`. Unlock the true potential of Business Intelligence (BI) by formulating impactful `Metrics` with Accio's intuitive MDL. |
| 41 | + |
| 42 | +🚀 **Access** |
| 43 | + |
| 44 | +Accio offers a join-free SQL solution that allows users to query models as if accessing one expensive view. Focuses on enabling users to effortlessly perform BI-style queries. |
| 45 | +Traditional SQL users can easily write readable and semantically rich SQL queries that are also easy to maintain. |
| 46 | + |
| 47 | +🔥 **Deliver** |
| 48 | + |
| 49 | +Accio implements the PostgreSQL Wire Protocol for easy integration, enabling users to effortlessly deliver data to existing systems and various tools, such as BI tools and Database |
| 50 | +IDEs. |
| 51 | + |
| 52 | +## Documentation |
| 53 | + |
| 54 | +More details, please see our [documentation](https://www.getaccio.ai/docs/get-started/intro)! |
| 55 | + |
| 56 | +## Community |
| 57 | + |
| 58 | +- Welcome to our [Discord server](https://discord.gg/ztDz8DCmG4) to give us feedback! |
| 59 | +- If there is any issues, please visit [Github Issues](https://github.com/Canner/accio/issues). |
| 60 | + |
| 61 | +## Special Thanks |
| 62 | + |
| 63 | +- [Trino](https://github.com/trinodb/trino) |
| 64 | + |
| 65 | + Accio's SQL analysis layer is fundamentally based on a modified version of Trino's SQL analysis engine. Trino's clean, readable, and maintainable SQL analysis layer served as a |
| 66 | + significant inspiration, allowing us to focus more on researching and exploring Accio's syntax and models. |
| 67 | +- [CrateDB](https://github.com/crate/crate) |
| 68 | + |
| 69 | + Accio's PostgreSQL Wire Protocol is inspired by CrateDB. CrateDB's implementation of the PostgreSQL Wire Protocol is very clear and easy to maintain, which significantly helped |
| 70 | + us clarify the focus and architecture during the early development stages. This allowed us to concentrate on researching and exploring Accio's syntax and models. |
0 commit comments