README.md

star-yaml

Non-proprietary YAML format for star schema and snowflake schema

Goal

• Simple and readable (YAML)
• No dependency on individual table definition (SQL, GraphQL, etc)
• Integration of any table definition
• ONLY join keys will be defined as a connnection among tables

apiVersion: v1
kind: Star
tables:
- name: User
  metadata:
    root: true
  definition:
    type: sql
    url: 'postgres://localhost:5432'
    query: 'users'
  links:
  - to: 'Location'
    as: 'location'
    sameAt:
      address: address
- name: Location
  definition:
    type: graphql-opencrud
    url: 'http://localhost:4021'
    query: 'locations'

Docs

• Definition of TABLES
• Links

Examples

There are example YAMLs to represent each chapter star schemas from Data warehouse toolkit by Ralph Kimball, Mergy Ross

Contents	Chapter	Fact(root) table
Retail Sales	3	RetailSales
Inventory	4	Inventories
Procurement	5	Procurements
GeneralLedger	7	GeneralLedger
CRM	8	Transactions
Human Resource	9	EmployeeTransactions

Tools

• graphql-stargen Mashup gateway automatically generated according to star-yaml description

License

Open source. Apache licence version 2.

Contribution

Feel free to add issues and features.