Skip to content

Commit b6c5dbb

Browse files
committed
Add note on spec
1 parent 648bcb8 commit b6c5dbb

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/blueql/1.overview.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ id: overview
33
title: Overview
44
---
55

6-
BlueQL<sup>TM</sup> is Skytable's own query language that very closely follows the design of SQL but with many modern features
7-
and superior security. This document explores a basic overview of BlueQL.
6+
BlueQL<sup>TM</sup> is Skytable's own query language that very closely follows the design of SQL but with many
7+
modern features and superior security. This document explores a basic overview of BlueQL.
88

99
Design principles:
1010
- **Simplicity and clarity**: The language shouldn't be overwhelming to understand
@@ -18,15 +18,20 @@ Just like SQL, BlueQL has three categories of commands/queries inside it:
1818

1919
Jump to [differences from SQL](#differences-from-sql).
2020

21-
## Language specification
21+
:::info
22+
This text is *not* a detailed, formal guide. It's meant for developers and users who want to work with
23+
Skytable. If you need a more formal specification, like a grammar definition, please ask us, and we'll create
24+
it. We haven't published it yet because no one has requested it.
25+
:::
2226

23-
### Identifiers
27+
## Identifiers
2428
Can begin with any ASCII alphabet or an underscore (`_`) and then have any number of alphanumeric characters and/or underscores.
2529

26-
### Keywords
30+
## Keywords
2731

2832
Keywords are identifiers with special meanings and hence can't be used as identifiers in other places. Here's a full-list of
2933
keywords:
34+
3035
```ts
3136
[
3237
"sysctl", "create", "alter", "drop", "use", "inspect", "describe", "insert", "select", "update",
@@ -38,7 +43,7 @@ keywords:
3843
]
3944
```
4045

41-
### Data types
46+
## Data types
4247

4348
#### Boolean
4449
A boolean value, either `true` or `false`
@@ -82,7 +87,7 @@ A boolean value, either `true` or `false`
8287
New data types are frequently added, so treat this list as non-exhaustive.
8388
:::
8489

85-
### Literals
90+
## Literals
8691

8792
- Null literal: `null`
8893
- Numeric literals:
@@ -102,7 +107,7 @@ It is very important for you to know that literals are not allowed everywhere. T
102107
Read below to understand why.
103108
:::
104109
105-
### Parameters
110+
## Parameters
106111
107112
All literals apart from dictionaries and lists must be used as parameters. **BlueQL only allows literals as parameters**. For example, using the Rust client, if you were to run this:
108113
@@ -133,7 +138,7 @@ source, it becomes a parameter. If you try to not use parameters, the query will
133138
On a final note, BlueQL doesn't support comments of any form also for security reasons.
134139
:::
135140

136-
### Expressions
141+
## Expressions
137142

138143
- `+=`: add RHS to LHS
139144
- Can be used outside arithmetic contexts

0 commit comments

Comments
 (0)