Update commands docs
This commit is contained in:
parent
5141df3429
commit
e41f53b692
115
docs/Commands.md
115
docs/Commands.md
@ -0,0 +1,115 @@
|
||||
# Command Line Interface
|
||||
|
||||
## run
|
||||
|
||||
Run a ZiQL query on the selected database.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
run QUERY
|
||||
```
|
||||
|
||||
## db
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
db COMMAND
|
||||
```
|
||||
|
||||
### db metrics
|
||||
|
||||
Print some metrics from the db, including: Size on disk and number of entities stored.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
db metrics [OPTIONS]
|
||||
```
|
||||
|
||||
**Options:**
|
||||
|
||||
Name | Type | Description | Default
|
||||
---- | ---- | ------------------- | ----
|
||||
TODO | TODO | TODO | TODO
|
||||
|
||||
### db new
|
||||
|
||||
Create a new empty directory that can be then initialize with a schema.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
db new path/to/dir [OPTIONS]
|
||||
```
|
||||
|
||||
**Options:**
|
||||
|
||||
Name | Type | Description | Default
|
||||
---- | ---- | ------------------- | ----
|
||||
TODO | TODO | TODO | TODO
|
||||
|
||||
### db use
|
||||
|
||||
Select an already created database with `db new`.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
db use path/to/dir [OPTIONS]
|
||||
```
|
||||
|
||||
**Options:**
|
||||
|
||||
Name | Type | Description | Default
|
||||
---- | ---- | ------------------- | ----
|
||||
TODO | TODO | TODO | TODO
|
||||
|
||||
### db state - WIP
|
||||
|
||||
Return the state of the database, either `MissingDatabase` if no database selected or `MissingSchema` if no schema was initialize.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
db state
|
||||
```
|
||||
|
||||
## schema
|
||||
|
||||
### schema init
|
||||
|
||||
Initialize the database using a schema file.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
schema use path/to/schema.file [OPTIONS]
|
||||
```
|
||||
|
||||
**Options:**
|
||||
|
||||
Name | Type | Description | Default
|
||||
---- | ---- | ------------------- | ----
|
||||
TODO | TODO | TODO | TODO
|
||||
|
||||
## quit
|
||||
|
||||
Quit the CLI.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
quit
|
||||
```
|
||||
|
||||
## help
|
||||
|
||||
Write an help message.
|
||||
|
||||
**Usage:**
|
||||
|
||||
```
|
||||
help
|
||||
```
|
Loading…
x
Reference in New Issue
Block a user