_index.md 2.2 KB


title: "SQL Scratchpad" draft: false

weight: 1

The shareable lightweight SQL Editor also called "SQL Scratchpad" comes as its own <sql-scratchpad /> Web component.

The SQL Scratchpad component is in beta and rapidly evolving. Now is a great time to give it a try and send feedback!

Live Demo

The Scratchpad is hosted within this page and points to demo.gethue.com:

{{< rawhtml >}}

<sql-scratchpad api-url="https://demo.gethue.com" username="demo" password="demo" dialect="mysql" />





















{{< /rawhtml >}}

Importing

First install the NPM package and import the component lib and its HTML element directly into the Web page:

<!DOCTYPE html>
<html>

<head>
  <title>SQL Scratchpad</title>
  <script type="text/javascript" src="./node_modules/gethue/lib/components/SqlScratchpadWebComponent.js"></script>
</head>

<body>
  <div style="position: absolute; height: 100%; width: 100%">
    <sql-scratchpad api-url="http://localhost:8005" username="demo" password="demo" dialect="mysql" />
  </div>
</body>

</html>

Then make sure api-url points to a running Hue or Compose APIs. The API is the middleware between your Data Warehouse and Web Browser client and will provide the dynamic content like the list of tables and columns and enrich the static autocomplete powered by the parser selected by the dialect.

Specify the credentials for the authentication via username="demo" password="demo". An option to look-up a local JWT token and not require the credentials is coming shortly.

It is possible to skip the npm install and directly grab the module via:

<script type="text/javascript" src="https://unpkg.com/gethue/lib/components/SqlScratchpadWebComponent.js"></script>