Skip to content

Commit 17a1240

Browse files
committed
arch: fix typos and reorganize
1 parent 3fe2d9b commit 17a1240

File tree

7 files changed

+15
-7
lines changed

7 files changed

+15
-7
lines changed
File renamed without changes.
File renamed without changes.

docs/4.architecture.md renamed to docs/c.architecture.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,20 @@ id: architecture
33
title: Architecture
44
---
55

6-
Skytable is a modern NoSQL database that prioritises performance, scalability and reliability while providing a rich and powerful querying interface. We are generally targetting an audience that wants to build high performance, large-scale, low latency applications, such as social networking services, auth services, adtech and such. Skytable is designed to work with
7-
both **structured and semi-structured data**.
6+
Skytable is a modern NoSQL database that prioritises performance, scalability and reliability while providing a rich and powerful querying interface.
7+
We are generally targetting an audience that wants to build high performance, large-scale, low latency applications, such as social networking services,
8+
auth services, adtech and such. Skytable is designed to work with both **structured and semi-structured data**.
89

9-
Our goal is to provide you with a powerful and solid foundation for your application with no gimmicks — just a solid core. That's why, every component in Skytable has been engineered from the ground up, from scratch.
10+
Our goal is to provide you with a powerful and solid foundation for your application with no gimmicks — just a solid core. That's why, every component in
11+
Skytable has been engineered from the ground up, from scratch.
1012

1113
And all of that, without you having to be an expert, and with the least maintenance that you can expect.
1214

1315
## Fundamental differences from relational systems
1416

15-
BlueQL kind of looks and feels like using SQL with a relational database but that doesn't make Skytable's internals the same, with the most important distinction being the fact that Skytable has a NoSQL engine! But Skytable's evaluation and execution of queries is fundamentally different from SQL counterparts and even NoSQL engines. Here are some key differences:
17+
BlueQL kind of looks and feels like using SQL with a relational database but that doesn't make Skytable's internals the same, with the most important
18+
distinction being the fact that Skytable has a NoSQL engine! But Skytable's evaluation and execution of queries is fundamentally different from SQL
19+
counterparts and even NoSQL engines. Here are some key differences:
1620

1721
- All DML queries are point queries and **not** range queries:
1822
- This means that they will either return atleast one row or error
@@ -64,7 +68,7 @@ A `model` in Skytable is like a `table` in SQL but is vastly different because o
6468

6569
## Query language
6670

67-
Skytable has it's own query language BlueQL<sup>TM</sup> which takes a lot of inspiration from SQL but makes several different (and sometimes vastly different) design choices, focused on clarity, speed, simplicity and most importantly, security.
71+
Skytable has its own query language BlueQL<sup>TM</sup> which takes a lot of inspiration from SQL but makes several different (and sometimes vastly different) design choices, focused on clarity, speed, simplicity and most importantly, security.
6872

6973
For example, Skytable's BlueQL<sup>TM</sup> *only* allows the parameterization of queries. All the queries you ran previously with strings and numbers directly were only possible because the REPL client smartly does the paramterization behind the scenes. This is done for security. You'll learn more about BlueQL next.
7074

@@ -99,12 +103,15 @@ Skytable will use atleast as many threads as the number of logical CPUs present
99103

100104
## Networking
101105

102-
Skytable its own in-house Skyhash protocol that is built on top of TCP enabling any programming language that has a TCP client to use it without issues. There are three phases in the connection:
106+
Skytable uses its own in-house Skyhash protocol for client-server communication. It is built on top of TCP, enabling any programming language that has a
107+
TCP client to use it without issues. There are three phases in the connection:
103108
- Handshake: All auth data, compatibility information and other data is exchanged at this step
104109
- Connection mode selection: based on the handshake parameters a connection mode is chosen and the server responds with the chosen exchange mode
105110
- Data exchange: This is where the real querying happens
106111
- Termination: there is no special step; just a `TCP FIN`
107112

113+
You can [read more about the protocol here](protocol).
114+
108115
## Backwards compatibility
109116

110117
We make the promise to you that no matter what changes in Skytable, you will always be able to:
@@ -115,6 +122,7 @@ More technically:
115122
- **For minor/patch releases**: The minor/patch is just in the name but it indicates that no data migration effort is needed. **No minor releases ever need data migration, and any migration is done automatically**
116123
- **For major releases**: Major releases generally introduce breaking changes (just like the upgrade from `0.7.x` to `0.8.0` is a largely breaking change). **Major releases will either automatically upgrade the data files or require you to use a migration tool that is shipped with the bundle**.
117124
- Definitions (closely following semantic versioning):
118-
- **A major release** is something like `1.0.0` to `2.0.0` or `0.8.0` to `0.9.0` (in development versions, 0.8.0 to 0.9.0 is a major version bump)
125+
- **A major release** is something like `1.0.0` to `2.0.0` or `0.8.0` to `0.9.0` (in development versions, 0.8.0 to 0.9.0 is considered a major version
126+
bump)
119127
- **A minor release** is something like `1.0.0` to `1.1.0` or `0.8.0` to `0.8.1`
120128
- **A patch release** is something like `1.0.0` to `1.0.1` or `0.8.0` to `0.8.1` (note that in development versions there is no distinction between a minor and patch release)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)