From dbc82191396dc66e76c4d2fa191ab3e769948e3b Mon Sep 17 00:00:00 2001 From: Shahzad Lone Date: Thu, 23 May 2024 15:46:54 -0400 Subject: [PATCH] docs: Streamline cli documentation (#2646) ## Relevant issue(s) Resolves #2166 Resovles #2645 ## Description - Delete old cli dir - Update make command to generate in the new website dir - Actually update the documents in the new directory. ## How has this been tested? `make docs:cli` Specify the platform(s) on which this was tested: - WSL2 --- Makefile | 3 +- docs/cli/defradb.md | 38 ------------ docs/cli/defradb_client.md | 49 --------------- docs/cli/defradb_client_dump.md | 38 ------------ docs/cli/defradb_client_query.md | 60 ------------------- docs/cli/defradb_client_schema.md | 43 ------------- docs/cli/defradb_client_schema_add.md | 59 ------------------ docs/cli/defradb_client_schema_patch.md | 58 ------------------ docs/cli/defradb_server-dump.md | 36 ----------- docs/cli/defradb_start.md | 49 --------------- docs/cli/defradb_version.md | 38 ------------ docs/website/references/cli/defradb.md | 40 +++++++------ docs/website/references/cli/defradb_client.md | 56 ++++++++++------- .../references}/cli/defradb_client_acp.md | 0 .../cli/defradb_client_acp_policy.md | 0 .../cli/defradb_client_acp_policy_add.md | 0 .../references}/cli/defradb_client_backup.md | 0 .../cli/defradb_client_backup_export.md | 0 .../cli/defradb_client_backup_import.md | 0 .../references/cli/defradb_client_blocks.md | 28 --------- .../cli/defradb_client_blocks_get.md | 31 ---------- .../cli/defradb_client_collection.md | 0 .../cli/defradb_client_collection_create.md | 0 .../cli/defradb_client_collection_delete.md | 0 .../cli/defradb_client_collection_describe.md | 0 .../cli/defradb_client_collection_docIDs.md | 0 .../cli/defradb_client_collection_get.md | 0 .../cli/defradb_client_collection_patch.md | 0 .../cli/defradb_client_collection_update.md | 0 .../references/cli/defradb_client_dump.md | 35 ++++++----- .../references}/cli/defradb_client_index.md | 0 .../cli/defradb_client_index_create.md | 0 .../cli/defradb_client_index_drop.md | 0 .../cli/defradb_client_index_list.md | 0 .../references}/cli/defradb_client_p2p.md | 0 .../cli/defradb_client_p2p_collection.md | 0 .../cli/defradb_client_p2p_collection_add.md | 0 .../defradb_client_p2p_collection_getall.md | 0 .../defradb_client_p2p_collection_remove.md | 0 .../cli/defradb_client_p2p_info.md | 0 .../cli/defradb_client_p2p_replicator.md | 0 .../defradb_client_p2p_replicator_delete.md | 0 .../defradb_client_p2p_replicator_getall.md | 0 .../cli/defradb_client_p2p_replicator_set.md | 0 .../references/cli/defradb_client_peerid.md | 31 ---------- .../references/cli/defradb_client_ping.md | 31 ---------- .../references/cli/defradb_client_query.md | 50 ++++++++++------ .../references/cli/defradb_client_rpc.md | 34 ----------- .../cli/defradb_client_rpc_addreplicator.md | 37 ------------ .../cli/defradb_client_rpc_p2pcollection.md | 35 ----------- .../defradb_client_rpc_p2pcollection_add.md | 36 ----------- ...defradb_client_rpc_p2pcollection_getall.md | 36 ----------- ...defradb_client_rpc_p2pcollection_remove.md | 36 ----------- .../cli/defradb_client_rpc_replicator.md | 37 ------------ .../defradb_client_rpc_replicator_delete.md | 37 ------------ .../defradb_client_rpc_replicator_getall.md | 37 ------------ .../cli/defradb_client_rpc_replicator_set.md | 39 ------------ .../references/cli/defradb_client_schema.md | 44 ++++++++------ .../cli/defradb_client_schema_add.md | 46 ++++++++------ .../cli/defradb_client_schema_describe.md | 0 .../cli/defradb_client_schema_migration.md | 0 .../defradb_client_schema_migration_down.md | 0 .../defradb_client_schema_migration_reload.md | 0 ...db_client_schema_migration_set-registry.md | 0 .../defradb_client_schema_migration_set.md | 0 .../cli/defradb_client_schema_migration_up.md | 0 .../cli/defradb_client_schema_patch.md | 49 ++++++++------- .../cli/defradb_client_schema_set-active.md | 0 .../references}/cli/defradb_client_tx.md | 0 .../cli/defradb_client_tx_commit.md | 0 .../cli/defradb_client_tx_create.md | 0 .../cli/defradb_client_tx_discard.md | 0 .../references}/cli/defradb_client_view.md | 0 .../cli/defradb_client_view_add.md | 0 docs/website/references/cli/defradb_init.md | 36 ----------- .../references}/cli/defradb_keyring.md | 0 .../references}/cli/defradb_keyring_export.md | 0 .../cli/defradb_keyring_generate.md | 0 .../references}/cli/defradb_keyring_import.md | 0 .../references/cli/defradb_server-dump.md | 32 +++++----- docs/website/references/cli/defradb_start.md | 55 +++++++++-------- .../website/references/cli/defradb_version.md | 29 +++++---- 82 files changed, 258 insertions(+), 1170 deletions(-) delete mode 100644 docs/cli/defradb.md delete mode 100644 docs/cli/defradb_client.md delete mode 100644 docs/cli/defradb_client_dump.md delete mode 100644 docs/cli/defradb_client_query.md delete mode 100644 docs/cli/defradb_client_schema.md delete mode 100644 docs/cli/defradb_client_schema_add.md delete mode 100644 docs/cli/defradb_client_schema_patch.md delete mode 100644 docs/cli/defradb_server-dump.md delete mode 100644 docs/cli/defradb_start.md delete mode 100644 docs/cli/defradb_version.md rename docs/{ => website/references}/cli/defradb_client_acp.md (100%) rename docs/{ => website/references}/cli/defradb_client_acp_policy.md (100%) rename docs/{ => website/references}/cli/defradb_client_acp_policy_add.md (100%) rename docs/{ => website/references}/cli/defradb_client_backup.md (100%) rename docs/{ => website/references}/cli/defradb_client_backup_export.md (100%) rename docs/{ => website/references}/cli/defradb_client_backup_import.md (100%) delete mode 100644 docs/website/references/cli/defradb_client_blocks.md delete mode 100644 docs/website/references/cli/defradb_client_blocks_get.md rename docs/{ => website/references}/cli/defradb_client_collection.md (100%) rename docs/{ => website/references}/cli/defradb_client_collection_create.md (100%) rename docs/{ => website/references}/cli/defradb_client_collection_delete.md (100%) rename docs/{ => website/references}/cli/defradb_client_collection_describe.md (100%) rename docs/{ => website/references}/cli/defradb_client_collection_docIDs.md (100%) rename docs/{ => website/references}/cli/defradb_client_collection_get.md (100%) rename docs/{ => website/references}/cli/defradb_client_collection_patch.md (100%) rename docs/{ => website/references}/cli/defradb_client_collection_update.md (100%) rename docs/{ => website/references}/cli/defradb_client_index.md (100%) rename docs/{ => website/references}/cli/defradb_client_index_create.md (100%) rename docs/{ => website/references}/cli/defradb_client_index_drop.md (100%) rename docs/{ => website/references}/cli/defradb_client_index_list.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_collection.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_collection_add.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_collection_getall.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_collection_remove.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_info.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_replicator.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_replicator_delete.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_replicator_getall.md (100%) rename docs/{ => website/references}/cli/defradb_client_p2p_replicator_set.md (100%) delete mode 100644 docs/website/references/cli/defradb_client_peerid.md delete mode 100644 docs/website/references/cli/defradb_client_ping.md delete mode 100644 docs/website/references/cli/defradb_client_rpc.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_addreplicator.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_p2pcollection.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_p2pcollection_add.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_p2pcollection_getall.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_p2pcollection_remove.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_replicator.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_replicator_delete.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_replicator_getall.md delete mode 100644 docs/website/references/cli/defradb_client_rpc_replicator_set.md rename docs/{ => website/references}/cli/defradb_client_schema_describe.md (100%) rename docs/{ => website/references}/cli/defradb_client_schema_migration.md (100%) rename docs/{ => website/references}/cli/defradb_client_schema_migration_down.md (100%) rename docs/{ => website/references}/cli/defradb_client_schema_migration_reload.md (100%) rename docs/{ => website/references}/cli/defradb_client_schema_migration_set-registry.md (100%) rename docs/{ => website/references}/cli/defradb_client_schema_migration_set.md (100%) rename docs/{ => website/references}/cli/defradb_client_schema_migration_up.md (100%) rename docs/{ => website/references}/cli/defradb_client_schema_set-active.md (100%) rename docs/{ => website/references}/cli/defradb_client_tx.md (100%) rename docs/{ => website/references}/cli/defradb_client_tx_commit.md (100%) rename docs/{ => website/references}/cli/defradb_client_tx_create.md (100%) rename docs/{ => website/references}/cli/defradb_client_tx_discard.md (100%) rename docs/{ => website/references}/cli/defradb_client_view.md (100%) rename docs/{ => website/references}/cli/defradb_client_view_add.md (100%) delete mode 100644 docs/website/references/cli/defradb_init.md rename docs/{ => website/references}/cli/defradb_keyring.md (100%) rename docs/{ => website/references}/cli/defradb_keyring_export.md (100%) rename docs/{ => website/references}/cli/defradb_keyring_generate.md (100%) rename docs/{ => website/references}/cli/defradb_keyring_import.md (100%) diff --git a/Makefile b/Makefile index 658b514a4b..bc4093ddbf 100644 --- a/Makefile +++ b/Makefile @@ -359,7 +359,8 @@ docs: .PHONY: docs\:cli docs\:cli: - go run cmd/genclidocs/main.go -o docs/cli/ + rm -f docs/website/references/cli/*.md + go run cmd/genclidocs/main.go -o docs/website/references/cli .PHONY: docs\:manpages docs\:manpages: diff --git a/docs/cli/defradb.md b/docs/cli/defradb.md deleted file mode 100644 index 3edc08b8d9..0000000000 --- a/docs/cli/defradb.md +++ /dev/null @@ -1,38 +0,0 @@ -## defradb - -DefraDB Edge Database - -### Synopsis - -DefraDB is the edge database to power the user-centric future. - -Start a DefraDB node, interact with a local or remote node, and much more. - - -### Options - -``` - -h, --help help for defradb - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a DefraDB node -* [defradb keyring](defradb_keyring.md) - Manage DefraDB private keys -* [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 - diff --git a/docs/cli/defradb_client.md b/docs/cli/defradb_client.md deleted file mode 100644 index 73c029153f..0000000000 --- a/docs/cli/defradb_client.md +++ /dev/null @@ -1,49 +0,0 @@ -## defradb client - -Interact with a DefraDB node - -### Synopsis - -Interact with a DefraDB node. -Execute queries, add schema types, obtain node info, etc. - -### Options - -``` - -h, --help help for client - -i, --identity string ACP Identity - --tx uint Transaction ID -``` - -### Options inherited from parent commands - -``` - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb](defradb.md) - DefraDB Edge Database -* [defradb client acp](defradb_client_acp.md) - Interact with the access control system of a DefraDB node -* [defradb client backup](defradb_client_backup.md) - Interact with the backup utility -* [defradb client collection](defradb_client_collection.md) - Interact with a collection. -* [defradb client dump](defradb_client_dump.md) - Dump the contents of DefraDB node-side -* [defradb client index](defradb_client_index.md) - Manage collections' indexes of a running DefraDB instance -* [defradb client p2p](defradb_client_p2p.md) - Interact with the DefraDB P2P system -* [defradb client query](defradb_client_query.md) - Send a DefraDB GraphQL query request -* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a DefraDB node -* [defradb client tx](defradb_client_tx.md) - Create, commit, and discard DefraDB transactions -* [defradb client view](defradb_client_view.md) - Manage views within a running DefraDB instance - diff --git a/docs/cli/defradb_client_dump.md b/docs/cli/defradb_client_dump.md deleted file mode 100644 index ca831313cd..0000000000 --- a/docs/cli/defradb_client_dump.md +++ /dev/null @@ -1,38 +0,0 @@ -## defradb client dump - -Dump the contents of DefraDB node-side - -``` -defradb client dump [flags] -``` - -### Options - -``` - -h, --help help for dump -``` - -### Options inherited from parent commands - -``` - -i, --identity string ACP Identity - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --tx uint Transaction ID - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a DefraDB node - diff --git a/docs/cli/defradb_client_query.md b/docs/cli/defradb_client_query.md deleted file mode 100644 index 2dcea07526..0000000000 --- a/docs/cli/defradb_client_query.md +++ /dev/null @@ -1,60 +0,0 @@ -## defradb client query - -Send a DefraDB GraphQL query request - -### Synopsis - -Send a DefraDB GraphQL query request to the database. - -A query request can be sent as a single argument. Example command: - defradb client query 'query { ... }' - -Do a query request from a file by using the '-f' flag. Example command: - defradb client query -f request.graphql - -Do a query request from a file and with an identity. Example command: - defradb client query -i cosmos1f2djr7dl9vhrk3twt3xwqp09nhtzec9mdkf70j -f request.graphql - -Or it can be sent via stdin by using the '-' special syntax. Example command: - cat request.graphql | defradb client query - - -A GraphQL client such as GraphiQL (https://github.com/graphql/graphiql) can be used to interact -with the database more conveniently. - -To learn more about the DefraDB GraphQL Query Language, refer to https://docs.source.network. - -``` -defradb client query [-i --identity] [request] [flags] -``` - -### Options - -``` - -f, --file string File containing the query request - -h, --help help for query -``` - -### Options inherited from parent commands - -``` - -i, --identity string ACP Identity - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --tx uint Transaction ID - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a DefraDB node - diff --git a/docs/cli/defradb_client_schema.md b/docs/cli/defradb_client_schema.md deleted file mode 100644 index c69bdaee8f..0000000000 --- a/docs/cli/defradb_client_schema.md +++ /dev/null @@ -1,43 +0,0 @@ -## defradb client schema - -Interact with the schema system of a DefraDB node - -### Synopsis - -Make changes, updates, or look for existing schema types. - -### Options - -``` - -h, --help help for schema -``` - -### Options inherited from parent commands - -``` - -i, --identity string ACP Identity - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --tx uint Transaction ID - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a DefraDB node -* [defradb client schema add](defradb_client_schema_add.md) - Add new schema -* [defradb client schema describe](defradb_client_schema_describe.md) - View schema descriptions. -* [defradb client schema migration](defradb_client_schema_migration.md) - Interact with the schema migration system of a running DefraDB instance -* [defradb client schema patch](defradb_client_schema_patch.md) - Patch an existing schema type -* [defradb client schema set-active](defradb_client_schema_set-active.md) - Set the active collection version - diff --git a/docs/cli/defradb_client_schema_add.md b/docs/cli/defradb_client_schema_add.md deleted file mode 100644 index 9e70bb1f17..0000000000 --- a/docs/cli/defradb_client_schema_add.md +++ /dev/null @@ -1,59 +0,0 @@ -## defradb client schema add - -Add new schema - -### Synopsis - -Add new schema. - -Schema Object with a '@policy(id:".." resource: "..")' linked will only be accepted if: - - ACP is available (i.e. ACP is not disabled). - - The specified resource adheres to the Document Access Control DPI Rules. - - Learn more about [ACP & DPI Rules](/acp/README.md) - -Example: add from an argument string: - defradb client schema add 'type Foo { ... }' - -Example: add from file: - defradb client schema add -f schema.graphql - -Example: add from stdin: - cat schema.graphql | defradb client schema add - - -Learn more about the DefraDB GraphQL Schema Language on https://docs.source.network. - -``` -defradb client schema add [schema] [flags] -``` - -### Options - -``` - -f, --file string File to load a schema from - -h, --help help for add -``` - -### Options inherited from parent commands - -``` - -i, --identity string ACP Identity - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --tx uint Transaction ID - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a DefraDB node - diff --git a/docs/cli/defradb_client_schema_patch.md b/docs/cli/defradb_client_schema_patch.md deleted file mode 100644 index 6c884d0a0f..0000000000 --- a/docs/cli/defradb_client_schema_patch.md +++ /dev/null @@ -1,58 +0,0 @@ -## defradb client schema patch - -Patch an existing schema type - -### Synopsis - -Patch an existing schema. - -Uses JSON Patch to modify schema types. - -Example: patch from an argument string: - defradb client schema patch '[{ "op": "add", "path": "...", "value": {...} }]' '{"lenses": [...' - -Example: patch from file: - defradb client schema patch -p patch.json - -Example: patch from stdin: - cat patch.json | defradb client schema patch - - -To learn more about the DefraDB GraphQL Schema Language, refer to https://docs.source.network. - -``` -defradb client schema patch [schema] [migration] [flags] -``` - -### Options - -``` - -h, --help help for patch - -t, --lens-file string File to load a lens config from - -p, --patch-file string File to load a patch from - --set-active Set the active schema version for all collections using the root schem -``` - -### Options inherited from parent commands - -``` - -i, --identity string ACP Identity - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --tx uint Transaction ID - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a DefraDB node - diff --git a/docs/cli/defradb_server-dump.md b/docs/cli/defradb_server-dump.md deleted file mode 100644 index 403d72c972..0000000000 --- a/docs/cli/defradb_server-dump.md +++ /dev/null @@ -1,36 +0,0 @@ -## defradb server-dump - -Dumps the state of the entire database - -``` -defradb server-dump [flags] -``` - -### Options - -``` - -h, --help help for server-dump -``` - -### Options inherited from parent commands - -``` - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb](defradb.md) - DefraDB Edge Database - diff --git a/docs/cli/defradb_start.md b/docs/cli/defradb_start.md deleted file mode 100644 index 0f2bed427f..0000000000 --- a/docs/cli/defradb_start.md +++ /dev/null @@ -1,49 +0,0 @@ -## defradb start - -Start a DefraDB node - -### Synopsis - -Start a DefraDB node. - -``` -defradb start [flags] -``` - -### Options - -``` - --allowed-origins stringArray List of origins to allow for CORS requests - -h, --help help for start - --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 - --store string Specify the datastore to use (supported: badger, memory) (default "badger") - --valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824) -``` - -### Options inherited from parent commands - -``` - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb](defradb.md) - DefraDB Edge Database - diff --git a/docs/cli/defradb_version.md b/docs/cli/defradb_version.md deleted file mode 100644 index c82cd43df8..0000000000 --- a/docs/cli/defradb_version.md +++ /dev/null @@ -1,38 +0,0 @@ -## defradb version - -Display the version information of DefraDB and its components - -``` -defradb version [flags] -``` - -### Options - -``` - -f, --format string Version output format. Options are text, json - --full Display the full version information - -h, --help help for version -``` - -### Options inherited from parent commands - -``` - --keyring-backend string Keyring backend to use. Options are file or system (default "file") - --keyring-namespace string Service name to use when using the system backend (default "defradb") - --keyring-path string Path to store encrypted keys when using the file backend (default "keys") - --log-format string Log format to use. Options are text or json (default "text") - --log-level string Log level to use. Options are debug, info, error, fatal (default "info") - --log-output string Log output path. Options are stderr or stdout. (default "stderr") - --log-overrides string Logger config overrides. Format ,=,...;,... - --log-source Include source location in logs - --log-stacktrace Include stacktrace in error and fatal logs - --no-keyring Disable the keyring and generate ephemeral keys - --no-log-color Disable colored log output - --rootdir string Directory for persistent data (default: $HOME/.defradb) - --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") -``` - -### SEE ALSO - -* [defradb](defradb.md) - DefraDB Edge Database - diff --git a/docs/website/references/cli/defradb.md b/docs/website/references/cli/defradb.md index 3a38cb52a0..3edc08b8d9 100644 --- a/docs/website/references/cli/defradb.md +++ b/docs/website/references/cli/defradb.md @@ -1,35 +1,37 @@ -# defradb +## defradb DefraDB Edge Database -## Synopsis +### Synopsis DefraDB is the edge database to power the user-centric future. -Start a database node, issue a request to a local or remote node, and much more. +Start a DefraDB node, interact with a local or remote node, and much more. -DefraDB is released under the BSL license, (c) 2022 Democratized Data Foundation. -See https://docs.source.network/BSL.txt for more information. - -## Options +### 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 ,level=,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") + -h, --help help for defradb + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client -* [defradb init](defradb_init.md) - Initialize DefraDB's root directory and configuration file +* [defradb client](defradb_client.md) - Interact with a DefraDB node +* [defradb keyring](defradb_keyring.md) - Manage DefraDB private keys * [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 diff --git a/docs/website/references/cli/defradb_client.md b/docs/website/references/cli/defradb_client.md index 81656acca2..73c029153f 100644 --- a/docs/website/references/cli/defradb_client.md +++ b/docs/website/references/cli/defradb_client.md @@ -1,39 +1,49 @@ -# client +## defradb client -Interact with a running DefraDB node as a client +Interact with a DefraDB node -## Synopsis +### Synopsis -Interact with a running DefraDB node as a client. -Execute queries, add schema types, and run debug routines. +Interact with a DefraDB node. +Execute queries, add schema types, obtain node info, etc. -## Options +### Options ``` - -h, --help help for client + -h, --help help for client + -i, --identity string ACP Identity + --tx uint Transaction ID ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO * [defradb](defradb.md) - DefraDB Edge Database -* [defradb client blocks](defradb_client_blocks.md) - Interact with the database's blockstore -* [defradb client dump](defradb_client_dump.md) - Dump the contents of a database node-side -* [defradb client peerid](defradb_client_peerid.md) - Get the peer ID of the DefraDB node -* [defradb client ping](defradb_client_ping.md) - Ping to test connection to a node +* [defradb client acp](defradb_client_acp.md) - Interact with the access control system of a DefraDB node +* [defradb client backup](defradb_client_backup.md) - Interact with the backup utility +* [defradb client collection](defradb_client_collection.md) - Interact with a collection. +* [defradb client dump](defradb_client_dump.md) - Dump the contents of DefraDB node-side +* [defradb client index](defradb_client_index.md) - Manage collections' indexes of a running DefraDB instance +* [defradb client p2p](defradb_client_p2p.md) - Interact with the DefraDB P2P system * [defradb client query](defradb_client_query.md) - Send a DefraDB GraphQL query request -* [defradb client rpc](defradb_client_rpc.md) - Interact with a DefraDB gRPC server -* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a running DefraDB instance +* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a DefraDB node +* [defradb client tx](defradb_client_tx.md) - Create, commit, and discard DefraDB transactions +* [defradb client view](defradb_client_view.md) - Manage views within a running DefraDB instance diff --git a/docs/cli/defradb_client_acp.md b/docs/website/references/cli/defradb_client_acp.md similarity index 100% rename from docs/cli/defradb_client_acp.md rename to docs/website/references/cli/defradb_client_acp.md diff --git a/docs/cli/defradb_client_acp_policy.md b/docs/website/references/cli/defradb_client_acp_policy.md similarity index 100% rename from docs/cli/defradb_client_acp_policy.md rename to docs/website/references/cli/defradb_client_acp_policy.md diff --git a/docs/cli/defradb_client_acp_policy_add.md b/docs/website/references/cli/defradb_client_acp_policy_add.md similarity index 100% rename from docs/cli/defradb_client_acp_policy_add.md rename to docs/website/references/cli/defradb_client_acp_policy_add.md diff --git a/docs/cli/defradb_client_backup.md b/docs/website/references/cli/defradb_client_backup.md similarity index 100% rename from docs/cli/defradb_client_backup.md rename to docs/website/references/cli/defradb_client_backup.md diff --git a/docs/cli/defradb_client_backup_export.md b/docs/website/references/cli/defradb_client_backup_export.md similarity index 100% rename from docs/cli/defradb_client_backup_export.md rename to docs/website/references/cli/defradb_client_backup_export.md diff --git a/docs/cli/defradb_client_backup_import.md b/docs/website/references/cli/defradb_client_backup_import.md similarity index 100% rename from docs/cli/defradb_client_backup_import.md rename to docs/website/references/cli/defradb_client_backup_import.md diff --git a/docs/website/references/cli/defradb_client_blocks.md b/docs/website/references/cli/defradb_client_blocks.md deleted file mode 100644 index 9f1a50f296..0000000000 --- a/docs/website/references/cli/defradb_client_blocks.md +++ /dev/null @@ -1,28 +0,0 @@ -# client blocks - -Interact with the database's blockstore - -## Options - -``` - -h, --help help for blocks -``` - -## Options inherited from parent commands - -``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client -* [defradb client blocks get](defradb_client_blocks_get.md) - Get a block by its CID from the blockstore. - diff --git a/docs/website/references/cli/defradb_client_blocks_get.md b/docs/website/references/cli/defradb_client_blocks_get.md deleted file mode 100644 index 2ddfcb8453..0000000000 --- a/docs/website/references/cli/defradb_client_blocks_get.md +++ /dev/null @@ -1,31 +0,0 @@ -# client blocks get - -Get a block by its CID from the blockstore. - -``` -defradb client blocks get [CID] [flags] -``` - -## Options - -``` - -h, --help help for get -``` - -## Options inherited from parent commands - -``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client blocks](defradb_client_blocks.md) - Interact with the database's blockstore - diff --git a/docs/cli/defradb_client_collection.md b/docs/website/references/cli/defradb_client_collection.md similarity index 100% rename from docs/cli/defradb_client_collection.md rename to docs/website/references/cli/defradb_client_collection.md diff --git a/docs/cli/defradb_client_collection_create.md b/docs/website/references/cli/defradb_client_collection_create.md similarity index 100% rename from docs/cli/defradb_client_collection_create.md rename to docs/website/references/cli/defradb_client_collection_create.md diff --git a/docs/cli/defradb_client_collection_delete.md b/docs/website/references/cli/defradb_client_collection_delete.md similarity index 100% rename from docs/cli/defradb_client_collection_delete.md rename to docs/website/references/cli/defradb_client_collection_delete.md diff --git a/docs/cli/defradb_client_collection_describe.md b/docs/website/references/cli/defradb_client_collection_describe.md similarity index 100% rename from docs/cli/defradb_client_collection_describe.md rename to docs/website/references/cli/defradb_client_collection_describe.md diff --git a/docs/cli/defradb_client_collection_docIDs.md b/docs/website/references/cli/defradb_client_collection_docIDs.md similarity index 100% rename from docs/cli/defradb_client_collection_docIDs.md rename to docs/website/references/cli/defradb_client_collection_docIDs.md diff --git a/docs/cli/defradb_client_collection_get.md b/docs/website/references/cli/defradb_client_collection_get.md similarity index 100% rename from docs/cli/defradb_client_collection_get.md rename to docs/website/references/cli/defradb_client_collection_get.md diff --git a/docs/cli/defradb_client_collection_patch.md b/docs/website/references/cli/defradb_client_collection_patch.md similarity index 100% rename from docs/cli/defradb_client_collection_patch.md rename to docs/website/references/cli/defradb_client_collection_patch.md diff --git a/docs/cli/defradb_client_collection_update.md b/docs/website/references/cli/defradb_client_collection_update.md similarity index 100% rename from docs/cli/defradb_client_collection_update.md rename to docs/website/references/cli/defradb_client_collection_update.md diff --git a/docs/website/references/cli/defradb_client_dump.md b/docs/website/references/cli/defradb_client_dump.md index fdc2a38a3b..ca831313cd 100644 --- a/docs/website/references/cli/defradb_client_dump.md +++ b/docs/website/references/cli/defradb_client_dump.md @@ -1,31 +1,38 @@ -# client dump +## defradb client dump -Dump the contents of a database node-side +Dump the contents of DefraDB node-side ``` defradb client dump [flags] ``` -## Options +### Options ``` -h, --help help for dump ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + -i, --identity string ACP Identity + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --tx uint Transaction ID + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client +* [defradb client](defradb_client.md) - Interact with a DefraDB node diff --git a/docs/cli/defradb_client_index.md b/docs/website/references/cli/defradb_client_index.md similarity index 100% rename from docs/cli/defradb_client_index.md rename to docs/website/references/cli/defradb_client_index.md diff --git a/docs/cli/defradb_client_index_create.md b/docs/website/references/cli/defradb_client_index_create.md similarity index 100% rename from docs/cli/defradb_client_index_create.md rename to docs/website/references/cli/defradb_client_index_create.md diff --git a/docs/cli/defradb_client_index_drop.md b/docs/website/references/cli/defradb_client_index_drop.md similarity index 100% rename from docs/cli/defradb_client_index_drop.md rename to docs/website/references/cli/defradb_client_index_drop.md diff --git a/docs/cli/defradb_client_index_list.md b/docs/website/references/cli/defradb_client_index_list.md similarity index 100% rename from docs/cli/defradb_client_index_list.md rename to docs/website/references/cli/defradb_client_index_list.md diff --git a/docs/cli/defradb_client_p2p.md b/docs/website/references/cli/defradb_client_p2p.md similarity index 100% rename from docs/cli/defradb_client_p2p.md rename to docs/website/references/cli/defradb_client_p2p.md diff --git a/docs/cli/defradb_client_p2p_collection.md b/docs/website/references/cli/defradb_client_p2p_collection.md similarity index 100% rename from docs/cli/defradb_client_p2p_collection.md rename to docs/website/references/cli/defradb_client_p2p_collection.md diff --git a/docs/cli/defradb_client_p2p_collection_add.md b/docs/website/references/cli/defradb_client_p2p_collection_add.md similarity index 100% rename from docs/cli/defradb_client_p2p_collection_add.md rename to docs/website/references/cli/defradb_client_p2p_collection_add.md diff --git a/docs/cli/defradb_client_p2p_collection_getall.md b/docs/website/references/cli/defradb_client_p2p_collection_getall.md similarity index 100% rename from docs/cli/defradb_client_p2p_collection_getall.md rename to docs/website/references/cli/defradb_client_p2p_collection_getall.md diff --git a/docs/cli/defradb_client_p2p_collection_remove.md b/docs/website/references/cli/defradb_client_p2p_collection_remove.md similarity index 100% rename from docs/cli/defradb_client_p2p_collection_remove.md rename to docs/website/references/cli/defradb_client_p2p_collection_remove.md diff --git a/docs/cli/defradb_client_p2p_info.md b/docs/website/references/cli/defradb_client_p2p_info.md similarity index 100% rename from docs/cli/defradb_client_p2p_info.md rename to docs/website/references/cli/defradb_client_p2p_info.md diff --git a/docs/cli/defradb_client_p2p_replicator.md b/docs/website/references/cli/defradb_client_p2p_replicator.md similarity index 100% rename from docs/cli/defradb_client_p2p_replicator.md rename to docs/website/references/cli/defradb_client_p2p_replicator.md diff --git a/docs/cli/defradb_client_p2p_replicator_delete.md b/docs/website/references/cli/defradb_client_p2p_replicator_delete.md similarity index 100% rename from docs/cli/defradb_client_p2p_replicator_delete.md rename to docs/website/references/cli/defradb_client_p2p_replicator_delete.md diff --git a/docs/cli/defradb_client_p2p_replicator_getall.md b/docs/website/references/cli/defradb_client_p2p_replicator_getall.md similarity index 100% rename from docs/cli/defradb_client_p2p_replicator_getall.md rename to docs/website/references/cli/defradb_client_p2p_replicator_getall.md diff --git a/docs/cli/defradb_client_p2p_replicator_set.md b/docs/website/references/cli/defradb_client_p2p_replicator_set.md similarity index 100% rename from docs/cli/defradb_client_p2p_replicator_set.md rename to docs/website/references/cli/defradb_client_p2p_replicator_set.md diff --git a/docs/website/references/cli/defradb_client_peerid.md b/docs/website/references/cli/defradb_client_peerid.md deleted file mode 100644 index cf3f175646..0000000000 --- a/docs/website/references/cli/defradb_client_peerid.md +++ /dev/null @@ -1,31 +0,0 @@ -# client peerid - -Get the peer ID of the DefraDB node - -``` -defradb client peerid [flags] -``` - -## Options - -``` - -h, --help help for peerid -``` - -## Options inherited from parent commands - -``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client - diff --git a/docs/website/references/cli/defradb_client_ping.md b/docs/website/references/cli/defradb_client_ping.md deleted file mode 100644 index 6115c5f493..0000000000 --- a/docs/website/references/cli/defradb_client_ping.md +++ /dev/null @@ -1,31 +0,0 @@ -# client ping - -Ping to test connection to a node - -``` -defradb client ping [flags] -``` - -## Options - -``` - -h, --help help for ping -``` - -## Options inherited from parent commands - -``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client - diff --git a/docs/website/references/cli/defradb_client_query.md b/docs/website/references/cli/defradb_client_query.md index b602633b78..2dcea07526 100644 --- a/docs/website/references/cli/defradb_client_query.md +++ b/docs/website/references/cli/defradb_client_query.md @@ -1,16 +1,22 @@ -# client query +## defradb client query Send a DefraDB GraphQL query request -## Synopsis +### Synopsis Send a DefraDB GraphQL query request to the database. A query request can be sent as a single argument. Example command: -defradb client query 'query { ... }' + defradb client query 'query { ... }' + +Do a query request from a file by using the '-f' flag. Example command: + defradb client query -f request.graphql + +Do a query request from a file and with an identity. Example command: + defradb client query -i cosmos1f2djr7dl9vhrk3twt3xwqp09nhtzec9mdkf70j -f request.graphql Or it can be sent via stdin by using the '-' special syntax. Example command: -cat request.graphql | defradb client query - + cat request.graphql | defradb client query - A GraphQL client such as GraphiQL (https://github.com/graphql/graphiql) can be used to interact with the database more conveniently. @@ -18,29 +24,37 @@ with the database more conveniently. To learn more about the DefraDB GraphQL Query Language, refer to https://docs.source.network. ``` -defradb client query [query request] [flags] +defradb client query [-i --identity] [request] [flags] ``` -## Options +### Options ``` - -h, --help help for query + -f, --file string File containing the query request + -h, --help help for query ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + -i, --identity string ACP Identity + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --tx uint Transaction ID + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client +* [defradb client](defradb_client.md) - Interact with a DefraDB node diff --git a/docs/website/references/cli/defradb_client_rpc.md b/docs/website/references/cli/defradb_client_rpc.md deleted file mode 100644 index 1044e78c2e..0000000000 --- a/docs/website/references/cli/defradb_client_rpc.md +++ /dev/null @@ -1,34 +0,0 @@ -# client rpc - -Interact with a DefraDB gRPC server - -## Synopsis - -Interact with a DefraDB gRPC server. - -## Options - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - -h, --help help for rpc -``` - -## Options inherited from parent commands - -``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client -* [defradb client rpc p2pcollection](defradb_client_rpc_p2pcollection.md) - Interact with the P2P collection system -* [defradb client rpc replicator](defradb_client_rpc_replicator.md) - Interact with the replicator system - diff --git a/docs/website/references/cli/defradb_client_rpc_addreplicator.md b/docs/website/references/cli/defradb_client_rpc_addreplicator.md deleted file mode 100644 index a7c5c9fe7a..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_addreplicator.md +++ /dev/null @@ -1,37 +0,0 @@ -# client rpc addreplicator - -Add a new replicator - -## Synopsis - -Use this command if you wish to add a new target replicator -for the p2p data sync system. - -``` -defradb client rpc addreplicator [flags] -``` - -## Options - -``` - -h, --help help for addreplicator -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc](defradb_client_rpc.md) - Interact with a DefraDB gRPC server - diff --git a/docs/website/references/cli/defradb_client_rpc_p2pcollection.md b/docs/website/references/cli/defradb_client_rpc_p2pcollection.md deleted file mode 100644 index 37edd5e76d..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_p2pcollection.md +++ /dev/null @@ -1,35 +0,0 @@ -# client rpc p2pcollection - -Interact with the P2P collection system - -## Synopsis - -Add, delete, or get the list of P2P collections - -## Options - -``` - -h, --help help for p2pcollection -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc](defradb_client_rpc.md) - Interact with a DefraDB gRPC server -* [defradb client rpc p2pcollection add](defradb_client_rpc_p2pcollection_add.md) - Add P2P collections -* [defradb client rpc p2pcollection getall](defradb_client_rpc_p2pcollection_getall.md) - Get all P2P collections -* [defradb client rpc p2pcollection remove](defradb_client_rpc_p2pcollection_remove.md) - Add P2P collections - diff --git a/docs/website/references/cli/defradb_client_rpc_p2pcollection_add.md b/docs/website/references/cli/defradb_client_rpc_p2pcollection_add.md deleted file mode 100644 index 902ff41cb7..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_p2pcollection_add.md +++ /dev/null @@ -1,36 +0,0 @@ -# client rpc p2pcollection add - -Add P2P collections - -## Synopsis - -Use this command if you wish to add new P2P collections to the pubsub topics - -``` -defradb client rpc p2pcollection add [collectionID] [flags] -``` - -## Options - -``` - -h, --help help for add -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc p2pcollection](defradb_client_rpc_p2pcollection.md) - Interact with the P2P collection system - diff --git a/docs/website/references/cli/defradb_client_rpc_p2pcollection_getall.md b/docs/website/references/cli/defradb_client_rpc_p2pcollection_getall.md deleted file mode 100644 index 92d53377c0..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_p2pcollection_getall.md +++ /dev/null @@ -1,36 +0,0 @@ -# client rpc p2pcollection getall - -Get all P2P collections - -## Synopsis - -Use this command if you wish to get all P2P collections in the pubsub topics - -``` -defradb client rpc p2pcollection getall [flags] -``` - -## Options - -``` - -h, --help help for getall -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc p2pcollection](defradb_client_rpc_p2pcollection.md) - Interact with the P2P collection system - diff --git a/docs/website/references/cli/defradb_client_rpc_p2pcollection_remove.md b/docs/website/references/cli/defradb_client_rpc_p2pcollection_remove.md deleted file mode 100644 index 9f8214dc46..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_p2pcollection_remove.md +++ /dev/null @@ -1,36 +0,0 @@ -# client rpc p2pcollection remove - -Add P2P collections - -## Synopsis - -Use this command if you wish to remove P2P collections from the pubsub topics - -``` -defradb client rpc p2pcollection remove [collectionID] [flags] -``` - -## Options - -``` - -h, --help help for remove -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc p2pcollection](defradb_client_rpc_p2pcollection.md) - Interact with the P2P collection system - diff --git a/docs/website/references/cli/defradb_client_rpc_replicator.md b/docs/website/references/cli/defradb_client_rpc_replicator.md deleted file mode 100644 index cdb87fad32..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_replicator.md +++ /dev/null @@ -1,37 +0,0 @@ -# client rpc replicator - -Interact with the replicator system - -## Synopsis - -Add, delete, or get the list of persisted replicators - -## Options - -``` - -c, --collection stringArray Define the collection for the replicator - -f, --full Set the replicator to act on all collections - -h, --help help for replicator -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc](defradb_client_rpc.md) - Interact with a DefraDB gRPC server -* [defradb client rpc replicator delete](defradb_client_rpc_replicator_delete.md) - Delete a replicator -* [defradb client rpc replicator getall](defradb_client_rpc_replicator_getall.md) - Get all replicators -* [defradb client rpc replicator set](defradb_client_rpc_replicator_set.md) - Set a P2P replicator - diff --git a/docs/website/references/cli/defradb_client_rpc_replicator_delete.md b/docs/website/references/cli/defradb_client_rpc_replicator_delete.md deleted file mode 100644 index 392481b3e9..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_replicator_delete.md +++ /dev/null @@ -1,37 +0,0 @@ -# client rpc replicator delete - -Delete a replicator - -## Synopsis - -Use this command if you wish to remove the target replicator -for the p2p data sync system. - -``` -defradb client rpc replicator delete [-f, --full | -c, --collection] [flags] -``` - -## Options - -``` - -h, --help help for delete -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc replicator](defradb_client_rpc_replicator.md) - Interact with the replicator system - diff --git a/docs/website/references/cli/defradb_client_rpc_replicator_getall.md b/docs/website/references/cli/defradb_client_rpc_replicator_getall.md deleted file mode 100644 index 79d891a5c9..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_replicator_getall.md +++ /dev/null @@ -1,37 +0,0 @@ -# client rpc replicator getall - -Get all replicators - -## Synopsis - -Use this command if you wish to get all the replicators -for the p2p data sync system. - -``` -defradb client rpc replicator getall [flags] -``` - -## Options - -``` - -h, --help help for getall -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc replicator](defradb_client_rpc_replicator.md) - Interact with the replicator system - diff --git a/docs/website/references/cli/defradb_client_rpc_replicator_set.md b/docs/website/references/cli/defradb_client_rpc_replicator_set.md deleted file mode 100644 index 5b94f1a1ab..0000000000 --- a/docs/website/references/cli/defradb_client_rpc_replicator_set.md +++ /dev/null @@ -1,39 +0,0 @@ -# client rpc replicator set - -Set a P2P replicator - -## Synopsis - -Use this command if you wish to add a new target replicator -for the p2p data sync system or add schemas to an existing one - -``` -defradb client rpc replicator set [-f, --full | -c, --collection] [flags] -``` - -## Options - -``` - -c, --collection stringArray Define the collection for the replicator - -f, --full Set the replicator to act on all collections - -h, --help help for set -``` - -## Options inherited from parent commands - -``` - --addr string gRPC endpoint address (default "0.0.0.0:9161") - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") -``` - -## SEE ALSO - -* [defradb client rpc replicator](defradb_client_rpc_replicator.md) - Interact with the replicator system - diff --git a/docs/website/references/cli/defradb_client_schema.md b/docs/website/references/cli/defradb_client_schema.md index 140c7fe635..c69bdaee8f 100644 --- a/docs/website/references/cli/defradb_client_schema.md +++ b/docs/website/references/cli/defradb_client_schema.md @@ -1,33 +1,43 @@ -# client schema +## defradb client schema -Interact with the schema system of a running DefraDB instance +Interact with the schema system of a DefraDB node -## Synopsis +### Synopsis -Make changes, updates, or look for existing schema types to a DefraDB node. +Make changes, updates, or look for existing schema types. -## Options +### Options ``` -h, --help help for schema ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + -i, --identity string ACP Identity + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --tx uint Transaction ID + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO -* [defradb client](defradb_client.md) - Interact with a running DefraDB node as a client -* [defradb client schema add](defradb_client_schema_add.md) - Add a new schema type to DefraDB +* [defradb client](defradb_client.md) - Interact with a DefraDB node +* [defradb client schema add](defradb_client_schema_add.md) - Add new schema +* [defradb client schema describe](defradb_client_schema_describe.md) - View schema descriptions. +* [defradb client schema migration](defradb_client_schema_migration.md) - Interact with the schema migration system of a running DefraDB instance * [defradb client schema patch](defradb_client_schema_patch.md) - Patch an existing schema type +* [defradb client schema set-active](defradb_client_schema_set-active.md) - Set the active collection version diff --git a/docs/website/references/cli/defradb_client_schema_add.md b/docs/website/references/cli/defradb_client_schema_add.md index 0909eb5789..9e70bb1f17 100644 --- a/docs/website/references/cli/defradb_client_schema_add.md +++ b/docs/website/references/cli/defradb_client_schema_add.md @@ -1,10 +1,15 @@ -# client schema add +## defradb client schema add -Add a new schema type to DefraDB +Add new schema -## Synopsis +### Synopsis -Add a new schema type to DefraDB. +Add new schema. + +Schema Object with a '@policy(id:".." resource: "..")' linked will only be accepted if: + - ACP is available (i.e. ACP is not disabled). + - The specified resource adheres to the Document Access Control DPI Rules. + - Learn more about [ACP & DPI Rules](/acp/README.md) Example: add from an argument string: defradb client schema add 'type Foo { ... }' @@ -15,33 +20,40 @@ Example: add from file: Example: add from stdin: cat schema.graphql | defradb client schema add - -To learn more about the DefraDB GraphQL Schema Language, refer to https://docs.source.network. +Learn more about the DefraDB GraphQL Schema Language on https://docs.source.network. ``` defradb client schema add [schema] [flags] ``` -## Options +### Options ``` -f, --file string File to load a schema from -h, --help help for add ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + -i, --identity string ACP Identity + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --tx uint Transaction ID + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO -* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a running DefraDB instance +* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a DefraDB node diff --git a/docs/cli/defradb_client_schema_describe.md b/docs/website/references/cli/defradb_client_schema_describe.md similarity index 100% rename from docs/cli/defradb_client_schema_describe.md rename to docs/website/references/cli/defradb_client_schema_describe.md diff --git a/docs/cli/defradb_client_schema_migration.md b/docs/website/references/cli/defradb_client_schema_migration.md similarity index 100% rename from docs/cli/defradb_client_schema_migration.md rename to docs/website/references/cli/defradb_client_schema_migration.md diff --git a/docs/cli/defradb_client_schema_migration_down.md b/docs/website/references/cli/defradb_client_schema_migration_down.md similarity index 100% rename from docs/cli/defradb_client_schema_migration_down.md rename to docs/website/references/cli/defradb_client_schema_migration_down.md diff --git a/docs/cli/defradb_client_schema_migration_reload.md b/docs/website/references/cli/defradb_client_schema_migration_reload.md similarity index 100% rename from docs/cli/defradb_client_schema_migration_reload.md rename to docs/website/references/cli/defradb_client_schema_migration_reload.md diff --git a/docs/cli/defradb_client_schema_migration_set-registry.md b/docs/website/references/cli/defradb_client_schema_migration_set-registry.md similarity index 100% rename from docs/cli/defradb_client_schema_migration_set-registry.md rename to docs/website/references/cli/defradb_client_schema_migration_set-registry.md diff --git a/docs/cli/defradb_client_schema_migration_set.md b/docs/website/references/cli/defradb_client_schema_migration_set.md similarity index 100% rename from docs/cli/defradb_client_schema_migration_set.md rename to docs/website/references/cli/defradb_client_schema_migration_set.md diff --git a/docs/cli/defradb_client_schema_migration_up.md b/docs/website/references/cli/defradb_client_schema_migration_up.md similarity index 100% rename from docs/cli/defradb_client_schema_migration_up.md rename to docs/website/references/cli/defradb_client_schema_migration_up.md diff --git a/docs/website/references/cli/defradb_client_schema_patch.md b/docs/website/references/cli/defradb_client_schema_patch.md index 307e7b83fa..6c884d0a0f 100644 --- a/docs/website/references/cli/defradb_client_schema_patch.md +++ b/docs/website/references/cli/defradb_client_schema_patch.md @@ -1,18 +1,18 @@ -# client schema patch +## defradb client schema patch Patch an existing schema type -## Synopsis +### Synopsis Patch an existing schema. -Uses JSON PATCH formatting as a DDL. +Uses JSON Patch to modify schema types. Example: patch from an argument string: - defradb client schema patch '[{ "op": "add", "path": "...", "value": {...} }]' + defradb client schema patch '[{ "op": "add", "path": "...", "value": {...} }]' '{"lenses": [...' Example: patch from file: - defradb client schema patch -f patch.json + defradb client schema patch -p patch.json Example: patch from stdin: cat patch.json | defradb client schema patch - @@ -20,30 +20,39 @@ Example: patch from stdin: To learn more about the DefraDB GraphQL Schema Language, refer to https://docs.source.network. ``` -defradb client schema patch [schema] [flags] +defradb client schema patch [schema] [migration] [flags] ``` -## Options +### Options ``` - -f, --file string File to load a patch from - -h, --help help for patch + -h, --help help for patch + -t, --lens-file string File to load a lens config from + -p, --patch-file string File to load a patch from + --set-active Set the active schema version for all collections using the root schem ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + -i, --identity string ACP Identity + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --tx uint Transaction ID + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO -* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a running DefraDB instance +* [defradb client schema](defradb_client_schema.md) - Interact with the schema system of a DefraDB node diff --git a/docs/cli/defradb_client_schema_set-active.md b/docs/website/references/cli/defradb_client_schema_set-active.md similarity index 100% rename from docs/cli/defradb_client_schema_set-active.md rename to docs/website/references/cli/defradb_client_schema_set-active.md diff --git a/docs/cli/defradb_client_tx.md b/docs/website/references/cli/defradb_client_tx.md similarity index 100% rename from docs/cli/defradb_client_tx.md rename to docs/website/references/cli/defradb_client_tx.md diff --git a/docs/cli/defradb_client_tx_commit.md b/docs/website/references/cli/defradb_client_tx_commit.md similarity index 100% rename from docs/cli/defradb_client_tx_commit.md rename to docs/website/references/cli/defradb_client_tx_commit.md diff --git a/docs/cli/defradb_client_tx_create.md b/docs/website/references/cli/defradb_client_tx_create.md similarity index 100% rename from docs/cli/defradb_client_tx_create.md rename to docs/website/references/cli/defradb_client_tx_create.md diff --git a/docs/cli/defradb_client_tx_discard.md b/docs/website/references/cli/defradb_client_tx_discard.md similarity index 100% rename from docs/cli/defradb_client_tx_discard.md rename to docs/website/references/cli/defradb_client_tx_discard.md diff --git a/docs/cli/defradb_client_view.md b/docs/website/references/cli/defradb_client_view.md similarity index 100% rename from docs/cli/defradb_client_view.md rename to docs/website/references/cli/defradb_client_view.md diff --git a/docs/cli/defradb_client_view_add.md b/docs/website/references/cli/defradb_client_view_add.md similarity index 100% rename from docs/cli/defradb_client_view_add.md rename to docs/website/references/cli/defradb_client_view_add.md diff --git a/docs/website/references/cli/defradb_init.md b/docs/website/references/cli/defradb_init.md deleted file mode 100644 index 5b7f2071ce..0000000000 --- a/docs/website/references/cli/defradb_init.md +++ /dev/null @@ -1,36 +0,0 @@ -# init - -Initialize DefraDB's root directory and configuration file - -## Synopsis - -Initialize a directory for configuration and data at the given path. - -``` -defradb init [flags] -``` - -## Options - -``` - -h, --help help for init - --reinitialize Reinitialize the configuration file - --rootdir string Directory for data and configuration to use (default "$HOME/.defradb") -``` - -## Options inherited from parent commands - -``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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 - --url string URL of HTTP endpoint to listen on or connect to (default "localhost:9181") -``` - -## SEE ALSO - -* [defradb](defradb.md) - DefraDB Edge Database - diff --git a/docs/cli/defradb_keyring.md b/docs/website/references/cli/defradb_keyring.md similarity index 100% rename from docs/cli/defradb_keyring.md rename to docs/website/references/cli/defradb_keyring.md diff --git a/docs/cli/defradb_keyring_export.md b/docs/website/references/cli/defradb_keyring_export.md similarity index 100% rename from docs/cli/defradb_keyring_export.md rename to docs/website/references/cli/defradb_keyring_export.md diff --git a/docs/cli/defradb_keyring_generate.md b/docs/website/references/cli/defradb_keyring_generate.md similarity index 100% rename from docs/cli/defradb_keyring_generate.md rename to docs/website/references/cli/defradb_keyring_generate.md diff --git a/docs/cli/defradb_keyring_import.md b/docs/website/references/cli/defradb_keyring_import.md similarity index 100% rename from docs/cli/defradb_keyring_import.md rename to docs/website/references/cli/defradb_keyring_import.md diff --git a/docs/website/references/cli/defradb_server-dump.md b/docs/website/references/cli/defradb_server-dump.md index 91641d1125..403d72c972 100644 --- a/docs/website/references/cli/defradb_server-dump.md +++ b/docs/website/references/cli/defradb_server-dump.md @@ -1,4 +1,4 @@ -# server-dump +## defradb server-dump Dumps the state of the entire database @@ -6,27 +6,31 @@ Dumps the state of the entire database defradb server-dump [flags] ``` -## Options +### Options ``` - -h, --help help for server-dump - --store string Datastore to use. Options are badger, memory (default "badger") + -h, --help help for server-dump ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO * [defradb](defradb.md) - DefraDB Edge Database diff --git a/docs/website/references/cli/defradb_start.md b/docs/website/references/cli/defradb_start.md index d393f7f3a5..0f2bed427f 100644 --- a/docs/website/references/cli/defradb_start.md +++ b/docs/website/references/cli/defradb_start.md @@ -1,46 +1,49 @@ -# start +## defradb start Start a DefraDB node -## Synopsis +### Synopsis -Start a new instance of DefraDB node. +Start a DefraDB node. ``` defradb start [flags] ``` -## Options +### Options ``` - --email string Email address used by the CA for notifications (default "example@example.com") - -h, --help help for start - --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 string Listener address for the p2p network (formatted as a libp2p MultiAddr) (default "/ip4/0.0.0.0/tcp/9171") - --peers string List of peers to connect to - --privkeypath string Path to the private key for tls (default "certs/server.crt") - --pubkeypath string Path to the public key for tls (default "certs/server.key") - --store string Specify the datastore to use (supported: badger, memory) (default "badger") - --tcpaddr string Listener address for the tcp gRPC server (formatted as a libp2p MultiAddr) (default "/ip4/0.0.0.0/tcp/9161") - --tls Enable serving the API over https - --valuelogfilesize ByteSize Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1GiB) + --allowed-origins stringArray List of origins to allow for CORS requests + -h, --help help for start + --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 + --store string Specify the datastore to use (supported: badger, memory) (default "badger") + --valuelogfilesize int Specify the datastore value log file size (in bytes). In memory size will be 2*valuelogfilesize (default 1073741824) ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO * [defradb](defradb.md) - DefraDB Edge Database diff --git a/docs/website/references/cli/defradb_version.md b/docs/website/references/cli/defradb_version.md index de817ade10..c82cd43df8 100644 --- a/docs/website/references/cli/defradb_version.md +++ b/docs/website/references/cli/defradb_version.md @@ -1,4 +1,4 @@ -# version +## defradb version Display the version information of DefraDB and its components @@ -6,7 +6,7 @@ Display the version information of DefraDB and its components defradb version [flags] ``` -## Options +### Options ``` -f, --format string Version output format. Options are text, json @@ -14,20 +14,25 @@ defradb version [flags] -h, --help help for version ``` -## Options inherited from parent commands +### Options inherited from parent commands ``` - --logformat string Log format to use. Options are csv, json (default "csv") - --logger stringArray Override logger parameters. Usage: --logger ,level=,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") + --keyring-backend string Keyring backend to use. Options are file or system (default "file") + --keyring-namespace string Service name to use when using the system backend (default "defradb") + --keyring-path string Path to store encrypted keys when using the file backend (default "keys") + --log-format string Log format to use. Options are text or json (default "text") + --log-level string Log level to use. Options are debug, info, error, fatal (default "info") + --log-output string Log output path. Options are stderr or stdout. (default "stderr") + --log-overrides string Logger config overrides. Format ,=,...;,... + --log-source Include source location in logs + --log-stacktrace Include stacktrace in error and fatal logs + --no-keyring Disable the keyring and generate ephemeral keys + --no-log-color Disable colored log output + --rootdir string Directory for persistent data (default: $HOME/.defradb) + --url string URL of HTTP endpoint to listen on or connect to (default "127.0.0.1:9181") ``` -## SEE ALSO +### SEE ALSO * [defradb](defradb.md) - DefraDB Edge Database