@oracle/quicksql
v1.2.12
Published
Quick SQL to DDL and ERD translator
Downloads
702
Readme
Quick SQL
Table of Contents
- Overview
- Install
- Translating Quick SQL into Oracle SQL Data Definition Language (DDL)
- Transforming Quick SQL into an Entity-Relationship Diagram (ERD)
- Contributing
- Security
- 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:
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:
Install
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
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
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
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
<script type="module">
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();
</script>
DDL Browser Universal Module Definition (UMD) Example
<script src="./dist/quick-sql.umd.cjs"></script>
<script>
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();
</script>
Transforming Quick SQL into an Entity-Relationship Diagram (ERD)
Requires a paid library. Review the usage here
Contributing
This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide
Security
Please consult the security guide 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 https://oss.oracle.com/licenses/upl/.