Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify SuperSQL relation to SQL in README #5429

Merged
merged 2 commits into from
Nov 3, 2024
+18 −23
Merged

clarify SuperSQL relation to SQL in README #5429

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d7181c
clarify SuperSQL relation to SQL
mccanne Nov 3, 2024
a8e4127
address PR feedback
mccanne Nov 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 18 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@ JSON data model in a unified compute engine.

## SuperSQL

SuperDB uses SQL as its query language, but it's a SQL that has been extended
with [pipe syntax](https://research.google/pubs/sql-has-problems-we-can-fix-them-pipe-syntax-in-sql/)
and [lots of fun shortcuts](https://zed.brimdata.io/docs/language/pipeline-model#implied-operators).
This extended SQL is called SuperSQL.

Here's a SuperSQL query that fetches some data from GitHub Archive,
computes the set of repos touched by each user, ranks them by number of repos,
picks the top five, and joins each user with their original `created_at` time
Expand Down Expand Up @@ -76,29 +81,19 @@ SuperDB can also run on a
[super-structured data lake](https://zed.brimdata.io/docs/commands/zed/#the-lake-model)
using the `super db` sub-commands.

## Piped Query Syntax

The long-term goal for SuperDB's SQL syntax (SuperSQL) is to be Postgres-compatible and interoperate
with BI tools though this is currently a roadmap item. At the same time, the project
seeks to forge new ground on the usability of SQL for data exploration. To this end,
SuperSQL supports the
[pipe query syntax](https://github.com/google/zetasql/blob/master/docs/pipe-syntax.md)
of GoogleSQL, recently described in their
[VLDB 2024 paper](https://research.google/pubs/sql-has-problems-we-can-fix-them-pipe-syntax-in-sql/).

In addition to the GoogleSQL syntax, SuperSQL includes additional pipeline
operators to enhance usability, e.g., for search, for traversing
highly nested JSON, for data shaping, etc.

To facilitate real-time, data exploration use cases,
SuperDB supports an abbreviated form of SuperSQL called
[SuperPipe](https://zed.brimdata.io/docs/language).

SuperPipe provides a large number of shortcuts when typing interactive
queries, e.g., implied group-by clauses, dropping keywords,
implied keyword searches, and so forth. Even though SuperPipe is simply
a short-hand form SuperSQL, it sort of looks like the pipeline-style
languages utilized in search systems.
## Project Status

Our long-term goal for SuperSQL is to be Postgres-compatible and interoperate
with existing SQL tooling. In the meantime, SuperSQL is a bit of a moving
target and we would love community engagement to evolve and fine tune its
syntax and semantics.

Our areas of active development include:
* the SuperSQL query language,
* the type-based query compiler and optimizer,
* fast, vectorized ingest of common file formats,
* a complete vectorized runtme, and
* a data lake based on super-structured data.

### SuperDB Desktop - Coming Soon

Expand Down