Skip to content

Commit fb0eef2

Browse files
committed
Update entry pages
1 parent c7fb314 commit fb0eef2

File tree

4 files changed

+22
-36
lines changed

4 files changed

+22
-36
lines changed

config.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -180,9 +180,9 @@ enable = false
180180
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
181181
[[params.links.developer]]
182182
name = "Twitter"
183-
url = "https://twitter.com/asdine_"
183+
url = "https://twitter.com/genjidb"
184184
icon = "fab fa-twitter"
185-
desc = "Follow me on Twitter to get the latest news!"
185+
desc = "Follow us on Twitter to get the latest news!"
186186
[[params.links.developer]]
187187
name = "GitHub"
188188
url = "https://github.com/genjidb/genji"

content/en/_index.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,16 @@ <h2 class="m-auto">What is Genji?</h2>
3939
{{< blocks/section >}}
4040

4141
{{% blocks/feature icon="fas fa-database" title="The power of SQL with documents" %}}
42-
Run powerful SQL queries on rich documents without limits
42+
Run powerful queries on rich documents with an expressive SQL syntax.
4343
{{% /blocks/feature %}}
4444

45-
{{% blocks/feature icon="fa-border-style" title="Optional schema constraints" %}}
46-
Create schemaless tables or specify constraints on selected fields of every documents
45+
{{% blocks/feature icon="fa-border-style" title="Flexible schemas" %}}
46+
Create tables with strict schemas, partial schemas, or no schemas at all
47+
to control your data the way you want it.
4748
{{% /blocks/feature %}}
4849

49-
{{% blocks/feature icon="fas fa-rocket" title="Optimize for your workload" %}}
50-
Store data on disk or in-memory, use a B-Tree or an LSM tree. Choose the right engine that covers your needs or create
51-
one
50+
{{% blocks/feature icon="fas fa-rocket" title="Feature rich" %}}
51+
Fully serializable transactions, in-memory mode, memory usage control, and more.
5252
{{% /blocks/feature %}}
5353

5454
{{< /blocks/section >}}

content/en/docs/_index.md

+11-13
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,22 @@ It combines the power of **SQL** with the versatility of **documents** to provid
1414

1515
Here is a list of Genji's main features:
1616

17-
- **Optional schemas**: Genji tables are schemaless, but it is possible to add constraints on any field to ensure the coherence of data within a table.
18-
- **Multiple Storage Engines**: It is possible to store data on disk or in ram, but also to choose between B-Trees and LSM trees. Genji relies on [BoltDB](https://github.com/etcd-io/bbolt) and [Badger](https://github.com/dgraph-io/badger) to manage data.
19-
- **Transaction support**: Read-only and read/write transactions are supported by default.
20-
- **SQL and Documents**: Genji mixes the best of both worlds by combining powerful SQL commands with JSON _dot notation_.
21-
- **Easy to use, easy to learn**: Genji was designed for simplicity in mind. It is really easy to insert and read documents of any shape.
17+
- **SQL and documents**: Use a powerful SQL language designed for documents as first-class citizen.
18+
- **Flexible schemas**: Define your table with strict schemas, partial schemas, or no schemas at all.
19+
- **Transaction support**: Fully serializable transactions with multiple readers and single writer. Readers don't block writers and writers don't block readers.
2220

2321
## Concepts
2422

2523
Genji's main concepts are not new and semantics have been chosen to match as much as possible what is already existing in other databases:
2624

27-
| Classic SQL databases | Genji |
28-
| --------------------- | ----------------- |
29-
| Table | Table |
30-
| Row | Document |
31-
| Column | Field |
32-
| Schema | Field constraints |
25+
| Classic SQL databases | Genji |
26+
| --------------------- | -------- |
27+
| Table | Table |
28+
| Schema | Schema |
29+
| Row | Document |
30+
| Column | Field |
3331

34-
- **Table**: A collection of documents. Tables are schemaless by default and support optional
32+
- **Table**: A collection of documents
33+
- **Schema**: A list of constraints that apply on all or certain fields of every documents of the table.
3534
- **Document**: A list of fields
3635
- **Field**: A key-value pair
37-
- **Field constraint**: A constraint validated against a field of every inserted or updated document

content/en/docs/getting-started.md

+3-15
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ description: >
99

1010
## Prerequisites
1111

12-
Genji requires at least Go 1.16.
12+
Genji requires at least Go 1.18.
1313

1414
## Installation
1515

@@ -41,22 +41,10 @@ genji
4141

4242
You can then enter your [SQL queries]({{< relref "/getting-started" >}}) directly in the shell.
4343

44-
It is also possible to create an on-disk database, using either [BoltDB](https://github.com/etcd-io/bbolt) or [Badger](https://github.com/dgraph-io/badger).
45-
46-
### On-disk database using BoltDB
47-
48-
Run the `genji` command followed by the name of the database file of your choice.
49-
50-
```bash
51-
genji my.db
52-
```
53-
54-
### On-disk database using Badger
55-
56-
Run the following command by replacing `pathToDBDir` by the directory of your choice.
44+
It is also possible to create an on-disk database by specifying a directory:
5745

5846
```bash
59-
genji --badger pathToDBDir
47+
genji mydb
6048
```
6149

6250
## Next step

0 commit comments

Comments
 (0)