https://github.com/allantargino/sql2cdm

A CLI that allows you to quickly scaffold a Common Data Model (CDM) folder using either an existing relational database or plain SQL DDL.
https://github.com/allantargino/sql2cdm

Last synced: 16 days ago
JSON representation

A CLI that allows you to quickly scaffold a Common Data Model (CDM) folder using either an existing relational database or plain SQL DDL.

• Host: GitHub
• URL: https://github.com/allantargino/sql2cdm
• Owner: allantargino
• License: mit
• Created: 2021-02-06T00:09:43.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-02-06T01:00:03.000Z (almost 4 years ago)
• Last Synced: 2023-03-09T07:06:56.997Z (over 1 year ago)
• Language: C#
• Size: 57.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sql2cdm

## Overview

This project allows you to quickly scaffold a [Common Data Model (CDM)](https://docs.microsoft.com/en-us/common-data-model/) folder using [SQL DDL](https://en.wikipedia.org/wiki/Data_definition_language) and

custom annotations in form of SQL comments:

```sql

CREATE TABLE Customer

(

	CUSTOMER_ID INT IDENTITY(1,1) PRIMARY KEY,

	CUSTOMER_NAME VARCHAR(50) NOT NULL /* {trait:means.fullname} */

);

CREATE TABLE CustomerAddresses

(

	CUSTOMER_ADDRESS_ID INT IDENTITY(1,1) PRIMARY KEY /* {trait:means.identity; trait:is.dataFormat.integer} */,

	CUSTOMER_ID INT NOT NULL,

	ADDRESS VARCHAR(100) NOT NULL /* {trait:means.address.main} */,

	FOREIGN KEY(CUSTOMER_ID) REFERENCES Customer(CUSTOMER_ID)

);

CREATE TABLE VipCustomer /* {extends:Customer} */(

	SPECIAL_CARD_NUMBER CHAR(10) NOT NULL

);

```

```shell

sql2cdm -i /sql/customer.sql -o ./cdm-generated

```

## Quick Start

### Requirements

- [.NET Core 5.0](https://dotnet.microsoft.com/download)

### Steps

1. Clone this repository on your machine.

2. Build and publish the project:

```shell

dotnet restore --interactive

dotnet publish --no-restore ./src/Sql2Cdm.CLI -o ./cli

```

> If you have problems with NuGet authentication, please check [this document](https://docs.microsoft.com/en-us/nuget/consume-packages/consuming-packages-authenticated-feeds).

3. Run the CLI using [`customer.sql`](./sql/customer.sql) sample:

```shell

dotnet ./cli/Sql2Cdm.CLI.dll -i ./sql/customer.sql -o ./cdm-generated

```

## Additional Documentation

- [Docker Quick Start](./docs/dev/docker-quick-start.md)

- [Command Diagrams](./docs/dev/command-diagrams.md)

- [SQLite Relational Model Reader](./docs/dev/relational-model-readers/sqlite.md)