Skip to content

Commit

Permalink
update in-repo docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fredcarle committed Mar 8, 2024
1 parent c566709 commit 501ea13
Show file tree
Hide file tree
Showing 48 changed files with 936 additions and 476 deletions.
27 changes: 17 additions & 10 deletions docs/cli/defradb.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,28 @@ Start a DefraDB node, interact with a local or remote node, and much more.
### Options

```
-h, --help help for defradb
--logformat string Log format to use. Options are csv, json (default "csv")
--logger stringArray Override logger parameters. Usage: --logger <name>,level=<level>,output=<output>,...
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--rootdir string Directory for data and configuration to use (default: $HOME/.defradb)
--url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181")
--allowed-origins stringArray List of origins to allow for CORS requests
-h, --help help for defradb
--logformat string Log format to use. Options are csv, json (default "csv")
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--max-txn-retries int Specify the maximum number of retries per transaction (default 5)
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr strings Listen addresses for the p2p network (formatted as a libp2p MultiAddr) (default [/ip4/127.0.0.1/tcp/9171])
--peers stringArray List of peers to connect to
--privkeypath string Path to the private key for tls
--pubkeypath string Path to the public key for tls
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--store string Specify the datastore to use (supported: badger, memory) (default "badger")
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
--valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824)
```

### SEE ALSO

* [defradb client](defradb_client.md) - Interact with a DefraDB node
* [defradb init](defradb_init.md) - Initialize DefraDB's root directory and configuration file
* [defradb server-dump](defradb_server-dump.md) - Dumps the state of the entire database
* [defradb start](defradb_start.md) - Start a DefraDB node
* [defradb version](defradb_version.md) - Display the version information of DefraDB and its components
Expand Down
24 changes: 16 additions & 8 deletions docs/cli/defradb_client.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,22 @@ Execute queries, add schema types, obtain node info, etc.
### Options inherited from parent commands

```
--logformat string Log format to use. Options are csv, json (default "csv")
--logger stringArray Override logger parameters. Usage: --logger <name>,level=<level>,output=<output>,...
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--rootdir string Directory for data and configuration to use (default: $HOME/.defradb)
--url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181")
--allowed-origins stringArray List of origins to allow for CORS requests
--logformat string Log format to use. Options are csv, json (default "csv")
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--max-txn-retries int Specify the maximum number of retries per transaction (default 5)
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr strings Listen addresses for the p2p network (formatted as a libp2p MultiAddr) (default [/ip4/127.0.0.1/tcp/9171])
--peers stringArray List of peers to connect to
--privkeypath string Path to the private key for tls
--pubkeypath string Path to the public key for tls
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--store string Specify the datastore to use (supported: badger, memory) (default "badger")
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
--valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824)
```

### SEE ALSO
Expand Down
26 changes: 17 additions & 9 deletions docs/cli/defradb_client_backup.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,23 @@ Currently only supports JSON format.
### Options inherited from parent commands

```
--logformat string Log format to use. Options are csv, json (default "csv")
--logger stringArray Override logger parameters. Usage: --logger <name>,level=<level>,output=<output>,...
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--rootdir string Directory for data and configuration to use (default: $HOME/.defradb)
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181")
--allowed-origins stringArray List of origins to allow for CORS requests
--logformat string Log format to use. Options are csv, json (default "csv")
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--max-txn-retries int Specify the maximum number of retries per transaction (default 5)
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr strings Listen addresses for the p2p network (formatted as a libp2p MultiAddr) (default [/ip4/127.0.0.1/tcp/9171])
--peers stringArray List of peers to connect to
--privkeypath string Path to the private key for tls
--pubkeypath string Path to the public key for tls
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--store string Specify the datastore to use (supported: badger, memory) (default "badger")
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
--valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824)
```

### SEE ALSO
Expand Down
26 changes: 17 additions & 9 deletions docs/cli/defradb_client_backup_export.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,23 @@ defradb client backup export [-c --collections | -p --pretty | -f --format] <ou
### Options inherited from parent commands

```
--logformat string Log format to use. Options are csv, json (default "csv")
--logger stringArray Override logger parameters. Usage: --logger <name>,level=<level>,output=<output>,...
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--rootdir string Directory for data and configuration to use (default: $HOME/.defradb)
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181")
--allowed-origins stringArray List of origins to allow for CORS requests
--logformat string Log format to use. Options are csv, json (default "csv")
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--max-txn-retries int Specify the maximum number of retries per transaction (default 5)
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr strings Listen addresses for the p2p network (formatted as a libp2p MultiAddr) (default [/ip4/127.0.0.1/tcp/9171])
--peers stringArray List of peers to connect to
--privkeypath string Path to the private key for tls
--pubkeypath string Path to the public key for tls
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--store string Specify the datastore to use (supported: badger, memory) (default "badger")
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
--valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824)
```

