https://github.com/squashql/squashql-codegen
Generate type definitions that represent tables and fields from your database
https://github.com/squashql/squashql-codegen
Last synced: 23 days ago
JSON representation
Generate type definitions that represent tables and fields from your database
- Host: GitHub
- URL: https://github.com/squashql/squashql-codegen
- Owner: squashql
- License: apache-2.0
- Created: 2023-08-02T09:06:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-30T08:49:08.000Z (over 2 years ago)
- Last Synced: 2025-12-26T04:02:39.205Z (6 months ago)
- Language: TypeScript
- Homepage:
- Size: 180 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SquashQL Codegen
This tool is inspired by [Kysely Codegen](https://github.com/RobinBlomberg/kysely-codegen)
squashql-codegen generates type definitions that represent tables and fields from your database in ts file named `tables.ts`.
It fetches from a database the list of available tables and fields and creates a typescript file with this information. The
types can be used with the [TypeScript library](https://www.npmjs.com/package/@squashql/squashql-js) to build SQL-like queries compatible with SquashQL.
## NPM
[https://www.npmjs.com/package/@squashql/squashql-codegen](https://www.npmjs.com/package/@squashql/squashql-codegen)
## Support
Only the following databases are supported for the time being:
- [BigQuery](#bigquery)
- [Snowflake](#snowflake)
Example:
```typescript
import {TableField} from "@squashql/squashql-js"
export interface SquashQLTable {
_fields: TableField[]
_name: string
}
class Product implements SquashQLTable {
readonly _name = "product"
readonly productId: TableField = new TableField("product.product_id")
readonly price: TableField = new TableField("product.price")
readonly brand: TableField = new TableField("product.brand")
readonly categoryId: TableField = new TableField("product.category_id")
readonly _fields: TableField[] = [this.productId, this.price, this.brand, this.categoryId]
}
class Category implements SquashQLTable {
readonly _name = "category"
readonly categoryId: TableField = new TableField("category.category_id")
readonly status: TableField = new TableField("category.status")
readonly _fields: TableField[] = [this.categoryId, this.status]
}
const product = new Product()
const category = new Category()
export {
product, category
}
```
And then you can use it for your calculations that need to use the `Field` interface or the constant . [See the documentation](https://github.com/squashql/squashql/blob/main/documentation/QUERY.md#fields).
```typescript
import {product, category} from "./table"
const price: TableField = product.price
const status: TableField = category.status
const priceName: string = price.name // name of the field is accessible
// ...
```
## Installation & Execution
To install the CLI globally
```
npm install -g @squashql/squashql-codegen
```
To execute the CLI without installing anything
```
npx @squashql/squashql-codegen
```
## Configuration
Create an .env to define a couple of environment variables needed to connect to the database and correctly
execute the script. It is also possible
to [pass the values to the CLI](https://stackoverflow.com/questions/22312671/setting-environment-variables-for-node-to-retrieve)
In each case, a client needs to be created to connect to the DB by setting the env. variable `SQUASHQL_CLIENT`.
To choose where the file should be written, the following env. variable can be set `SQUASHQL_PATH`.
```
# .env file
SQUASHQL_CLIENT="bigquery" # mandatory
SQUASHQL_PATH="/Users/john/tmp" # optional, table.ts will be written in /Users/john/tmp directory
```
### BigQuery
The CLI uses [Application Default Credentials to authenticate](https://cloud.google.com/docs/authentication/application-default-credentials).
```
# .env file
SQUASHQL_CLIENT="bigquery" # mandatory
SQUASHQL_BIGQUERY_DATASET_ID="nameofthedataset" # mandatory
GOOGLE_APPLICATION_CREDENTIALS="/path/to/key.json" # mandatory if this authentication method is used https://cloud.google.com/docs/authentication/application-default-credentials#GAC
```
## Snowflake
```
# .env file
SQUASHQL_CLIENT="snowflake"
# Snowflake
SQUASHQL_SNOWFLAKE_ACCOUNT="abc123.north-europe.azure" # mandatory
SQUASHQL_SNOWFLAKE_USERNAME="john" # mandatory
SQUASHQL_SNOWFLAKE_PASSWORD="mypassword" # mandatory
SQUASHQL_SNOWFLAKE_DATABASE="DATABASE_NAME" # mandatory
SQUASHQL_SNOWFLAKE_SCHEMA="SCHEMA_NAME" # mandatory
```