https://github.com/oracle/quicksql

A library for generating DDL SQL and entity-relationship-diagrams from Quick SQL code
https://github.com/oracle/quicksql

ddl erd quicksql sql

Last synced: 2 days ago
JSON representation

A library for generating DDL SQL and entity-relationship-diagrams from Quick SQL code

• Host: GitHub
• URL: https://github.com/oracle/quicksql
• Owner: oracle
• License: upl-1.0
• Created: 2023-10-25T16:48:51.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-20T00:05:14.000Z (2 months ago)
• Last Synced: 2025-01-15T09:56:12.399Z (9 days ago)
• Topics: ddl, erd, quicksql, sql
• Language: JavaScript
• Homepage:
• Size: 4.81 MB
• Stars: 55
• Watchers: 7
• Forks: 11
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.txt
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Quick SQL 

[![Node.js CI](https://github.com/oracle/quicksql/actions/workflows/node.js.yml/badge.svg)](https://github.com/oracle/quicksql/actions/workflows/node.js.yml)

## Table of Contents 

- [Overview](#overview)

- [Install](#install)

- [Translating Quick SQL into Oracle SQL Data Definition Language (DDL)](#translating-quick-sql-into-oracle-sql-data-definition-language-ddl)

    - [DDL NodeJS ECMA Script Module (ESM) Example](#ddl-nodejs-ecma-script-module-esm-example)

    - [DDL NodeJS Common JS (CJS) Example](#ddl-nodejs-common-js-cjs-example)

    - [DDL Browser ECMA Script Module (ESM) Example](#ddl-browser-ecma-script-module-esm-example)

    - [DDL Browser Universal Module Definition (UMD) Example](#ddl-browser-universal-module-definition-umd-example)

- [Transforming Quick SQL into an Entity-Relationship Diagram (ERD)](#transforming-quick-sql-into-an-entity-relationship-diagram-erd)

- [Contributing](#contributing)

- [Security](#security)

- [License](#license)

## Overview

Quick SQL is a markdown-like shorthand syntax that expands to standards-based

Oracle SQL. It is useful to rapidly design and prototype data models. Take a

look at the example below:

![Quick SQL](./assets/quick-sql-dark.png)

Previously, Quick SQL was only available within Oracle Application Express. This

project reimplements the Quick SQL parser and translator into a JavaScript

library which can be used in both NodeJS and the browser.

This repository also includes a Quick SQL to Entity Relationship Diagram

module that can be used as seen in the example below:

![Quick ERD](./assets/quick-erd-dark.png)

## Install

```bash

npm install @oracle/quicksql

```

## Translating Quick SQL into Oracle SQL Data Definition Language (DDL)

The Quick SQL to DDL translator is the product's core component, It allows users

to transform a Quick SQL string into an Oracle SQL string.

The Quick SQL Syntax and Grammar are documented [here](./doc/user/quick-sql-grammar.md)

See below for examples of how to use this library.

### Command Line Usage

NPXJS regitry already contains package with conflicting name. To disambiguate, please use command like this:

```

npx @oracle/quicksql test/apex/department_employees.qsql > output.sql

```

### DDL NodeJS ECMA Script Module (ESM) Example

```js

import { quicksql } from "@oracle/quicksql";

import fs from "fs";

try {

    const text = fs.readFileSync( './test/department_employees.quicksql' );

    console.log( new quicksql( text.toString() ).getDDL() );

} catch( e ) {

    console.error( e );

};

```

### DDL NodeJS Common JS (CJS) Example

```js

const { quicksql } = require( "@oracle/quicksql" );

const fs = require( "fs" );

try {

    const text = fs.readFileSync( './test/department_employees.quicksql' );

    console.log( new quicksql( text.toString() ).getDDL() );

} catch( e ) {

    console.error( e );

};

```

### DDL Browser ECMA Script Module (ESM) Example

```html

    import { quicksql } from './dist/quick-sql.js';

    document.body.innerText = new quicksql(

`departments /insert 2

    name /nn

    location

    country

    employees /insert 4

        name /nn vc50

        email /lower

        cost center num

        date hired

        job vc255

view emp_v departments employees

# settings = { "prefix": null, "semantics": "CHAR", "DV": false }

`

    ).getDDL();

```

### DDL Browser Universal Module Definition (UMD) Example

```html

    document.body.innerText = new quickSQL.quicksql(

`departments /insert 2

    name /nn

    location

    country

    employees /insert 4

        name /nn vc50

        email /lower

        cost center num

        date hired

        job vc255

view emp_v departments employees

# settings = { "prefix": null, "semantics": "CHAR", "DV": false }

`

    ).toDDL();

```

## Transforming Quick SQL into an Entity-Relationship Diagram (ERD)

Requires a paid library. Review the usage [here](./doc/user/quick-erd.md)

## Contributing

This project welcomes contributions from the community. Before submitting a pull

request, please [review our contribution guide](./CONTRIBUTING.md)

## Security

Please consult the [security guide](./SECURITY.md) for our responsible security

vulnerability disclosure process

## License

Copyright (c) 2023 Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at

.