### SEE ALSO
Expand Down
26 changes: 17 additions & 9 deletions docs/cli/defradb_client_backup_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,23 @@ defradb client backup import <input_path> [flags]
### Options inherited from parent commands

```
--logformat string Log format to use. Options are csv, json (default "csv")
--logger stringArray Override logger parameters. Usage: --logger <name>,level=<level>,output=<output>,...
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--rootdir string Directory for data and configuration to use (default: $HOME/.defradb)
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181")
--allowed-origins stringArray List of origins to allow for CORS requests
--logformat string Log format to use. Options are csv, json (default "csv")
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--max-txn-retries int Specify the maximum number of retries per transaction (default 5)
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr strings Listen addresses for the p2p network (formatted as a libp2p MultiAddr) (default [/ip4/127.0.0.1/tcp/9171])
--peers stringArray List of peers to connect to
--privkeypath string Path to the private key for tls
--pubkeypath string Path to the public key for tls
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--store string Specify the datastore to use (supported: badger, memory) (default "badger")
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
--valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824)
```

### SEE ALSO
Expand Down
25 changes: 17 additions & 8 deletions docs/cli/defradb_client_collection.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Create, read, update, and delete documents within a collection.
### Options

```
--get-inactive Get inactive collections as well as active
-h, --help help for collection
--name string Collection name
--schema string Collection schema Root
Expand All @@ -19,14 +20,22 @@ Create, read, update, and delete documents within a collection.
### Options inherited from parent commands

```
--logformat string Log format to use. Options are csv, json (default "csv")
--logger stringArray Override logger parameters. Usage: --logger <name>,level=<level>,output=<output>,...
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--rootdir string Directory for data and configuration to use (default: $HOME/.defradb)
--url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181")
--allowed-origins stringArray List of origins to allow for CORS requests
--logformat string Log format to use. Options are csv, json (default "csv")
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--max-txn-retries int Specify the maximum number of retries per transaction (default 5)
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr strings Listen addresses for the p2p network (formatted as a libp2p MultiAddr) (default [/ip4/127.0.0.1/tcp/9171])
--peers stringArray List of peers to connect to
--privkeypath string Path to the private key for tls
--pubkeypath string Path to the public key for tls
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--store string Specify the datastore to use (supported: badger, memory) (default "badger")
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
--valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824)
```

### SEE ALSO
Expand Down
33 changes: 21 additions & 12 deletions docs/cli/defradb_client_collection_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,27 @@ defradb client collection create <document> [flags]
### Options inherited from parent commands

```
--logformat string Log format to use. Options are csv, json (default "csv")
--logger stringArray Override logger parameters. Usage: --logger <name>,level=<level>,output=<output>,...
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--name string Collection name
--rootdir string Directory for data and configuration to use (default: $HOME/.defradb)
--schema string Collection schema Root
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181")
--version string Collection version ID
--allowed-origins stringArray List of origins to allow for CORS requests
--get-inactive Get inactive collections as well as active
--logformat string Log format to use. Options are csv, json (default "csv")
--loglevel string Log level to use. Options are debug, info, error, fatal (default "info")
--lognocolor Disable colored log output
--logoutput string Log output path (default "stderr")
--logtrace Include stacktrace in error and fatal logs
--max-txn-retries int Specify the maximum number of retries per transaction (default 5)
--name string Collection name
--no-p2p Disable the peer-to-peer network synchronization system
--p2paddr strings Listen addresses for the p2p network (formatted as a libp2p MultiAddr) (default [/ip4/127.0.0.1/tcp/9171])
--peers stringArray List of peers to connect to
--privkeypath string Path to the private key for tls
--pubkeypath string Path to the public key for tls
--rootdir string Directory for persistent data (default: $HOME/.defradb)
--schema string Collection schema Root
--store string Specify the datastore to use (supported: badger, memory) (default "badger")
--tx uint Transaction ID
--url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181")
--valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824)
--version string Collection version ID
```

### SEE ALSO
Expand Down
Loading

0 comments on commit 501ea13

Please sign in to comment.