diff --git a/site/content/3.10/arangograph/oasisctl/accept/_index.md b/site/content/3.10/arangograph/oasisctl/accept/_index.md index 4ebd21ca95..64d2d0e391 100644 --- a/site/content/3.10/arangograph/oasisctl/accept/_index.md +++ b/site/content/3.10/arangograph/oasisctl/accept/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl accept command title: Oasisctl Accept menuTitle: Accept -weight: 10 -description: >- - Description of the oasisctl accept command -archetype: chapter +weight: 5 --- -Accept invites - ## Synopsis - Accept invites ``` @@ -17,13 +13,11 @@ oasisctl accept [flags] ``` ## Options - ``` -h, --help help for accept ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl accept [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl accept organization](accept-organization.md) - Accept organization related invites diff --git a/site/content/3.10/arangograph/oasisctl/accept/accept-organization-invite.md b/site/content/3.10/arangograph/oasisctl/accept/accept-organization-invite.md index ff1b87d4f4..2ce338674b 100644 --- a/site/content/3.10/arangograph/oasisctl/accept/accept-organization-invite.md +++ b/site/content/3.10/arangograph/oasisctl/accept/accept-organization-invite.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl accept organization invite command title: Oasisctl Accept Organization Invite menuTitle: Accept Organization Invite -weight: 10 -description: >- - Description of the oasisctl accept organization invite command -archetype: default +weight: 15 --- -Accept an organization invite the authenticated user has access to - ## Synopsis - Accept an organization invite the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl accept organization invite [flags] ``` ## Options - ``` -h, --help help for invite -i, --invite-id string Identifier of the organization invite -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl accept organization invite [flags] ``` ## See also - * [oasisctl accept organization](accept-organization.md) - Accept organization related invites diff --git a/site/content/3.10/arangograph/oasisctl/accept/accept-organization.md b/site/content/3.10/arangograph/oasisctl/accept/accept-organization.md index ed4b1db6bf..16d7ca367e 100644 --- a/site/content/3.10/arangograph/oasisctl/accept/accept-organization.md +++ b/site/content/3.10/arangograph/oasisctl/accept/accept-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl accept organization command title: Oasisctl Accept Organization menuTitle: Accept Organization -weight: 5 -description: >- - Description of the oasisctl accept organization command -archetype: default +weight: 10 --- -Accept organization related invites - ## Synopsis - Accept organization related invites ``` @@ -17,13 +13,11 @@ oasisctl accept organization [flags] ``` ## Options - ``` -h, --help help for organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl accept organization [flags] ``` ## See also - * [oasisctl accept](_index.md) - Accept invites * [oasisctl accept organization invite](accept-organization-invite.md) - Accept an organization invite the authenticated user has access to diff --git a/site/content/3.10/arangograph/oasisctl/add/_index.md b/site/content/3.10/arangograph/oasisctl/add/_index.md index efffaa3e04..a90a3c5f79 100644 --- a/site/content/3.10/arangograph/oasisctl/add/_index.md +++ b/site/content/3.10/arangograph/oasisctl/add/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl add command title: Oasisctl Add menuTitle: Add -weight: 15 -description: >- - Description of the oasisctl add command -archetype: chapter +weight: 5 --- -Add resources - ## Synopsis - Add resources ``` @@ -17,13 +13,11 @@ oasisctl add [flags] ``` ## Options - ``` -h, --help help for add ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl add [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl add auditlog](add-auditlog.md) - Add auditlog resources * [oasisctl add group](add-group.md) - Add group resources diff --git a/site/content/3.10/arangograph/oasisctl/add/add-auditlog-destination.md b/site/content/3.10/arangograph/oasisctl/add/add-auditlog-destination.md index 30e36a98a5..eb94d3196b 100644 --- a/site/content/3.10/arangograph/oasisctl/add/add-auditlog-destination.md +++ b/site/content/3.10/arangograph/oasisctl/add/add-auditlog-destination.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl add auditlog destination command title: Oasisctl Add Auditlog Destination menuTitle: Add Audit Log Destination -weight: 10 -description: >- - Description of the oasisctl add auditlog destination command -archetype: default +weight: 15 --- -Add a destination to an auditlog. - ## Synopsis - Add a destination to an auditlog. ``` @@ -17,7 +13,6 @@ oasisctl add auditlog destination [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog --destination-excluded-topics strings Do not send audit events with these topics to this destination. @@ -31,8 +26,7 @@ oasisctl add auditlog destination [flags] -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -40,6 +34,5 @@ oasisctl add auditlog destination [flags] ``` ## See also - * [oasisctl add auditlog](add-auditlog.md) - Add auditlog resources diff --git a/site/content/3.10/arangograph/oasisctl/add/add-auditlog.md b/site/content/3.10/arangograph/oasisctl/add/add-auditlog.md index 081bb19687..7c3f532e38 100644 --- a/site/content/3.10/arangograph/oasisctl/add/add-auditlog.md +++ b/site/content/3.10/arangograph/oasisctl/add/add-auditlog.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl add auditlog command title: Oasisctl Add Auditlog -menuTitle: Add Audit Log -weight: 5 -description: >- - Description of the oasisctl add auditlog command -archetype: default +menuTitle: Add Auditlog +weight: 10 --- -Add auditlog resources - ## Synopsis - Add auditlog resources ``` @@ -17,13 +13,11 @@ oasisctl add auditlog [flags] ``` ## Options - ``` -h, --help help for auditlog ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl add auditlog [flags] ``` ## See also - * [oasisctl add](_index.md) - Add resources * [oasisctl add auditlog destination](add-auditlog-destination.md) - Add a destination to an auditlog. diff --git a/site/content/3.10/arangograph/oasisctl/add/add-group-members.md b/site/content/3.10/arangograph/oasisctl/add/add-group-members.md index 30aea12e83..0565402f0f 100644 --- a/site/content/3.10/arangograph/oasisctl/add/add-group-members.md +++ b/site/content/3.10/arangograph/oasisctl/add/add-group-members.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl add group members command title: Oasisctl Add Group Members menuTitle: Add Group Members -weight: 20 -description: >- - Description of the oasisctl add group members command -archetype: default +weight: 25 --- -Add members to group - ## Synopsis - Add members to group ``` @@ -17,7 +13,6 @@ oasisctl add group members [flags] ``` ## Options - ``` -g, --group-id string Identifier of the group to add members to -h, --help help for members @@ -25,8 +20,7 @@ oasisctl add group members [flags] -u, --user-emails strings A comma separated list of user email addresses ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl add group members [flags] ``` ## See also - * [oasisctl add group](add-group.md) - Add group resources diff --git a/site/content/3.10/arangograph/oasisctl/add/add-group.md b/site/content/3.10/arangograph/oasisctl/add/add-group.md index d99d6a124e..8afb816f82 100644 --- a/site/content/3.10/arangograph/oasisctl/add/add-group.md +++ b/site/content/3.10/arangograph/oasisctl/add/add-group.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl add group command title: Oasisctl Add Group menuTitle: Add Group -weight: 15 -description: >- - Description of the oasisctl add group command -archetype: default +weight: 20 --- -Add group resources - ## Synopsis - Add group resources ``` @@ -17,13 +13,11 @@ oasisctl add group [flags] ``` ## Options - ``` -h, --help help for group ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl add group [flags] ``` ## See also - * [oasisctl add](_index.md) - Add resources * [oasisctl add group members](add-group-members.md) - Add members to group diff --git a/site/content/3.10/arangograph/oasisctl/auditlog/_index.md b/site/content/3.10/arangograph/oasisctl/auditlog/_index.md index 991c96beea..525388f9c4 100644 --- a/site/content/3.10/arangograph/oasisctl/auditlog/_index.md +++ b/site/content/3.10/arangograph/oasisctl/auditlog/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl auditlog command title: Oasisctl Auditlog -menuTitle: Audit Log -weight: 20 -description: >- - Description of the oasisctl auditlog command -archetype: chapter +menuTitle: Auditlog +weight: 5 --- -AuditLog resources - ## Synopsis - AuditLog resources ``` @@ -17,13 +13,11 @@ oasisctl auditlog [flags] ``` ## Options - ``` -h, --help help for auditlog ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl auditlog [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl auditlog attach](auditlog-attach.md) - Attach a project to an audit log * [oasisctl auditlog detach](auditlog-detach.md) - Detach a project from an auditlog diff --git a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-attach.md b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-attach.md index 9e5edd9b08..3b475c5f4b 100644 --- a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-attach.md +++ b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-attach.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl auditlog attach command title: Oasisctl Auditlog Attach menuTitle: Audit Log Attach -weight: 5 -description: >- - Description of the oasisctl auditlog attach command -archetype: default +weight: 10 --- -Attach a project to an audit log - ## Synopsis - Attach a project to an audit log ``` @@ -17,7 +13,6 @@ oasisctl auditlog attach [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog to attach to. -h, --help help for attach @@ -25,8 +20,7 @@ oasisctl auditlog attach [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl auditlog attach [flags] ``` ## See also - * [oasisctl auditlog](_index.md) - AuditLog resources diff --git a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-detach.md b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-detach.md index dd3f006418..472fc19348 100644 --- a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-detach.md +++ b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-detach.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl auditlog detach command title: Oasisctl Auditlog Detach menuTitle: Audit Log Detach -weight: 10 -description: >- - Description of the oasisctl auditlog detach command -archetype: default +weight: 15 --- -Detach a project from an auditlog - ## Synopsis - Detach a project from an auditlog ``` @@ -17,15 +13,13 @@ oasisctl auditlog detach [flags] ``` ## Options - ``` -h, --help help for detach -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl auditlog detach [flags] ``` ## See also - * [oasisctl auditlog](_index.md) - AuditLog resources diff --git a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached-project.md b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached-project.md index 3e666dc416..ec1e2e6b2e 100644 --- a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached-project.md +++ b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached-project.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl auditlog get attached project command title: Oasisctl Auditlog Get Attached Project menuTitle: Audit Log Get Attached Project -weight: 25 -description: >- - Description of the oasisctl auditlog get attached project command -archetype: default +weight: 30 --- -Get an attached log to a project - ## Synopsis - Get an attached log to a project ``` @@ -17,15 +13,13 @@ oasisctl auditlog get attached project [flags] ``` ## Options - ``` -h, --help help for project -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl auditlog get attached project [flags] ``` ## See also - * [oasisctl auditlog get attached](auditlog-get-attached.md) - Audit get attached resources diff --git a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached.md b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached.md index fad4e9af5d..89f015a076 100644 --- a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached.md +++ b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get-attached.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl auditlog get attached command title: Oasisctl Auditlog Get Attached menuTitle: Audit Log Get Attached -weight: 20 -description: >- - Description of the oasisctl auditlog get attached command -archetype: default +weight: 25 --- -Audit get attached resources - ## Synopsis - Audit get attached resources ``` @@ -17,13 +13,11 @@ oasisctl auditlog get attached [flags] ``` ## Options - ``` -h, --help help for attached ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl auditlog get attached [flags] ``` ## See also - * [oasisctl auditlog get](auditlog-get.md) - Audit log get resources * [oasisctl auditlog get attached project](auditlog-get-attached-project.md) - Get an attached log to a project diff --git a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get.md b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get.md index b33a557245..ef01742b4e 100644 --- a/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get.md +++ b/site/content/3.10/arangograph/oasisctl/auditlog/auditlog-get.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl auditlog get command title: Oasisctl Auditlog Get menuTitle: Audit Log Get -weight: 15 -description: >- - Description of the oasisctl auditlog get command -archetype: default +weight: 20 --- -Audit log get resources - ## Synopsis - Audit log get resources ``` @@ -17,13 +13,11 @@ oasisctl auditlog get [flags] ``` ## Options - ``` -h, --help help for get ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl auditlog get [flags] ``` ## See also - * [oasisctl auditlog](_index.md) - AuditLog resources * [oasisctl auditlog get attached](auditlog-get-attached.md) - Audit get attached resources diff --git a/site/content/3.10/arangograph/oasisctl/backup/_index.md b/site/content/3.10/arangograph/oasisctl/backup/_index.md index 85075ed4fe..15e21353a4 100644 --- a/site/content/3.10/arangograph/oasisctl/backup/_index.md +++ b/site/content/3.10/arangograph/oasisctl/backup/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl backup command title: Oasisctl Backup menuTitle: Backup -weight: 25 -description: >- - Description of the oasisctl backup command -archetype: chapter +weight: 5 --- -Backup commands - ## Synopsis - Backup commands ``` @@ -17,13 +13,11 @@ oasisctl backup [flags] ``` ## Options - ``` -h, --help help for backup ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl backup [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl backup copy](backup-copy.md) - Copy a backup from source backup to given region * [oasisctl backup download](backup-download.md) - Download a backup diff --git a/site/content/3.10/arangograph/oasisctl/backup/backup-copy.md b/site/content/3.10/arangograph/oasisctl/backup/backup-copy.md index d780497131..5ce4b9826f 100644 --- a/site/content/3.10/arangograph/oasisctl/backup/backup-copy.md +++ b/site/content/3.10/arangograph/oasisctl/backup/backup-copy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl backup copy command title: Oasisctl Backup Copy menuTitle: Backup Copy -weight: 5 -description: >- - Description of the oasisctl backup copy command -archetype: default +weight: 10 --- -Copy a backup from source backup to given region - ## Synopsis - Copy a backup from source backup to given region ``` @@ -17,15 +13,13 @@ oasisctl backup copy [flags] ``` ## Options - ``` -h, --help help for copy --region-id string Identifier of the region where the new backup is to be created --source-backup-id string Identifier of the source backup ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl backup copy [flags] ``` ## See also - * [oasisctl backup](_index.md) - Backup commands diff --git a/site/content/3.10/arangograph/oasisctl/backup/backup-download.md b/site/content/3.10/arangograph/oasisctl/backup/backup-download.md index beb30e749d..49157eb4fa 100644 --- a/site/content/3.10/arangograph/oasisctl/backup/backup-download.md +++ b/site/content/3.10/arangograph/oasisctl/backup/backup-download.md @@ -1,30 +1,24 @@ --- +layout: default +description: Description of the oasisctl backup download command title: Oasisctl Backup Download menuTitle: Backup Download -weight: 10 -description: >- - Description of the oasisctl backup download command -archetype: default +weight: 15 --- -Download a backup - ## Synopsis - -Download a backup from the cloud storage to the local deployment disks, so it can be restored. +Download a backup ``` oasisctl backup download [flags] ``` ## Options - ``` -h, --help help for download -i, --id string Identifier of the backup ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl backup download [flags] ``` ## See also - * [oasisctl backup](_index.md) - Backup commands diff --git a/site/content/3.10/arangograph/oasisctl/clone/_index.md b/site/content/3.10/arangograph/oasisctl/clone/_index.md index 9f6e0334c4..034f9518a5 100644 --- a/site/content/3.10/arangograph/oasisctl/clone/_index.md +++ b/site/content/3.10/arangograph/oasisctl/clone/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl clone command title: Oasisctl Clone menuTitle: Clone -weight: 30 -description: >- - Description of the oasisctl clone command -archetype: chapter +weight: 5 --- -Clone resources - ## Synopsis - Clone resources ``` @@ -17,13 +13,11 @@ oasisctl clone [flags] ``` ## Options - ``` -h, --help help for clone ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl clone [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl clone deployment](clone-deployment.md) - Clone deployment resources diff --git a/site/content/3.10/arangograph/oasisctl/clone/clone-deployment-backup.md b/site/content/3.10/arangograph/oasisctl/clone/clone-deployment-backup.md index 3404df622e..7c1989d60c 100644 --- a/site/content/3.10/arangograph/oasisctl/clone/clone-deployment-backup.md +++ b/site/content/3.10/arangograph/oasisctl/clone/clone-deployment-backup.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl clone deployment backup command title: Oasisctl Clone Deployment Backup menuTitle: Clone Deployment Backup -weight: 10 -description: >- - Description of the oasisctl clone deployment backup command -archetype: default +weight: 15 --- -Clone a deployment from a backup. - ## Synopsis - Clone a deployment from a backup. ``` @@ -17,7 +13,6 @@ oasisctl clone deployment backup [flags] ``` ## Options - ``` --accept Accept the current terms and conditions. -b, --backup-id string Clone a deployment from a backup using the backup's ID. @@ -27,8 +22,7 @@ oasisctl clone deployment backup [flags] -r, --region-id string An optionally defined region in which the new deployment should be created in. ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl clone deployment backup [flags] ``` ## See also - * [oasisctl clone deployment](clone-deployment.md) - Clone deployment resources diff --git a/site/content/3.10/arangograph/oasisctl/clone/clone-deployment.md b/site/content/3.10/arangograph/oasisctl/clone/clone-deployment.md index 763ab612f3..3fc0917af8 100644 --- a/site/content/3.10/arangograph/oasisctl/clone/clone-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/clone/clone-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl clone deployment command title: Oasisctl Clone Deployment menuTitle: Clone Deployment -weight: 5 -description: >- - Description of the oasisctl clone deployment command -archetype: default +weight: 10 --- -Clone deployment resources - ## Synopsis - Clone deployment resources ``` @@ -17,13 +13,11 @@ oasisctl clone deployment [flags] ``` ## Options - ``` -h, --help help for deployment ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl clone deployment [flags] ``` ## See also - * [oasisctl clone](_index.md) - Clone resources * [oasisctl clone deployment backup](clone-deployment-backup.md) - Clone a deployment from a backup. diff --git a/site/content/3.10/arangograph/oasisctl/completion.md b/site/content/3.10/arangograph/oasisctl/completion.md index 0a21c459ad..2e60787a92 100644 --- a/site/content/3.10/arangograph/oasisctl/completion.md +++ b/site/content/3.10/arangograph/oasisctl/completion.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl completion command title: Oasisctl Completion menuTitle: Completion -weight: 35 -description: >- - Description of the oasisctl completion command -archetype: default +weight: 10 --- -Generates bash completion scripts - ## Synopsis - To load completion run . <(oasisctl completion [bash|fish|powershell|zsh]) @@ -25,13 +21,11 @@ oasisctl completion [flags] ``` ## Options - ``` -h, --help help for completion ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -39,6 +33,5 @@ oasisctl completion [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/create/_index.md b/site/content/3.10/arangograph/oasisctl/create/_index.md index 30f0d7c507..c099ba5671 100644 --- a/site/content/3.10/arangograph/oasisctl/create/_index.md +++ b/site/content/3.10/arangograph/oasisctl/create/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create command title: Oasisctl Create menuTitle: Create -weight: 40 -description: >- - Description of the oasisctl create command -archetype: chapter +weight: 5 --- -Create resources - ## Synopsis - Create resources ``` @@ -17,13 +13,11 @@ oasisctl create [flags] ``` ## Options - ``` -h, --help help for create ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl create [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl create apikey](create-apikey.md) - Create a new API key * [oasisctl create auditlog](create-auditlog.md) - Create an auditlog diff --git a/site/content/3.10/arangograph/oasisctl/create/create-apikey.md b/site/content/3.10/arangograph/oasisctl/create/create-apikey.md index 3e84c15a8b..5234621804 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-apikey.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-apikey.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create apikey command title: Oasisctl Create Apikey -menuTitle: Create API Key -weight: 5 -description: >- - Description of the oasisctl create apikey command -archetype: default +menuTitle: Create Apikey +weight: 10 --- -Create a new API key - ## Synopsis - Create a new API key ``` @@ -17,15 +13,13 @@ oasisctl create apikey [flags] ``` ## Options - ``` -h, --help help for apikey -o, --organization-id string If set, the newly created API key will grant access to this organization only --readonly If set, the newly created API key will grant readonly access only ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl create apikey [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-auditlog.md b/site/content/3.10/arangograph/oasisctl/create/create-auditlog.md index 535b34abec..92807891df 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-auditlog.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-auditlog.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create auditlog command title: Oasisctl Create Auditlog -menuTitle: Create Audit Log -weight: 10 -description: >- - Description of the oasisctl create auditlog command -archetype: default +menuTitle: Create Auditlog +weight: 15 --- -Create an auditlog - ## Synopsis - Create an auditlog ``` @@ -17,7 +13,6 @@ oasisctl create auditlog [flags] ``` ## Options - ``` --default If set, this AuditLog is the default for the organization. --description string Description of the audit log. @@ -26,8 +21,7 @@ oasisctl create auditlog [flags] -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl create auditlog [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-backup-policy.md b/site/content/3.10/arangograph/oasisctl/create/create-backup-policy.md index a8a8b8722c..f7d7601e01 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-backup-policy.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-backup-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create backup policy command title: Oasisctl Create Backup Policy menuTitle: Create Backup Policy -weight: 20 -description: >- - Description of the oasisctl create backup policy command -archetype: default +weight: 25 --- -Create a new backup policy - ## Synopsis - Create a new backup policy ``` @@ -17,7 +13,6 @@ oasisctl create backup policy [flags] ``` ## Options - ``` --additional-region-ids strings Add backup to the specified addition regions --day-of-the-month int32 Run the backup on the specified day of the month (1-31) (default 1) @@ -44,8 +39,7 @@ oasisctl create backup policy [flags] --wednesday If set, a backup will be created on Wednesdays ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -53,6 +47,5 @@ oasisctl create backup policy [flags] ``` ## See also - * [oasisctl create backup](create-backup.md) - Create backup ... diff --git a/site/content/3.10/arangograph/oasisctl/create/create-backup.md b/site/content/3.10/arangograph/oasisctl/create/create-backup.md index fc0da21d11..7760878718 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-backup.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-backup.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create backup command title: Oasisctl Create Backup menuTitle: Create Backup -weight: 15 -description: >- - Description of the oasisctl create backup command -archetype: default +weight: 20 --- -Create backup ... - ## Synopsis - Create backup ... ``` @@ -17,7 +13,6 @@ oasisctl create backup [flags] ``` ## Options - ``` --auto-deleted-at int Time (h) until auto delete of the backup --deployment-id string ID of the deployment @@ -27,8 +22,7 @@ oasisctl create backup [flags] --upload The backup should be uploaded ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,7 +30,6 @@ oasisctl create backup [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources * [oasisctl create backup policy](create-backup-policy.md) - Create a new backup policy diff --git a/site/content/3.10/arangograph/oasisctl/create/create-cacertificate.md b/site/content/3.10/arangograph/oasisctl/create/create-cacertificate.md index 1ce59809e1..a2f4784c5e 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-cacertificate.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-cacertificate.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create cacertificate command title: Oasisctl Create Cacertificate -menuTitle: Create CA Certificate -weight: 25 -description: >- - Description of the oasisctl create cacertificate command -archetype: default +menuTitle: Create Cacertificate +weight: 30 --- -Create a new CA certificate - ## Synopsis - Create a new CA certificate ``` @@ -17,7 +13,6 @@ oasisctl create cacertificate [flags] ``` ## Options - ``` --description string Description of the CA certificate -h, --help help for cacertificate @@ -27,8 +22,7 @@ oasisctl create cacertificate [flags] -p, --project-id string Identifier of the project to create the CA certificate in ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl create cacertificate [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-deployment.md b/site/content/3.10/arangograph/oasisctl/create/create-deployment.md index 8badb3cd50..422d5a430e 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create deployment command title: Oasisctl Create Deployment menuTitle: Create Deployment -weight: 30 -description: >- - Description of the oasisctl create deployment command -archetype: default +weight: 35 --- -Create a new deployment - ## Synopsis - Create a new deployment ``` @@ -17,7 +13,6 @@ oasisctl create deployment [flags] ``` ## Options - ``` --accept Accept the current terms and conditions. -c, --cacertificate-id string Identifier of the CA certificate to use for the deployment @@ -47,8 +42,7 @@ oasisctl create deployment [flags] --version string Version of ArangoDB to use for the deployment ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -56,6 +50,5 @@ oasisctl create deployment [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-example-installation.md b/site/content/3.10/arangograph/oasisctl/create/create-example-installation.md index f7ecf3afab..b3cb4aa864 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-example-installation.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-example-installation.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create example installation command title: Oasisctl Create Example Installation menuTitle: Create Example Installation -weight: 40 -description: >- - Description of the oasisctl create example installation command -archetype: default +weight: 45 --- -Create a new example dataset installation - ## Synopsis - Create a new example dataset installation ``` @@ -17,7 +13,6 @@ oasisctl create example installation [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment to list installations for -e, --example-dataset-id string ID of the example dataset @@ -26,8 +21,7 @@ oasisctl create example installation [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl create example installation [flags] ``` ## See also - * [oasisctl create example](create-example.md) - Create example ... diff --git a/site/content/3.10/arangograph/oasisctl/create/create-example.md b/site/content/3.10/arangograph/oasisctl/create/create-example.md index 621b1854e3..25f227ac9e 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-example.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-example.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create example command title: Oasisctl Create Example menuTitle: Create Example -weight: 35 -description: >- - Description of the oasisctl create example command -archetype: default +weight: 40 --- -Create example ... - ## Synopsis - Create example ... ``` @@ -17,13 +13,11 @@ oasisctl create example [flags] ``` ## Options - ``` -h, --help help for example ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl create example [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources * [oasisctl create example installation](create-example-installation.md) - Create a new example dataset installation diff --git a/site/content/3.10/arangograph/oasisctl/create/create-group.md b/site/content/3.10/arangograph/oasisctl/create/create-group.md index 791e76ec9b..a29792cffa 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-group.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-group.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create group command title: Oasisctl Create Group menuTitle: Create Group -weight: 45 -description: >- - Description of the oasisctl create group command -archetype: default +weight: 50 --- -Create a new group - ## Synopsis - Create a new group ``` @@ -17,7 +13,6 @@ oasisctl create group [flags] ``` ## Options - ``` --description string Description of the group -h, --help help for group @@ -25,8 +20,7 @@ oasisctl create group [flags] -o, --organization-id string Identifier of the organization to create the group in ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl create group [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-ipallowlist.md b/site/content/3.10/arangograph/oasisctl/create/create-ipallowlist.md index 20238d628f..1e620a7a0d 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-ipallowlist.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-ipallowlist.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create ipallowlist command title: Oasisctl Create Ipallowlist -menuTitle: Create IP Allowlist -weight: 50 -description: >- - Description of the oasisctl create ipallowlist command -archetype: default +menuTitle: Create Ipallowlist +weight: 55 --- -Create a new IP allowlist - ## Synopsis - Create a new IP allowlist ``` @@ -17,7 +13,6 @@ oasisctl create ipallowlist [flags] ``` ## Options - ``` --cidr-range strings List of CIDR ranges from which deployments are accessible --description string Description of the IP allowlist @@ -28,8 +23,7 @@ oasisctl create ipallowlist [flags] --remote-inspection-allowed If set, remote connectivity checks by the Oasis platform are allowed ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -37,6 +31,5 @@ oasisctl create ipallowlist [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-metrics-token.md b/site/content/3.10/arangograph/oasisctl/create/create-metrics-token.md index 15ae20c878..c8d60607df 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-metrics-token.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-metrics-token.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create metrics token command title: Oasisctl Create Metrics Token menuTitle: Create Metrics Token -weight: 60 -description: >- - Description of the oasisctl create metrics token command -archetype: default +weight: 65 --- -Create a new metrics access token - ## Synopsis - Create a new metrics access token ``` @@ -17,7 +13,6 @@ oasisctl create metrics token [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment to create the token for --description string Description of the token @@ -28,8 +23,7 @@ oasisctl create metrics token [flags] -p, --project-id string Identifier of the project to create the token in ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -37,6 +31,5 @@ oasisctl create metrics token [flags] ``` ## See also - * [oasisctl create metrics](create-metrics.md) - Create metrics resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-metrics.md b/site/content/3.10/arangograph/oasisctl/create/create-metrics.md index 6433f84daa..ecd202e17d 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-metrics.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-metrics.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create metrics command title: Oasisctl Create Metrics menuTitle: Create Metrics -weight: 55 -description: >- - Description of the oasisctl create metrics command -archetype: default +weight: 60 --- -Create metrics resources - ## Synopsis - Create metrics resources ``` @@ -17,13 +13,11 @@ oasisctl create metrics [flags] ``` ## Options - ``` -h, --help help for metrics ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl create metrics [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources * [oasisctl create metrics token](create-metrics-token.md) - Create a new metrics access token diff --git a/site/content/3.10/arangograph/oasisctl/create/create-notebook.md b/site/content/3.10/arangograph/oasisctl/create/create-notebook.md index 3f3e272040..51edf8b6a5 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-notebook.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-notebook.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create notebook command title: Oasisctl Create Notebook menuTitle: Create Notebook -weight: 65 -description: >- - Description of the oasisctl create notebook command -archetype: default +weight: 70 --- -Create a new notebook - ## Synopsis - Create a new notebook ``` @@ -17,7 +13,6 @@ oasisctl create notebook [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment that the notebook has to run next to --description string Description of the notebook @@ -29,8 +24,7 @@ oasisctl create notebook [flags] -p, --project-id string Identifier of the project to create the notebook in ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -38,6 +32,5 @@ oasisctl create notebook [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-organization-invite.md b/site/content/3.10/arangograph/oasisctl/create/create-organization-invite.md index 2775806b04..113aa5d627 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-organization-invite.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-organization-invite.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create organization invite command title: Oasisctl Create Organization Invite menuTitle: Create Organization Invite -weight: 75 -description: >- - Description of the oasisctl create organization invite command -archetype: default +weight: 80 --- -Create a new invite to an organization - ## Synopsis - Create a new invite to an organization ``` @@ -17,15 +13,13 @@ oasisctl create organization invite [flags] ``` ## Options - ``` --email string Email address of the person to invite -h, --help help for invite -o, --organization-id string Identifier of the organization to create the invite in ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl create organization invite [flags] ``` ## See also - * [oasisctl create organization](create-organization.md) - Create a new organization diff --git a/site/content/3.10/arangograph/oasisctl/create/create-organization.md b/site/content/3.10/arangograph/oasisctl/create/create-organization.md index 18eec889d2..5af0c760ac 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-organization.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create organization command title: Oasisctl Create Organization menuTitle: Create Organization -weight: 70 -description: >- - Description of the oasisctl create organization command -archetype: default +weight: 75 --- -Create a new organization - ## Synopsis - Create a new organization ``` @@ -17,15 +13,13 @@ oasisctl create organization [flags] ``` ## Options - ``` --description string Description of the organization -h, --help help for organization --name string Name of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,7 +27,6 @@ oasisctl create organization [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources * [oasisctl create organization invite](create-organization-invite.md) - Create a new invite to an organization diff --git a/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint-service.md b/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint-service.md index 961491fbb6..f5a58c8c7b 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint-service.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint-service.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create private endpoint service command title: Oasisctl Create Private Endpoint Service menuTitle: Create Private Endpoint Service -weight: 90 -description: >- - Description of the oasisctl create private endpoint service command -archetype: default +weight: 95 --- -Create a Private Endpoint Service attached to an existing deployment - ## Synopsis - Create a Private Endpoint Service attached to an existing deployment ``` @@ -17,7 +13,6 @@ oasisctl create private endpoint service [flags] ``` ## Options - ``` --alternate-dns-name strings DNS names used for the deployment in the private network --aws-principal strings List of AWS Principals from which a Private Endpoint can be created (Format: [/Role/|/User/]) @@ -31,8 +26,7 @@ oasisctl create private endpoint service [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -40,6 +34,5 @@ oasisctl create private endpoint service [flags] ``` ## See also - * [oasisctl create private endpoint](create-private-endpoint.md) - diff --git a/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint.md b/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint.md index e11036e693..235c1be41e 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-private-endpoint.md @@ -1,27 +1,23 @@ --- +layout: default +description: Description of the oasisctl create private endpoint command title: Oasisctl Create Private Endpoint menuTitle: Create Private Endpoint -weight: 85 -description: >- - Description of the oasisctl create private endpoint command -archetype: default +weight: 90 --- ## Synopsis - ``` oasisctl create private endpoint [flags] ``` ## Options - ``` -h, --help help for endpoint ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -29,7 +25,6 @@ oasisctl create private endpoint [flags] ``` ## See also - * [oasisctl create private](create-private.md) - Create private resources * [oasisctl create private endpoint service](create-private-endpoint-service.md) - Create a Private Endpoint Service attached to an existing deployment diff --git a/site/content/3.10/arangograph/oasisctl/create/create-private.md b/site/content/3.10/arangograph/oasisctl/create/create-private.md index d648e38bd0..12284f0466 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-private.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-private.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create private command title: Oasisctl Create Private menuTitle: Create Private -weight: 80 -description: >- - Description of the oasisctl create private command -archetype: default +weight: 85 --- -Create private resources - ## Synopsis - Create private resources ``` @@ -17,13 +13,11 @@ oasisctl create private [flags] ``` ## Options - ``` -h, --help help for private ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl create private [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources * [oasisctl create private endpoint](create-private-endpoint.md) - diff --git a/site/content/3.10/arangograph/oasisctl/create/create-project.md b/site/content/3.10/arangograph/oasisctl/create/create-project.md index a813eeb46c..1ffb4bff73 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-project.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-project.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create project command title: Oasisctl Create Project menuTitle: Create Project -weight: 95 -description: >- - Description of the oasisctl create project command -archetype: default +weight: 100 --- -Create a new project - ## Synopsis - Create a new project ``` @@ -17,7 +13,6 @@ oasisctl create project [flags] ``` ## Options - ``` --description string Description of the project -h, --help help for project @@ -25,8 +20,7 @@ oasisctl create project [flags] -o, --organization-id string Identifier of the organization to create the project in ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl create project [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/create/create-role.md b/site/content/3.10/arangograph/oasisctl/create/create-role.md index 22190f2623..f759d32ea3 100644 --- a/site/content/3.10/arangograph/oasisctl/create/create-role.md +++ b/site/content/3.10/arangograph/oasisctl/create/create-role.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl create role command title: Oasisctl Create Role menuTitle: Create Role -weight: 100 -description: >- - Description of the oasisctl create role command -archetype: default +weight: 105 --- -Create a new role - ## Synopsis - Create a new role ``` @@ -17,7 +13,6 @@ oasisctl create role [flags] ``` ## Options - ``` --description string Description of the role -h, --help help for role @@ -26,8 +21,7 @@ oasisctl create role [flags] -p, --permission strings Permissions granted by the role ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl create role [flags] ``` ## See also - * [oasisctl create](_index.md) - Create resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/_index.md b/site/content/3.10/arangograph/oasisctl/delete/_index.md index 1bffa781a3..a12a8f4e9a 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/_index.md +++ b/site/content/3.10/arangograph/oasisctl/delete/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete command title: Oasisctl Delete menuTitle: Delete -weight: 45 -description: >- - Description of the oasisctl delete command -archetype: chapter +weight: 5 --- -Delete resources - ## Synopsis - Delete resources ``` @@ -17,13 +13,11 @@ oasisctl delete [flags] ``` ## Options - ``` -h, --help help for delete ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl delete [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl delete apikey](delete-apikey.md) - Delete an API key with given identifier * [oasisctl delete auditlog](delete-auditlog.md) - Delete an auditlog diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-apikey.md b/site/content/3.10/arangograph/oasisctl/delete/delete-apikey.md index cd0f708dcf..19587f69a2 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-apikey.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-apikey.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete apikey command title: Oasisctl Delete Apikey -menuTitle: Delete API Key -weight: 5 -description: >- - Description of the oasisctl delete apikey command -archetype: default +menuTitle: Delete Apikey +weight: 10 --- -Delete an API key with given identifier - ## Synopsis - Delete an API key with given identifier ``` @@ -17,14 +13,12 @@ oasisctl delete apikey [flags] ``` ## Options - ``` -i, --apikey-id string Identifier of the API key to delete -h, --help help for apikey ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl delete apikey [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive-events.md b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive-events.md index 6230bba9f3..085dcb65bd 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive-events.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive-events.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete auditlog archive events command title: Oasisctl Delete Auditlog Archive Events menuTitle: Delete Audit Log Archive Events -weight: 20 -description: >- - Description of the oasisctl delete auditlog archive events command -archetype: default +weight: 25 --- -Delete auditlog archive events - ## Synopsis - Delete auditlog archive events ``` @@ -17,15 +13,13 @@ oasisctl delete auditlog archive events [flags] ``` ## Options - ``` -i, --auditlog-archive-id string Identifier of the auditlog archive to delete events from. -h, --help help for events --to string Remove events created before this timestamp. ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl delete auditlog archive events [flags] ``` ## See also - * [oasisctl delete auditlog archive](delete-auditlog-archive.md) - Delete an auditlog archive diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive.md b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive.md index c013513237..09246abe89 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-archive.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete auditlog archive command title: Oasisctl Delete Auditlog Archive menuTitle: Delete Audit Log Archive -weight: 15 -description: >- - Description of the oasisctl delete auditlog archive command -archetype: default +weight: 20 --- -Delete an auditlog archive - ## Synopsis - Delete an auditlog archive ``` @@ -17,14 +13,12 @@ oasisctl delete auditlog archive [flags] ``` ## Options - ``` -i, --auditlog-archive-id string Identifier of the auditlog archive to delete. -h, --help help for archive ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,7 +26,6 @@ oasisctl delete auditlog archive [flags] ``` ## See also - * [oasisctl delete auditlog](delete-auditlog.md) - Delete an auditlog * [oasisctl delete auditlog archive events](delete-auditlog-archive-events.md) - Delete auditlog archive events diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-destination.md b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-destination.md index d2bbd1d620..f78900fadd 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-destination.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog-destination.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete auditlog destination command title: Oasisctl Delete Auditlog Destination menuTitle: Delete Audit Log Destination -weight: 25 -description: >- - Description of the oasisctl delete auditlog destination command -archetype: default +weight: 30 --- -Delete a destination from an auditlog - ## Synopsis - Delete a destination from an auditlog ``` @@ -17,7 +13,6 @@ oasisctl delete auditlog destination [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog to delete. -h, --help help for destination @@ -27,8 +22,7 @@ oasisctl delete auditlog destination [flags] --url string An optional URL which will be used to delete a single destination instead of all. ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl delete auditlog destination [flags] ``` ## See also - * [oasisctl delete auditlog](delete-auditlog.md) - Delete an auditlog diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog.md b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog.md index f4339c7fe9..409abafbbb 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-auditlog.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete auditlog command title: Oasisctl Delete Auditlog -menuTitle: Delete Audit Log -weight: 10 -description: >- - Description of the oasisctl delete auditlog command -archetype: default +menuTitle: Delete Auditlog +weight: 15 --- -Delete an auditlog - ## Synopsis - Delete an auditlog ``` @@ -17,15 +13,13 @@ oasisctl delete auditlog [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog to delete. -h, --help help for auditlog -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,7 +27,6 @@ oasisctl delete auditlog [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources * [oasisctl delete auditlog archive](delete-auditlog-archive.md) - Delete an auditlog archive * [oasisctl delete auditlog destination](delete-auditlog-destination.md) - Delete a destination from an auditlog diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-backup-policy.md b/site/content/3.10/arangograph/oasisctl/delete/delete-backup-policy.md index 79cc713e07..5c4e57373e 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-backup-policy.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-backup-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete backup policy command title: Oasisctl Delete Backup Policy menuTitle: Delete Backup Policy -weight: 35 -description: >- - Description of the oasisctl delete backup policy command -archetype: default +weight: 40 --- -Delete a backup policy for a given ID. - ## Synopsis - Delete a backup policy for a given ID. ``` @@ -17,7 +13,6 @@ oasisctl delete backup policy [flags] ``` ## Options - ``` -h, --help help for policy -i, --id string Identifier of the backup policy @@ -25,8 +20,7 @@ oasisctl delete backup policy [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl delete backup policy [flags] ``` ## See also - * [oasisctl delete backup](delete-backup.md) - Delete a backup for a given ID. diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-backup.md b/site/content/3.10/arangograph/oasisctl/delete/delete-backup.md index ae8724cf19..31922f25f4 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-backup.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-backup.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete backup command title: Oasisctl Delete Backup menuTitle: Delete Backup -weight: 30 -description: >- - Description of the oasisctl delete backup command -archetype: default +weight: 35 --- -Delete a backup for a given ID. - ## Synopsis - Delete a backup for a given ID. ``` @@ -17,14 +13,12 @@ oasisctl delete backup [flags] ``` ## Options - ``` -h, --help help for backup -i, --id string Identifier of the backup ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,7 +26,6 @@ oasisctl delete backup [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources * [oasisctl delete backup policy](delete-backup-policy.md) - Delete a backup policy for a given ID. diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-cacertificate.md b/site/content/3.10/arangograph/oasisctl/delete/delete-cacertificate.md index 8d60f072c3..51d6d8309d 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-cacertificate.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-cacertificate.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete cacertificate command title: Oasisctl Delete Cacertificate -menuTitle: Delete CA Certificate -weight: 40 -description: >- - Description of the oasisctl delete cacertificate command -archetype: default +menuTitle: Delete Cacertificate +weight: 45 --- -Delete a CA certificate the authenticated user has access to - ## Synopsis - Delete a CA certificate the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl delete cacertificate [flags] ``` ## Options - ``` -c, --cacertificate-id string Identifier of the CA certificate -h, --help help for cacertificate @@ -25,8 +20,7 @@ oasisctl delete cacertificate [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl delete cacertificate [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-deployment.md b/site/content/3.10/arangograph/oasisctl/delete/delete-deployment.md index 9f5b1f02d8..29418c62d5 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete deployment command title: Oasisctl Delete Deployment menuTitle: Delete Deployment -weight: 45 -description: >- - Description of the oasisctl delete deployment command -archetype: default +weight: 50 --- -Delete a deployment the authenticated user has access to - ## Synopsis - Delete a deployment the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl delete deployment [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for deployment @@ -25,8 +20,7 @@ oasisctl delete deployment [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl delete deployment [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-example-installation.md b/site/content/3.10/arangograph/oasisctl/delete/delete-example-installation.md index c776e0b3a7..6c9eddd107 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-example-installation.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-example-installation.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete example installation command title: Oasisctl Delete Example Installation menuTitle: Delete Example Installation -weight: 55 -description: >- - Description of the oasisctl delete example installation command -archetype: default +weight: 60 --- -Delete an example datasets installation - ## Synopsis - Delete an example datasets installation ``` @@ -17,7 +13,6 @@ oasisctl delete example installation [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment to list installations for -h, --help help for installation @@ -26,8 +21,7 @@ oasisctl delete example installation [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl delete example installation [flags] ``` ## See also - * [oasisctl delete example](delete-example.md) - Delete example ... diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-example.md b/site/content/3.10/arangograph/oasisctl/delete/delete-example.md index 1561b99ba9..08623842a0 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-example.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-example.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete example command title: Oasisctl Delete Example menuTitle: Delete Example -weight: 50 -description: >- - Description of the oasisctl delete example command -archetype: default +weight: 55 --- -Delete example ... - ## Synopsis - Delete example ... ``` @@ -17,13 +13,11 @@ oasisctl delete example [flags] ``` ## Options - ``` -h, --help help for example ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl delete example [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources * [oasisctl delete example installation](delete-example-installation.md) - Delete an example datasets installation diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-group-members.md b/site/content/3.10/arangograph/oasisctl/delete/delete-group-members.md index 8c4287410f..5c8a8af518 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-group-members.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-group-members.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete group members command title: Oasisctl Delete Group Members menuTitle: Delete Group Members -weight: 65 -description: >- - Description of the oasisctl delete group members command -archetype: default +weight: 70 --- -Delete members from group - ## Synopsis - Delete members from group ``` @@ -17,7 +13,6 @@ oasisctl delete group members [flags] ``` ## Options - ``` -g, --group-id string Identifier of the group to delete members from -h, --help help for members @@ -25,8 +20,7 @@ oasisctl delete group members [flags] -u, --user-emails strings A comma separated list of user email addresses ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl delete group members [flags] ``` ## See also - * [oasisctl delete group](delete-group.md) - Delete a group the authenticated user has access to diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-group.md b/site/content/3.10/arangograph/oasisctl/delete/delete-group.md index 256feabe8a..f29fc55879 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-group.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-group.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete group command title: Oasisctl Delete Group menuTitle: Delete Group -weight: 60 -description: >- - Description of the oasisctl delete group command -archetype: default +weight: 65 --- -Delete a group the authenticated user has access to - ## Synopsis - Delete a group the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl delete group [flags] ``` ## Options - ``` -g, --group-id string Identifier of the group -h, --help help for group -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,7 +27,6 @@ oasisctl delete group [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources * [oasisctl delete group members](delete-group-members.md) - Delete members from group diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-ipallowlist.md b/site/content/3.10/arangograph/oasisctl/delete/delete-ipallowlist.md index 7404139094..a4b1ce7974 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-ipallowlist.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-ipallowlist.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete ipallowlist command title: Oasisctl Delete Ipallowlist -menuTitle: Delete IP Allowlist -weight: 70 -description: >- - Description of the oasisctl delete ipallowlist command -archetype: default +menuTitle: Delete Ipallowlist +weight: 75 --- -Delete an IP allowlist the authenticated user has access to - ## Synopsis - Delete an IP allowlist the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl delete ipallowlist [flags] ``` ## Options - ``` -h, --help help for ipallowlist -i, --ipallowlist-id string Identifier of the IP allowlist @@ -25,8 +20,7 @@ oasisctl delete ipallowlist [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl delete ipallowlist [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-metrics-token.md b/site/content/3.10/arangograph/oasisctl/delete/delete-metrics-token.md index 708dbab227..57da1c265d 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-metrics-token.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-metrics-token.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete metrics token command title: Oasisctl Delete Metrics Token menuTitle: Delete Metrics Token -weight: 80 -description: >- - Description of the oasisctl delete metrics token command -archetype: default +weight: 85 --- -Delete a metrics token for a deployment - ## Synopsis - Delete a metrics token for a deployment ``` @@ -17,7 +13,6 @@ oasisctl delete metrics token [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for token @@ -26,8 +21,7 @@ oasisctl delete metrics token [flags] -t, --token-id string Identifier of the metrics token ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl delete metrics token [flags] ``` ## See also - * [oasisctl delete metrics](delete-metrics.md) - Delete metrics resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-metrics.md b/site/content/3.10/arangograph/oasisctl/delete/delete-metrics.md index e3e24b361c..9c2fc72015 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-metrics.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-metrics.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete metrics command title: Oasisctl Delete Metrics menuTitle: Delete Metrics -weight: 75 -description: >- - Description of the oasisctl delete metrics command -archetype: default +weight: 80 --- -Delete metrics resources - ## Synopsis - Delete metrics resources ``` @@ -17,13 +13,11 @@ oasisctl delete metrics [flags] ``` ## Options - ``` -h, --help help for metrics ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl delete metrics [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources * [oasisctl delete metrics token](delete-metrics-token.md) - Delete a metrics token for a deployment diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-notebook.md b/site/content/3.10/arangograph/oasisctl/delete/delete-notebook.md index 43b3c0eaa8..6ea05653b1 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-notebook.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-notebook.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete notebook command title: Oasisctl Delete Notebook menuTitle: Delete Notebook -weight: 85 -description: >- - Description of the oasisctl delete notebook command -archetype: default +weight: 90 --- -Delete a notebook - ## Synopsis - Delete a notebook ``` @@ -17,14 +13,12 @@ oasisctl delete notebook [flags] ``` ## Options - ``` -h, --help help for notebook -n, --notebook-id string Identifier of the notebook ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl delete notebook [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-organization-invite.md b/site/content/3.10/arangograph/oasisctl/delete/delete-organization-invite.md index 97971f9d54..e86331ead3 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-organization-invite.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-organization-invite.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete organization invite command title: Oasisctl Delete Organization Invite menuTitle: Delete Organization Invite -weight: 95 -description: >- - Description of the oasisctl delete organization invite command -archetype: default +weight: 100 --- -Delete an organization invite the authenticated user has access to - ## Synopsis - Delete an organization invite the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl delete organization invite [flags] ``` ## Options - ``` -h, --help help for invite -i, --invite-id string Identifier of the organization invite -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl delete organization invite [flags] ``` ## See also - * [oasisctl delete organization](delete-organization.md) - Delete an organization the authenticated user has access to diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-organization-members.md b/site/content/3.10/arangograph/oasisctl/delete/delete-organization-members.md index 00d115e7ec..2d2394ffd5 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-organization-members.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-organization-members.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete organization members command title: Oasisctl Delete Organization Members menuTitle: Delete Organization Members -weight: 100 -description: >- - Description of the oasisctl delete organization members command -archetype: default +weight: 105 --- -Delete members from organization - ## Synopsis - Delete members from organization ``` @@ -17,15 +13,13 @@ oasisctl delete organization members [flags] ``` ## Options - ``` -h, --help help for members -o, --organization-id string Identifier of the organization -u, --user-emails strings A comma separated list of user email addresses ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl delete organization members [flags] ``` ## See also - * [oasisctl delete organization](delete-organization.md) - Delete an organization the authenticated user has access to diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-organization.md b/site/content/3.10/arangograph/oasisctl/delete/delete-organization.md index 622703c099..f54c66f91b 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-organization.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete organization command title: Oasisctl Delete Organization menuTitle: Delete Organization -weight: 90 -description: >- - Description of the oasisctl delete organization command -archetype: default +weight: 95 --- -Delete an organization the authenticated user has access to - ## Synopsis - Delete an organization the authenticated user has access to ``` @@ -17,14 +13,12 @@ oasisctl delete organization [flags] ``` ## Options - ``` -h, --help help for organization -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,7 +26,6 @@ oasisctl delete organization [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources * [oasisctl delete organization invite](delete-organization-invite.md) - Delete an organization invite the authenticated user has access to * [oasisctl delete organization members](delete-organization-members.md) - Delete members from organization diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-project.md b/site/content/3.10/arangograph/oasisctl/delete/delete-project.md index 85210de3f0..d970f1630e 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-project.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-project.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete project command title: Oasisctl Delete Project menuTitle: Delete Project -weight: 105 -description: >- - Description of the oasisctl delete project command -archetype: default +weight: 110 --- -Delete a project the authenticated user has access to - ## Synopsis - Delete a project the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl delete project [flags] ``` ## Options - ``` -h, --help help for project -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl delete project [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources diff --git a/site/content/3.10/arangograph/oasisctl/delete/delete-role.md b/site/content/3.10/arangograph/oasisctl/delete/delete-role.md index 2ac1b8e340..42105cd6eb 100644 --- a/site/content/3.10/arangograph/oasisctl/delete/delete-role.md +++ b/site/content/3.10/arangograph/oasisctl/delete/delete-role.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl delete role command title: Oasisctl Delete Role menuTitle: Delete Role -weight: 110 -description: >- - Description of the oasisctl delete role command -archetype: default +weight: 115 --- -Delete a role the authenticated user has access to - ## Synopsis - Delete a role the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl delete role [flags] ``` ## Options - ``` -h, --help help for role -o, --organization-id string Identifier of the organization -r, --role-id string Identifier of the role ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl delete role [flags] ``` ## See also - * [oasisctl delete](_index.md) - Delete resources diff --git a/site/content/3.10/arangograph/oasisctl/disable/_index.md b/site/content/3.10/arangograph/oasisctl/disable/_index.md index 494912c76f..1bcaeec722 100644 --- a/site/content/3.10/arangograph/oasisctl/disable/_index.md +++ b/site/content/3.10/arangograph/oasisctl/disable/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl disable command title: Oasisctl Disable menuTitle: Disable -weight: 50 -description: >- - Description of the oasisctl disable command -archetype: chapter +weight: 5 --- -Disable some settings related to deployment - ## Synopsis - Disable some settings related to deployment ``` @@ -17,13 +13,11 @@ oasisctl disable [flags] ``` ## Options - ``` -h, --help help for disable ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl disable [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl disable scheduled-root-password-rotation](disable-scheduled-root-password-rotation.md) - Disable scheduled root password rotation diff --git a/site/content/3.10/arangograph/oasisctl/disable/disable-scheduled-root-password-rotation.md b/site/content/3.10/arangograph/oasisctl/disable/disable-scheduled-root-password-rotation.md index d62d597883..d769ce3966 100644 --- a/site/content/3.10/arangograph/oasisctl/disable/disable-scheduled-root-password-rotation.md +++ b/site/content/3.10/arangograph/oasisctl/disable/disable-scheduled-root-password-rotation.md @@ -1,15 +1,11 @@ --- -title: Oasisctl Disable Scheduled-root-password-rotation -menuTitle: Disable Scheduled Root Password Rotation -weight: 5 -description: >- - Description of the oasisctl disable scheduled-root-password-rotation command -archetype: default +layout: default +description: Description of the oasisctl disable scheduled-root-password-rotation command +title: Oasisctl Disable Scheduled-Root-Password-Rotation +menuTitle: Disable Scheduled-Root-Password-Rotation +weight: 10 --- -Disable scheduled root password rotation - ## Synopsis - Disable scheduled root password rotation ``` @@ -17,7 +13,6 @@ oasisctl disable scheduled-root-password-rotation [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for scheduled-root-password-rotation @@ -25,8 +20,7 @@ oasisctl disable scheduled-root-password-rotation [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl disable scheduled-root-password-rotation [flags] ``` ## See also - * [oasisctl disable](_index.md) - Disable some settings related to deployment diff --git a/site/content/3.10/arangograph/oasisctl/enable/_index.md b/site/content/3.10/arangograph/oasisctl/enable/_index.md index f3fcba0eb2..ac97ad85f6 100644 --- a/site/content/3.10/arangograph/oasisctl/enable/_index.md +++ b/site/content/3.10/arangograph/oasisctl/enable/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl enable command title: Oasisctl Enable menuTitle: Enable -weight: 55 -description: >- - Description of the oasisctl enable command -archetype: chapter +weight: 5 --- -Enable some settings related to deployment - ## Synopsis - Enable some settings related to deployment ``` @@ -17,13 +13,11 @@ oasisctl enable [flags] ``` ## Options - ``` -h, --help help for enable ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl enable [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl enable scheduled-root-password-rotation](enable-scheduled-root-password-rotation.md) - Enable scheduled root password rotation diff --git a/site/content/3.10/arangograph/oasisctl/enable/enable-scheduled-root-password-rotation.md b/site/content/3.10/arangograph/oasisctl/enable/enable-scheduled-root-password-rotation.md index 3bfc234037..9d9e668337 100644 --- a/site/content/3.10/arangograph/oasisctl/enable/enable-scheduled-root-password-rotation.md +++ b/site/content/3.10/arangograph/oasisctl/enable/enable-scheduled-root-password-rotation.md @@ -1,15 +1,11 @@ --- -title: Oasisctl Enable Scheduled-root-password-rotation -menuTitle: Enable Scheduled Root Password Rotation -weight: 5 -description: >- - Description of the oasisctl enable scheduled-root-password-rotation command -archetype: default +layout: default +description: Description of the oasisctl enable scheduled-root-password-rotation command +title: Oasisctl Enable Scheduled-Root-Password-Rotation +menuTitle: Enable Scheduled-Root-Password-Rotation +weight: 10 --- -Enable scheduled root password rotation - ## Synopsis - Enable scheduled root password rotation ``` @@ -17,7 +13,6 @@ oasisctl enable scheduled-root-password-rotation [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for scheduled-root-password-rotation @@ -25,8 +20,7 @@ oasisctl enable scheduled-root-password-rotation [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl enable scheduled-root-password-rotation [flags] ``` ## See also - * [oasisctl enable](_index.md) - Enable some settings related to deployment diff --git a/site/content/3.10/arangograph/oasisctl/generate-docs.md b/site/content/3.10/arangograph/oasisctl/generate-docs.md index 06598b1dcd..ed878cdeba 100644 --- a/site/content/3.10/arangograph/oasisctl/generate-docs.md +++ b/site/content/3.10/arangograph/oasisctl/generate-docs.md @@ -1,15 +1,11 @@ --- -title: Oasisctl Generate-docs -menuTitle: Generate Docs -weight: 60 -description: >- - Description of the oasisctl generate-docs command -archetype: default +layout: default +description: Description of the oasisctl generate-docs command +title: Oasisctl Generate-Docs +menuTitle: Generate-Docs +weight: 15 --- -Generate output - ## Synopsis - Generate output ``` @@ -17,7 +13,6 @@ oasisctl generate-docs [flags] ``` ## Options - ``` -h, --help help for generate-docs -l, --link-file-ext string What file extensions the links should point to @@ -25,8 +20,7 @@ oasisctl generate-docs [flags] -r, --replace-underscore-with string Replace the underscore in links with the given character ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl generate-docs [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/get/_index.md b/site/content/3.10/arangograph/oasisctl/get/_index.md index 8731a9af81..1ecbf0a13f 100644 --- a/site/content/3.10/arangograph/oasisctl/get/_index.md +++ b/site/content/3.10/arangograph/oasisctl/get/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get command title: Oasisctl Get menuTitle: Get -weight: 65 -description: >- - Description of the oasisctl get command -archetype: chapter +weight: 5 --- -Get information - ## Synopsis - Get information ``` @@ -17,13 +13,11 @@ oasisctl get [flags] ``` ## Options - ``` -h, --help help for get ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl get [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl get auditlog](get-auditlog.md) - Get auditlog archive * [oasisctl get backup](get-backup.md) - Get a backup diff --git a/site/content/3.10/arangograph/oasisctl/get/get-auditlog-archive.md b/site/content/3.10/arangograph/oasisctl/get/get-auditlog-archive.md index 33b8ebe037..1cf8001b6f 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-auditlog-archive.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-auditlog-archive.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get auditlog archive command title: Oasisctl Get Auditlog Archive menuTitle: Get Audit Log Archive -weight: 10 -description: >- - Description of the oasisctl get auditlog archive command -archetype: default +weight: 15 --- -Get auditlog archive - ## Synopsis - Get auditlog archive ``` @@ -17,14 +13,12 @@ oasisctl get auditlog archive [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog -h, --help help for archive ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl get auditlog archive [flags] ``` ## See also - * [oasisctl get auditlog](get-auditlog.md) - Get auditlog archive diff --git a/site/content/3.10/arangograph/oasisctl/get/get-auditlog-events.md b/site/content/3.10/arangograph/oasisctl/get/get-auditlog-events.md index a832b601f6..60a3a324fb 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-auditlog-events.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-auditlog-events.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get auditlog events command title: Oasisctl Get Auditlog Events menuTitle: Get Audit Log Events -weight: 15 -description: >- - Description of the oasisctl get auditlog events command -archetype: default +weight: 20 --- -Get auditlog events - ## Synopsis - Get auditlog events ``` @@ -17,7 +13,6 @@ oasisctl get auditlog events [flags] ``` ## Options - ``` --auditlog-archive-id string If set, include only events from this AuditLogArchive -i, --auditlog-id string Identifier of the auditlog @@ -29,8 +24,7 @@ oasisctl get auditlog events [flags] --to string Request events created before this timestamp ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -38,6 +32,5 @@ oasisctl get auditlog events [flags] ``` ## See also - * [oasisctl get auditlog](get-auditlog.md) - Get auditlog archive diff --git a/site/content/3.10/arangograph/oasisctl/get/get-auditlog.md b/site/content/3.10/arangograph/oasisctl/get/get-auditlog.md index 68da309c63..a39125dc62 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-auditlog.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-auditlog.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get auditlog command title: Oasisctl Get Auditlog -menuTitle: Get Audit Log -weight: 5 -description: >- - Description of the oasisctl get auditlog command -archetype: default +menuTitle: Get Auditlog +weight: 10 --- -Get auditlog archive - ## Synopsis - Get auditlog archive ``` @@ -17,15 +13,13 @@ oasisctl get auditlog [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog -h, --help help for auditlog -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,7 +27,6 @@ oasisctl get auditlog [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information * [oasisctl get auditlog archive](get-auditlog-archive.md) - Get auditlog archive * [oasisctl get auditlog events](get-auditlog-events.md) - Get auditlog events diff --git a/site/content/3.10/arangograph/oasisctl/get/get-backup-policy.md b/site/content/3.10/arangograph/oasisctl/get/get-backup-policy.md index 4f7110a940..0a97e2454e 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-backup-policy.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-backup-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get backup policy command title: Oasisctl Get Backup Policy menuTitle: Get Backup Policy -weight: 25 -description: >- - Description of the oasisctl get backup policy command -archetype: default +weight: 30 --- -Get an existing backup policy - ## Synopsis - Get an existing backup policy ``` @@ -17,14 +13,12 @@ oasisctl get backup policy [flags] ``` ## Options - ``` -h, --help help for policy -i, --id string Identifier of the backup policy (Id|Name|Url) ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl get backup policy [flags] ``` ## See also - * [oasisctl get backup](get-backup.md) - Get a backup diff --git a/site/content/3.10/arangograph/oasisctl/get/get-backup.md b/site/content/3.10/arangograph/oasisctl/get/get-backup.md index 310522d78b..8a30353a0b 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-backup.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-backup.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get backup command title: Oasisctl Get Backup menuTitle: Get Backup -weight: 20 -description: >- - Description of the oasisctl get backup command -archetype: default +weight: 25 --- -Get a backup - ## Synopsis - Get a backup ``` @@ -17,14 +13,12 @@ oasisctl get backup [flags] ``` ## Options - ``` -h, --help help for backup -i, --id string Identifier of the backup ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,7 +26,6 @@ oasisctl get backup [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information * [oasisctl get backup policy](get-backup-policy.md) - Get an existing backup policy diff --git a/site/content/3.10/arangograph/oasisctl/get/get-cacertificate.md b/site/content/3.10/arangograph/oasisctl/get/get-cacertificate.md index 79a4ddd816..9626b24592 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-cacertificate.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-cacertificate.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get cacertificate command title: Oasisctl Get Cacertificate -menuTitle: Get CA Certificate -weight: 30 -description: >- - Description of the oasisctl get cacertificate command -archetype: default +menuTitle: Get Cacertificate +weight: 35 --- -Get a CA certificate the authenticated user has access to - ## Synopsis - Get a CA certificate the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl get cacertificate [flags] ``` ## Options - ``` -c, --cacertificate-id string Identifier of the CA certificate -h, --help help for cacertificate @@ -25,8 +20,7 @@ oasisctl get cacertificate [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl get cacertificate [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-deployment.md b/site/content/3.10/arangograph/oasisctl/get/get-deployment.md index 92fb662dc4..62c75e01cd 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get deployment command title: Oasisctl Get Deployment menuTitle: Get Deployment -weight: 35 -description: >- - Description of the oasisctl get deployment command -archetype: default +weight: 40 --- -Get a deployment the authenticated user has access to - ## Synopsis - Get a deployment the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl get deployment [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for deployment @@ -26,8 +21,7 @@ oasisctl get deployment [flags] --show-root-password show the root password of the database ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl get deployment [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-example-installation.md b/site/content/3.10/arangograph/oasisctl/get/get-example-installation.md index bbef6f5642..4d10c747bf 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-example-installation.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-example-installation.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get example installation command title: Oasisctl Get Example Installation menuTitle: Get Example Installation -weight: 45 -description: >- - Description of the oasisctl get example installation command -archetype: default +weight: 50 --- -Get a single example dataset installation - ## Synopsis - Get a single example dataset installation ``` @@ -17,7 +13,6 @@ oasisctl get example installation [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment to list installations for -h, --help help for installation @@ -26,8 +21,7 @@ oasisctl get example installation [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl get example installation [flags] ``` ## See also - * [oasisctl get example](get-example.md) - Get a single example dataset diff --git a/site/content/3.10/arangograph/oasisctl/get/get-example.md b/site/content/3.10/arangograph/oasisctl/get/get-example.md index f886674676..89b20ec3df 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-example.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-example.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get example command title: Oasisctl Get Example menuTitle: Get Example -weight: 40 -description: >- - Description of the oasisctl get example command -archetype: default +weight: 45 --- -Get a single example dataset - ## Synopsis - Get a single example dataset ``` @@ -17,14 +13,12 @@ oasisctl get example [flags] ``` ## Options - ``` -e, --example-dataset-id string ID of the example dataset -h, --help help for example ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,7 +26,6 @@ oasisctl get example [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information * [oasisctl get example installation](get-example-installation.md) - Get a single example dataset installation diff --git a/site/content/3.10/arangograph/oasisctl/get/get-group.md b/site/content/3.10/arangograph/oasisctl/get/get-group.md index b852a87cb0..458921cae8 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-group.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-group.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get group command title: Oasisctl Get Group menuTitle: Get Group -weight: 50 -description: >- - Description of the oasisctl get group command -archetype: default +weight: 55 --- -Get a group the authenticated user has access to - ## Synopsis - Get a group the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl get group [flags] ``` ## Options - ``` -g, --group-id string Identifier of the group -h, --help help for group -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl get group [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-ipallowlist.md b/site/content/3.10/arangograph/oasisctl/get/get-ipallowlist.md index 0078d60e64..83d1240ca1 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-ipallowlist.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-ipallowlist.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get ipallowlist command title: Oasisctl Get Ipallowlist -menuTitle: Get IP Allowlist -weight: 55 -description: >- - Description of the oasisctl get ipallowlist command -archetype: default +menuTitle: Get Ipallowlist +weight: 60 --- -Get an IP allowlist the authenticated user has access to - ## Synopsis - Get an IP allowlist the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl get ipallowlist [flags] ``` ## Options - ``` -h, --help help for ipallowlist -i, --ipallowlist-id string Identifier of the IP allowlist @@ -25,8 +20,7 @@ oasisctl get ipallowlist [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl get ipallowlist [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-metrics-token.md b/site/content/3.10/arangograph/oasisctl/get/get-metrics-token.md index 94e2102e12..003cf28de6 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-metrics-token.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-metrics-token.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get metrics token command title: Oasisctl Get Metrics Token menuTitle: Get Metrics Token -weight: 65 -description: >- - Description of the oasisctl get metrics token command -archetype: default +weight: 70 --- -Get a metrics token - ## Synopsis - Get a metrics token ``` @@ -17,7 +13,6 @@ oasisctl get metrics token [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for token @@ -26,8 +21,7 @@ oasisctl get metrics token [flags] -t, --token-id string Identifier of the metrics token ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl get metrics token [flags] ``` ## See also - * [oasisctl get metrics](get-metrics.md) - Get metrics information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-metrics.md b/site/content/3.10/arangograph/oasisctl/get/get-metrics.md index 12a199e6a7..af5a07b074 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-metrics.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-metrics.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get metrics command title: Oasisctl Get Metrics menuTitle: Get Metrics -weight: 60 -description: >- - Description of the oasisctl get metrics command -archetype: default +weight: 65 --- -Get metrics information - ## Synopsis - Get metrics information ``` @@ -17,13 +13,11 @@ oasisctl get metrics [flags] ``` ## Options - ``` -h, --help help for metrics ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl get metrics [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information * [oasisctl get metrics token](get-metrics-token.md) - Get a metrics token diff --git a/site/content/3.10/arangograph/oasisctl/get/get-notebook.md b/site/content/3.10/arangograph/oasisctl/get/get-notebook.md index b82575d70f..355c9940c1 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-notebook.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-notebook.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get notebook command title: Oasisctl Get Notebook menuTitle: Get Notebook -weight: 70 -description: >- - Description of the oasisctl get notebook command -archetype: default +weight: 75 --- -Get a notebook - ## Synopsis - Get a notebook ``` @@ -17,14 +13,12 @@ oasisctl get notebook [flags] ``` ## Options - ``` -h, --help help for notebook -n, --notebook-id string Identifier of the notebook ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl get notebook [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication-providers.md b/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication-providers.md index f5220c1792..78d8bd24c1 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication-providers.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication-providers.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get organization authentication providers command title: Oasisctl Get Organization Authentication Providers menuTitle: Get Organization Authentication Providers -weight: 85 -description: >- - Description of the oasisctl get organization authentication providers command -archetype: default +weight: 90 --- -Get which authentication providers are allowed for accessing a specific organization - ## Synopsis - Get which authentication providers are allowed for accessing a specific organization ``` @@ -17,14 +13,12 @@ oasisctl get organization authentication providers [flags] ``` ## Options - ``` -h, --help help for providers -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl get organization authentication providers [flags] ``` ## See also - * [oasisctl get organization authentication](get-organization-authentication.md) - Get authentication specific information for an organization diff --git a/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication.md b/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication.md index b094001d02..3900057cd3 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-organization-authentication.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get organization authentication command title: Oasisctl Get Organization Authentication menuTitle: Get Organization Authentication -weight: 80 -description: >- - Description of the oasisctl get organization authentication command -archetype: default +weight: 85 --- -Get authentication specific information for an organization - ## Synopsis - Get authentication specific information for an organization ``` @@ -17,13 +13,11 @@ oasisctl get organization authentication [flags] ``` ## Options - ``` -h, --help help for authentication ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl get organization authentication [flags] ``` ## See also - * [oasisctl get organization](get-organization.md) - Get an organization the authenticated user is a member of * [oasisctl get organization authentication providers](get-organization-authentication-providers.md) - Get which authentication providers are allowed for accessing a specific organization diff --git a/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain-restrictions.md b/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain-restrictions.md index 23617c9a2d..3f65109d77 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain-restrictions.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain-restrictions.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get organization email domain restrictions command title: Oasisctl Get Organization Email Domain Restrictions menuTitle: Get Organization Email Domain Restrictions -weight: 100 -description: >- - Description of the oasisctl get organization email domain restrictions command -archetype: default +weight: 105 --- -Get which email domain restrictions are placed on accessing a specific organization - ## Synopsis - Get which email domain restrictions are placed on accessing a specific organization ``` @@ -17,14 +13,12 @@ oasisctl get organization email domain restrictions [flags] ``` ## Options - ``` -h, --help help for restrictions -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl get organization email domain restrictions [flags] ``` ## See also - * [oasisctl get organization email domain](get-organization-email-domain.md) - Get email domain specific information for an organization diff --git a/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain.md b/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain.md index c6ec077903..2ec594880e 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-organization-email-domain.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get organization email domain command title: Oasisctl Get Organization Email Domain menuTitle: Get Organization Email Domain -weight: 95 -description: >- - Description of the oasisctl get organization email domain command -archetype: default +weight: 100 --- -Get email domain specific information for an organization - ## Synopsis - Get email domain specific information for an organization ``` @@ -17,13 +13,11 @@ oasisctl get organization email domain [flags] ``` ## Options - ``` -h, --help help for domain ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl get organization email domain [flags] ``` ## See also - * [oasisctl get organization email](get-organization-email.md) - Get email specific information for an organization * [oasisctl get organization email domain restrictions](get-organization-email-domain-restrictions.md) - Get which email domain restrictions are placed on accessing a specific organization diff --git a/site/content/3.10/arangograph/oasisctl/get/get-organization-email.md b/site/content/3.10/arangograph/oasisctl/get/get-organization-email.md index 34ea97b3f8..81fb85db69 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-organization-email.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-organization-email.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get organization email command title: Oasisctl Get Organization Email menuTitle: Get Organization Email -weight: 90 -description: >- - Description of the oasisctl get organization email command -archetype: default +weight: 95 --- -Get email specific information for an organization - ## Synopsis - Get email specific information for an organization ``` @@ -17,13 +13,11 @@ oasisctl get organization email [flags] ``` ## Options - ``` -h, --help help for email ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl get organization email [flags] ``` ## See also - * [oasisctl get organization](get-organization.md) - Get an organization the authenticated user is a member of * [oasisctl get organization email domain](get-organization-email-domain.md) - Get email domain specific information for an organization diff --git a/site/content/3.10/arangograph/oasisctl/get/get-organization-invite.md b/site/content/3.10/arangograph/oasisctl/get/get-organization-invite.md index 79ec5a356b..c3a7c9e723 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-organization-invite.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-organization-invite.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get organization invite command title: Oasisctl Get Organization Invite menuTitle: Get Organization Invite -weight: 105 -description: >- - Description of the oasisctl get organization invite command -archetype: default +weight: 110 --- -Get an organization invite the authenticated user has access to - ## Synopsis - Get an organization invite the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl get organization invite [flags] ``` ## Options - ``` -h, --help help for invite -i, --invite-id string Identifier of the organization invite -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl get organization invite [flags] ``` ## See also - * [oasisctl get organization](get-organization.md) - Get an organization the authenticated user is a member of diff --git a/site/content/3.10/arangograph/oasisctl/get/get-organization.md b/site/content/3.10/arangograph/oasisctl/get/get-organization.md index fe282fea35..f1b4c24f61 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-organization.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get organization command title: Oasisctl Get Organization menuTitle: Get Organization -weight: 75 -description: >- - Description of the oasisctl get organization command -archetype: default +weight: 80 --- -Get an organization the authenticated user is a member of - ## Synopsis - Get an organization the authenticated user is a member of ``` @@ -17,14 +13,12 @@ oasisctl get organization [flags] ``` ## Options - ``` -h, --help help for organization -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,7 +26,6 @@ oasisctl get organization [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information * [oasisctl get organization authentication](get-organization-authentication.md) - Get authentication specific information for an organization * [oasisctl get organization email](get-organization-email.md) - Get email specific information for an organization diff --git a/site/content/3.10/arangograph/oasisctl/get/get-policy.md b/site/content/3.10/arangograph/oasisctl/get/get-policy.md index 8757b4911c..97e7c1b90b 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-policy.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get policy command title: Oasisctl Get Policy menuTitle: Get Policy -weight: 110 -description: >- - Description of the oasisctl get policy command -archetype: default +weight: 115 --- -Get a policy the authenticated user has access to - ## Synopsis - Get a policy the authenticated user has access to ``` @@ -17,14 +13,12 @@ oasisctl get policy [flags] ``` ## Options - ``` -h, --help help for policy -u, --url string URL of the resource to inspect the policy for ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl get policy [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint-service.md b/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint-service.md index f7c3172d83..8f362fcc62 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint-service.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint-service.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get private endpoint service command title: Oasisctl Get Private Endpoint Service menuTitle: Get Private Endpoint Service -weight: 125 -description: >- - Description of the oasisctl get private endpoint service command -archetype: default +weight: 130 --- -Get a Private Endpoint Service the authenticated user has access to - ## Synopsis - Get a Private Endpoint Service the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl get private endpoint service [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment that the private endpoint service is connected to -h, --help help for service @@ -25,8 +20,7 @@ oasisctl get private endpoint service [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl get private endpoint service [flags] ``` ## See also - * [oasisctl get private endpoint](get-private-endpoint.md) - diff --git a/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint.md b/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint.md index 0febf9484f..50970c78e7 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-private-endpoint.md @@ -1,27 +1,23 @@ --- +layout: default +description: Description of the oasisctl get private endpoint command title: Oasisctl Get Private Endpoint menuTitle: Get Private Endpoint -weight: 120 -description: >- - Description of the oasisctl get private endpoint command -archetype: default +weight: 125 --- ## Synopsis - ``` oasisctl get private endpoint [flags] ``` ## Options - ``` -h, --help help for endpoint ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -29,7 +25,6 @@ oasisctl get private endpoint [flags] ``` ## See also - * [oasisctl get private](get-private.md) - Get private information * [oasisctl get private endpoint service](get-private-endpoint-service.md) - Get a Private Endpoint Service the authenticated user has access to diff --git a/site/content/3.10/arangograph/oasisctl/get/get-private.md b/site/content/3.10/arangograph/oasisctl/get/get-private.md index ee285434dd..ac3bbf48ca 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-private.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-private.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get private command title: Oasisctl Get Private menuTitle: Get Private -weight: 115 -description: >- - Description of the oasisctl get private command -archetype: default +weight: 120 --- -Get private information - ## Synopsis - Get private information ``` @@ -17,13 +13,11 @@ oasisctl get private [flags] ``` ## Options - ``` -h, --help help for private ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl get private [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information * [oasisctl get private endpoint](get-private-endpoint.md) - diff --git a/site/content/3.10/arangograph/oasisctl/get/get-project.md b/site/content/3.10/arangograph/oasisctl/get/get-project.md index 6eae0c4a57..b056dea82c 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-project.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-project.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get project command title: Oasisctl Get Project menuTitle: Get Project -weight: 130 -description: >- - Description of the oasisctl get project command -archetype: default +weight: 135 --- -Get a project the authenticated user has access to - ## Synopsis - Get a project the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl get project [flags] ``` ## Options - ``` -h, --help help for project -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl get project [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-provider.md b/site/content/3.10/arangograph/oasisctl/get/get-provider.md index dd61f85175..2c98ed0d81 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-provider.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-provider.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get provider command title: Oasisctl Get Provider menuTitle: Get Provider -weight: 135 -description: >- - Description of the oasisctl get provider command -archetype: default +weight: 140 --- -Get a provider the authenticated user has access to - ## Synopsis - Get a provider the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl get provider [flags] ``` ## Options - ``` -h, --help help for provider -o, --organization-id string Optional Identifier of the organization -p, --provider-id string Identifier of the provider ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl get provider [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-region.md b/site/content/3.10/arangograph/oasisctl/get/get-region.md index 3cbe94467f..4cabe7437c 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-region.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-region.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get region command title: Oasisctl Get Region menuTitle: Get Region -weight: 140 -description: >- - Description of the oasisctl get region command -archetype: default +weight: 145 --- -Get a region the authenticated user has access to - ## Synopsis - Get a region the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl get region [flags] ``` ## Options - ``` -h, --help help for region -o, --organization-id string Optional Identifier of the organization @@ -25,8 +20,7 @@ oasisctl get region [flags] -r, --region-id string Identifier of the region ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl get region [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-role.md b/site/content/3.10/arangograph/oasisctl/get/get-role.md index 8efed3cac6..0d334a8134 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-role.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-role.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get role command title: Oasisctl Get Role menuTitle: Get Role -weight: 145 -description: >- - Description of the oasisctl get role command -archetype: default +weight: 150 --- -Get a role the authenticated user has access to - ## Synopsis - Get a role the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl get role [flags] ``` ## Options - ``` -h, --help help for role -o, --organization-id string Identifier of the organization -r, --role-id string Identifier of the role ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl get role [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-self.md b/site/content/3.10/arangograph/oasisctl/get/get-self.md index 1e4a87b30a..13e0e5234b 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-self.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-self.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get self command title: Oasisctl Get Self menuTitle: Get Self -weight: 150 -description: >- - Description of the oasisctl get self command -archetype: default +weight: 155 --- -Get information about the authenticated user - ## Synopsis - Get information about the authenticated user ``` @@ -17,13 +13,11 @@ oasisctl get self [flags] ``` ## Options - ``` -h, --help help for self ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl get self [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-server-status.md b/site/content/3.10/arangograph/oasisctl/get/get-server-status.md index 97c84c1658..157d69ca5a 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-server-status.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-server-status.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get server status command title: Oasisctl Get Server Status menuTitle: Get Server Status -weight: 160 -description: >- - Description of the oasisctl get server status command -archetype: default +weight: 165 --- -Get the status of servers for a deployment - ## Synopsis - Get the status of servers for a deployment ``` @@ -17,7 +13,6 @@ oasisctl get server status [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for status @@ -25,8 +20,7 @@ oasisctl get server status [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl get server status [flags] ``` ## See also - * [oasisctl get server](get-server.md) - Get server information diff --git a/site/content/3.10/arangograph/oasisctl/get/get-server.md b/site/content/3.10/arangograph/oasisctl/get/get-server.md index 83dc56ea7a..0367a82626 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-server.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-server.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get server command title: Oasisctl Get Server menuTitle: Get Server -weight: 155 -description: >- - Description of the oasisctl get server command -archetype: default +weight: 160 --- -Get server information - ## Synopsis - Get server information ``` @@ -17,13 +13,11 @@ oasisctl get server [flags] ``` ## Options - ``` -h, --help help for server ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl get server [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information * [oasisctl get server status](get-server-status.md) - Get the status of servers for a deployment diff --git a/site/content/3.10/arangograph/oasisctl/get/get-tandc.md b/site/content/3.10/arangograph/oasisctl/get/get-tandc.md index 60bf05f07a..402946190c 100644 --- a/site/content/3.10/arangograph/oasisctl/get/get-tandc.md +++ b/site/content/3.10/arangograph/oasisctl/get/get-tandc.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl get tandc command title: Oasisctl Get Tandc -menuTitle: Get Terms & Conditions -weight: 165 -description: >- - Description of the oasisctl get tandc command -archetype: default +menuTitle: Get Tandc +weight: 170 --- -Get current terms and conditions or get one by ID - ## Synopsis - Get current terms and conditions or get one by ID ``` @@ -17,15 +13,13 @@ oasisctl get tandc [flags] ``` ## Options - ``` -h, --help help for tandc -o, --organization-id string Identifier of the organization -t, --terms-and-conditions-id string Identifier of the terms and conditions to accept. ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl get tandc [flags] ``` ## See also - * [oasisctl get](_index.md) - Get information diff --git a/site/content/3.10/arangograph/oasisctl/import.md b/site/content/3.10/arangograph/oasisctl/import.md index f2d1b63c4f..69ffc2d694 100644 --- a/site/content/3.10/arangograph/oasisctl/import.md +++ b/site/content/3.10/arangograph/oasisctl/import.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl import command title: Oasisctl Import menuTitle: Import -weight: 70 -description: >- - Description of the oasisctl import command -archetype: default +weight: 20 --- -Import data from a local database or from another remote database into an Oasis deployment. - ## Synopsis - Import data from a local database or from another remote database into an Oasis deployment. ``` @@ -17,7 +13,6 @@ oasisctl import [flags] ``` ## Options - ``` -b, --batch-size int The number of documents to write at once. (default 4096) -d, --destination-deployment-id string Destination deployment id to import data into. It can be provided instead of address, username and password. @@ -40,8 +35,7 @@ oasisctl import [flags] --source-username string Source database username if required. ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -49,6 +43,5 @@ oasisctl import [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/list/_index.md b/site/content/3.10/arangograph/oasisctl/list/_index.md index 762a998247..543cf03cab 100644 --- a/site/content/3.10/arangograph/oasisctl/list/_index.md +++ b/site/content/3.10/arangograph/oasisctl/list/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list command title: Oasisctl List menuTitle: List -weight: 75 -description: >- - Description of the oasisctl list command -archetype: chapter +weight: 5 --- -List resources - ## Synopsis - List resources ``` @@ -17,13 +13,11 @@ oasisctl list [flags] ``` ## Options - ``` -h, --help help for list ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl list apikeys](list-apikeys.md) - List all API keys created for the current user * [oasisctl list arangodb](list-arangodb.md) - List ArangoDB information diff --git a/site/content/3.10/arangograph/oasisctl/list/list-apikeys.md b/site/content/3.10/arangograph/oasisctl/list/list-apikeys.md index 06b61042b0..abbb8d95ae 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-apikeys.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-apikeys.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list apikeys command title: Oasisctl List Apikeys -menuTitle: List API Keys -weight: 5 -description: >- - Description of the oasisctl list apikeys command -archetype: default +menuTitle: List Apikeys +weight: 10 --- -List all API keys created for the current user - ## Synopsis - List all API keys created for the current user ``` @@ -17,13 +13,11 @@ oasisctl list apikeys [flags] ``` ## Options - ``` -h, --help help for apikeys ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl list apikeys [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-arangodb-versions.md b/site/content/3.10/arangograph/oasisctl/list/list-arangodb-versions.md index 7b2cfdb91f..67d52ec63f 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-arangodb-versions.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-arangodb-versions.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list arangodb versions command title: Oasisctl List Arangodb Versions menuTitle: List ArangoDB Versions -weight: 15 -description: >- - Description of the oasisctl list arangodb versions command -archetype: default +weight: 20 --- -List all supported ArangoDB versions - ## Synopsis - List all supported ArangoDB versions ``` @@ -17,14 +13,12 @@ oasisctl list arangodb versions [flags] ``` ## Options - ``` -h, --help help for versions -o, --organization-id string Optional Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list arangodb versions [flags] ``` ## See also - * [oasisctl list arangodb](list-arangodb.md) - List ArangoDB information diff --git a/site/content/3.10/arangograph/oasisctl/list/list-arangodb.md b/site/content/3.10/arangograph/oasisctl/list/list-arangodb.md index fdc715e767..a403c7f5e7 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-arangodb.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-arangodb.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list arangodb command title: Oasisctl List Arangodb -menuTitle: List ArangoDB -weight: 10 -description: >- - Description of the oasisctl list arangodb command -archetype: default +menuTitle: List Arangodb +weight: 15 --- -List ArangoDB information - ## Synopsis - List ArangoDB information ``` @@ -17,13 +13,11 @@ oasisctl list arangodb [flags] ``` ## Options - ``` -h, --help help for arangodb ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list arangodb [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list arangodb versions](list-arangodb-versions.md) - List all supported ArangoDB versions diff --git a/site/content/3.10/arangograph/oasisctl/list/list-auditlog-archives.md b/site/content/3.10/arangograph/oasisctl/list/list-auditlog-archives.md index 6170d154b4..421a42ff0c 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-auditlog-archives.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-auditlog-archives.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list auditlog archives command title: Oasisctl List Auditlog Archives menuTitle: List Audit Log Archives -weight: 25 -description: >- - Description of the oasisctl list auditlog archives command -archetype: default +weight: 30 --- -List auditlog archives - ## Synopsis - List auditlog archives ``` @@ -17,15 +13,13 @@ oasisctl list auditlog archives [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog -h, --help help for archives -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list auditlog archives [flags] ``` ## See also - * [oasisctl list auditlog](list-auditlog.md) - List resources for auditlogs diff --git a/site/content/3.10/arangograph/oasisctl/list/list-auditlog-destinations.md b/site/content/3.10/arangograph/oasisctl/list/list-auditlog-destinations.md index 80fe672b41..6a60ecb117 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-auditlog-destinations.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-auditlog-destinations.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list auditlog destinations command title: Oasisctl List Auditlog Destinations menuTitle: List Audit Log Destinations -weight: 30 -description: >- - Description of the oasisctl list auditlog destinations command -archetype: default +weight: 35 --- -List auditlog destinations - ## Synopsis - List auditlog destinations ``` @@ -17,15 +13,13 @@ oasisctl list auditlog destinations [flags] ``` ## Options - ``` --auditlog-id string Identifier of the auditlog to list the destinations for -h, --help help for destinations -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list auditlog destinations [flags] ``` ## See also - * [oasisctl list auditlog](list-auditlog.md) - List resources for auditlogs diff --git a/site/content/3.10/arangograph/oasisctl/list/list-auditlog.md b/site/content/3.10/arangograph/oasisctl/list/list-auditlog.md index c037a45b51..d1832bd287 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-auditlog.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-auditlog.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list auditlog command title: Oasisctl List Auditlog -menuTitle: List Audit Log -weight: 20 -description: >- - Description of the oasisctl list auditlog command -archetype: default +menuTitle: List Auditlog +weight: 25 --- -List resources for auditlogs - ## Synopsis - List resources for auditlogs ``` @@ -17,13 +13,11 @@ oasisctl list auditlog [flags] ``` ## Options - ``` -h, --help help for auditlog ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list auditlog [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list auditlog archives](list-auditlog-archives.md) - List auditlog archives * [oasisctl list auditlog destinations](list-auditlog-destinations.md) - List auditlog destinations diff --git a/site/content/3.10/arangograph/oasisctl/list/list-auditlogs.md b/site/content/3.10/arangograph/oasisctl/list/list-auditlogs.md index 909de7cb28..c45fb55409 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-auditlogs.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-auditlogs.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list auditlogs command title: Oasisctl List Auditlogs -menuTitle: List Audit Logs -weight: 35 -description: >- - Description of the oasisctl list auditlogs command -archetype: default +menuTitle: List Auditlogs +weight: 40 --- -List auditlogs - ## Synopsis - List auditlogs ``` @@ -17,14 +13,12 @@ oasisctl list auditlogs [flags] ``` ## Options - ``` -h, --help help for auditlogs -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list auditlogs [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-backup-policies.md b/site/content/3.10/arangograph/oasisctl/list/list-backup-policies.md index 5300c82c74..ea3fb41fb6 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-backup-policies.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-backup-policies.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list backup policies command title: Oasisctl List Backup Policies menuTitle: List Backup Policies -weight: 45 -description: >- - Description of the oasisctl list backup policies command -archetype: default +weight: 50 --- -List backup policies - ## Synopsis - List backup policies ``` @@ -17,15 +13,13 @@ oasisctl list backup policies [flags] ``` ## Options - ``` --deployment-id string The ID of the deployment to list backup policies for -h, --help help for policies --include-deleted If set, the result includes all backup policies, including those who set to deleted, however are not removed from the system currently ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list backup policies [flags] ``` ## See also - * [oasisctl list backup](list-backup.md) - A list command for various backup resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-backup.md b/site/content/3.10/arangograph/oasisctl/list/list-backup.md index 1f917f0150..49cf50f209 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-backup.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-backup.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list backup command title: Oasisctl List Backup menuTitle: List Backup -weight: 40 -description: >- - Description of the oasisctl list backup command -archetype: default +weight: 45 --- -A list command for various backup resources - ## Synopsis - A list command for various backup resources ``` @@ -17,13 +13,11 @@ oasisctl list backup [flags] ``` ## Options - ``` -h, --help help for backup ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list backup [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list backup policies](list-backup-policies.md) - List backup policies diff --git a/site/content/3.10/arangograph/oasisctl/list/list-backups.md b/site/content/3.10/arangograph/oasisctl/list/list-backups.md index abb6c3884a..f040a49246 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-backups.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-backups.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list backups command title: Oasisctl List Backups menuTitle: List Backups -weight: 50 -description: >- - Description of the oasisctl list backups command -archetype: default +weight: 55 --- -List backups - ## Synopsis - List backups ``` @@ -17,7 +13,6 @@ oasisctl list backups [flags] ``` ## Options - ``` --deployment-id string The ID of the deployment to list backups for --from string Request backups that are created at or after this timestamp @@ -25,8 +20,7 @@ oasisctl list backups [flags] --to string Request backups that are created before this timestamp ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl list backups [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-cacertificates.md b/site/content/3.10/arangograph/oasisctl/list/list-cacertificates.md index 6c3b40dd30..66267312b3 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-cacertificates.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-cacertificates.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list cacertificates command title: Oasisctl List Cacertificates -menuTitle: List CA Certificates -weight: 55 -description: >- - Description of the oasisctl list cacertificates command -archetype: default +menuTitle: List Cacertificates +weight: 60 --- -List all CA certificates of the given project - ## Synopsis - List all CA certificates of the given project ``` @@ -17,15 +13,13 @@ oasisctl list cacertificates [flags] ``` ## Options - ``` -h, --help help for cacertificates -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list cacertificates [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-cpusizes.md b/site/content/3.10/arangograph/oasisctl/list/list-cpusizes.md index e181065c08..7f98b2ec0c 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-cpusizes.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-cpusizes.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list cpusizes command title: Oasisctl List Cpusizes -menuTitle: List CPU Sizes -weight: 60 -description: >- - Description of the oasisctl list cpusizes command -archetype: default +menuTitle: List Cpusizes +weight: 65 --- -List CPU sizes - ## Synopsis - List CPU sizes ``` @@ -17,7 +13,6 @@ oasisctl list cpusizes [flags] ``` ## Options - ``` -h, --help help for cpusizes -o, --organization-id string Identifier of the organization @@ -25,8 +20,7 @@ oasisctl list cpusizes [flags] --provider-id string Identifier of the provider ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl list cpusizes [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-deployments.md b/site/content/3.10/arangograph/oasisctl/list/list-deployments.md index d7728b224a..51c83bb82e 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-deployments.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-deployments.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list deployments command title: Oasisctl List Deployments menuTitle: List Deployments -weight: 65 -description: >- - Description of the oasisctl list deployments command -archetype: default +weight: 70 --- -List all deployments of the given project - ## Synopsis - List all deployments of the given project ``` @@ -17,15 +13,13 @@ oasisctl list deployments [flags] ``` ## Options - ``` -h, --help help for deployments -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list deployments [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-diskperformances.md b/site/content/3.10/arangograph/oasisctl/list/list-diskperformances.md index 95ffe8a48b..7f6fda06c1 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-diskperformances.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-diskperformances.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list diskperformances command title: Oasisctl List Diskperformances -menuTitle: List Disk Performances -weight: 70 -description: >- - Description of the oasisctl list diskperformances command -archetype: default +menuTitle: List Diskperformances +weight: 75 --- -List disk performances - ## Synopsis - List disk performances ``` @@ -17,7 +13,6 @@ oasisctl list diskperformances [flags] ``` ## Options - ``` --dbserver-disk-size int32 The disk size of DB-Servers (GB) (default 32) -h, --help help for diskperformances @@ -27,8 +22,7 @@ oasisctl list diskperformances [flags] -r, --region-id string Identifier of the region ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl list diskperformances [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-effective-permissions.md b/site/content/3.10/arangograph/oasisctl/list/list-effective-permissions.md index d42facbffc..ef72765bb1 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-effective-permissions.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-effective-permissions.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list effective permissions command title: Oasisctl List Effective Permissions menuTitle: List Effective Permissions -weight: 80 -description: >- - Description of the oasisctl list effective permissions command -archetype: default +weight: 85 --- -List the effective permissions, the authenticated user has for a given URL - ## Synopsis - List the effective permissions, the authenticated user has for a given URL ``` @@ -17,14 +13,12 @@ oasisctl list effective permissions [flags] ``` ## Options - ``` -h, --help help for permissions -u, --url string URL of resource to get effective permissions for ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list effective permissions [flags] ``` ## See also - * [oasisctl list effective](list-effective.md) - List effective information diff --git a/site/content/3.10/arangograph/oasisctl/list/list-effective.md b/site/content/3.10/arangograph/oasisctl/list/list-effective.md index 93841d62f4..ffc9f69794 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-effective.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-effective.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list effective command title: Oasisctl List Effective menuTitle: List Effective -weight: 75 -description: >- - Description of the oasisctl list effective command -archetype: default +weight: 80 --- -List effective information - ## Synopsis - List effective information ``` @@ -17,13 +13,11 @@ oasisctl list effective [flags] ``` ## Options - ``` -h, --help help for effective ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list effective [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list effective permissions](list-effective-permissions.md) - List the effective permissions, the authenticated user has for a given URL diff --git a/site/content/3.10/arangograph/oasisctl/list/list-example-installations.md b/site/content/3.10/arangograph/oasisctl/list/list-example-installations.md index 3c62245348..19e3aad924 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-example-installations.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-example-installations.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list example installations command title: Oasisctl List Example Installations menuTitle: List Example Installations -weight: 90 -description: >- - Description of the oasisctl list example installations command -archetype: default +weight: 95 --- -List all example dataset installations for a deployment - ## Synopsis - List all example dataset installations for a deployment ``` @@ -17,7 +13,6 @@ oasisctl list example installations [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment to list installations for -h, --help help for installations @@ -25,8 +20,7 @@ oasisctl list example installations [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl list example installations [flags] ``` ## See also - * [oasisctl list example](list-example.md) - List example ... diff --git a/site/content/3.10/arangograph/oasisctl/list/list-example.md b/site/content/3.10/arangograph/oasisctl/list/list-example.md index 63ce47c51e..59d7d717c0 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-example.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-example.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list example command title: Oasisctl List Example menuTitle: List Example -weight: 85 -description: >- - Description of the oasisctl list example command -archetype: default +weight: 90 --- -List example ... - ## Synopsis - List example ... ``` @@ -17,13 +13,11 @@ oasisctl list example [flags] ``` ## Options - ``` -h, --help help for example ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list example [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list example installations](list-example-installations.md) - List all example dataset installations for a deployment diff --git a/site/content/3.10/arangograph/oasisctl/list/list-examples.md b/site/content/3.10/arangograph/oasisctl/list/list-examples.md index ba0d34fdb6..1d316af23b 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-examples.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-examples.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list examples command title: Oasisctl List Examples menuTitle: List Examples -weight: 95 -description: >- - Description of the oasisctl list examples command -archetype: default +weight: 100 --- -List all example datasets - ## Synopsis - List all example datasets ``` @@ -17,14 +13,12 @@ oasisctl list examples [flags] ``` ## Options - ``` -h, --help help for examples -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list examples [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-group-members.md b/site/content/3.10/arangograph/oasisctl/list/list-group-members.md index 807708bd72..5d399765b1 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-group-members.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-group-members.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list group members command title: Oasisctl List Group Members menuTitle: List Group Members -weight: 105 -description: >- - Description of the oasisctl list group members command -archetype: default +weight: 110 --- -List members of a group the authenticated user is a member of - ## Synopsis - List members of a group the authenticated user is a member of ``` @@ -17,15 +13,13 @@ oasisctl list group members [flags] ``` ## Options - ``` -g, --group-id string Identifier of the group -h, --help help for members -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list group members [flags] ``` ## See also - * [oasisctl list group](list-group.md) - List group resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-group.md b/site/content/3.10/arangograph/oasisctl/list/list-group.md index 4d2bc1066e..abce821e7b 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-group.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-group.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list group command title: Oasisctl List Group menuTitle: List Group -weight: 100 -description: >- - Description of the oasisctl list group command -archetype: default +weight: 105 --- -List group resources - ## Synopsis - List group resources ``` @@ -17,13 +13,11 @@ oasisctl list group [flags] ``` ## Options - ``` -h, --help help for group ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list group [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list group members](list-group-members.md) - List members of a group the authenticated user is a member of diff --git a/site/content/3.10/arangograph/oasisctl/list/list-groups.md b/site/content/3.10/arangograph/oasisctl/list/list-groups.md index a884a79a0c..a754a448ff 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-groups.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-groups.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list groups command title: Oasisctl List Groups menuTitle: List Groups -weight: 110 -description: >- - Description of the oasisctl list groups command -archetype: default +weight: 115 --- -List all groups of the given organization - ## Synopsis - List all groups of the given organization ``` @@ -17,14 +13,12 @@ oasisctl list groups [flags] ``` ## Options - ``` -h, --help help for groups -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list groups [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-ipallowlists.md b/site/content/3.10/arangograph/oasisctl/list/list-ipallowlists.md index 54ecf7e52a..4c1176160b 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-ipallowlists.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-ipallowlists.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list ipallowlists command title: Oasisctl List Ipallowlists -menuTitle: List IP Allowlists -weight: 115 -description: >- - Description of the oasisctl list ipallowlists command -archetype: default +menuTitle: List Ipallowlists +weight: 120 --- -List all IP allowlists of the given project - ## Synopsis - List all IP allowlists of the given project ``` @@ -17,15 +13,13 @@ oasisctl list ipallowlists [flags] ``` ## Options - ``` -h, --help help for ipallowlists -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list ipallowlists [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-metrics-tokens.md b/site/content/3.10/arangograph/oasisctl/list/list-metrics-tokens.md index 3fb65928c8..6fdb7276cf 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-metrics-tokens.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-metrics-tokens.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list metrics tokens command title: Oasisctl List Metrics Tokens menuTitle: List Metrics Tokens -weight: 125 -description: >- - Description of the oasisctl list metrics tokens command -archetype: default +weight: 130 --- -List all metrics tokens of the given deployment - ## Synopsis - List all metrics tokens of the given deployment ``` @@ -17,7 +13,6 @@ oasisctl list metrics tokens [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for tokens @@ -25,8 +20,7 @@ oasisctl list metrics tokens [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl list metrics tokens [flags] ``` ## See also - * [oasisctl list metrics](list-metrics.md) - List metrics resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-metrics.md b/site/content/3.10/arangograph/oasisctl/list/list-metrics.md index 4a192690e0..3e9ec3cb46 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-metrics.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-metrics.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list metrics command title: Oasisctl List Metrics menuTitle: List Metrics -weight: 120 -description: >- - Description of the oasisctl list metrics command -archetype: default +weight: 125 --- -List metrics resources - ## Synopsis - List metrics resources ``` @@ -17,13 +13,11 @@ oasisctl list metrics [flags] ``` ## Options - ``` -h, --help help for metrics ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list metrics [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list metrics tokens](list-metrics-tokens.md) - List all metrics tokens of the given deployment diff --git a/site/content/3.10/arangograph/oasisctl/list/list-nodesizes.md b/site/content/3.10/arangograph/oasisctl/list/list-nodesizes.md index 0726762e76..6ffaca1422 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-nodesizes.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-nodesizes.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list nodesizes command title: Oasisctl List Nodesizes -menuTitle: List Node Sizes -weight: 130 -description: >- - Description of the oasisctl list nodesizes command -archetype: default +menuTitle: List Nodesizes +weight: 135 --- -List node sizes - ## Synopsis - List node sizes ``` @@ -17,7 +13,6 @@ oasisctl list nodesizes [flags] ``` ## Options - ``` -h, --help help for nodesizes --model string Identifier of the model (default "oneshard") @@ -27,8 +22,7 @@ oasisctl list nodesizes [flags] -r, --region-id string Identifier of the region ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl list nodesizes [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-notebookmodels.md b/site/content/3.10/arangograph/oasisctl/list/list-notebookmodels.md index a4814a214b..d6fd1f9a09 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-notebookmodels.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-notebookmodels.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list notebookmodels command title: Oasisctl List Notebookmodels -menuTitle: List Notebook Models -weight: 135 -description: >- - Description of the oasisctl list notebookmodels command -archetype: default +menuTitle: List Notebookmodels +weight: 140 --- -List notebook models - ## Synopsis - List notebook models ``` @@ -17,7 +13,6 @@ oasisctl list notebookmodels [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment that the notebook has to run next to -h, --help help for notebookmodels @@ -25,8 +20,7 @@ oasisctl list notebookmodels [flags] -p, --project-id string Identifier of the project that deployment is in ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl list notebookmodels [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-notebooks.md b/site/content/3.10/arangograph/oasisctl/list/list-notebooks.md index b5e68856ae..a1df88faaa 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-notebooks.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-notebooks.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list notebooks command title: Oasisctl List Notebooks menuTitle: List Notebooks -weight: 140 -description: >- - Description of the oasisctl list notebooks command -archetype: default +weight: 145 --- -List notebooks - ## Synopsis - List notebooks ``` @@ -17,7 +13,6 @@ oasisctl list notebooks [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment that the notebooks run next to -h, --help help for notebooks @@ -25,8 +20,7 @@ oasisctl list notebooks [flags] -p, --project-id string Identifier of the project that has notebooks ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl list notebooks [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-organization-invites.md b/site/content/3.10/arangograph/oasisctl/list/list-organization-invites.md index ea63b5e190..1cf99351a5 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-organization-invites.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-organization-invites.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list organization invites command title: Oasisctl List Organization Invites menuTitle: List Organization Invites -weight: 150 -description: >- - Description of the oasisctl list organization invites command -archetype: default +weight: 155 --- -List invites of an organization the authenticated user is a member of - ## Synopsis - List invites of an organization the authenticated user is a member of ``` @@ -17,14 +13,12 @@ oasisctl list organization invites [flags] ``` ## Options - ``` -h, --help help for invites -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list organization invites [flags] ``` ## See also - * [oasisctl list organization](list-organization.md) - List organization resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-organization-members.md b/site/content/3.10/arangograph/oasisctl/list/list-organization-members.md index b9515f5032..085717acf3 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-organization-members.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-organization-members.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list organization members command title: Oasisctl List Organization Members menuTitle: List Organization Members -weight: 155 -description: >- - Description of the oasisctl list organization members command -archetype: default +weight: 160 --- -List members of an organization the authenticated user is a member of - ## Synopsis - List members of an organization the authenticated user is a member of ``` @@ -17,14 +13,12 @@ oasisctl list organization members [flags] ``` ## Options - ``` -h, --help help for members -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list organization members [flags] ``` ## See also - * [oasisctl list organization](list-organization.md) - List organization resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-organization.md b/site/content/3.10/arangograph/oasisctl/list/list-organization.md index f71c1f4870..9c15d2bacc 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-organization.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list organization command title: Oasisctl List Organization menuTitle: List Organization -weight: 145 -description: >- - Description of the oasisctl list organization command -archetype: default +weight: 150 --- -List organization resources - ## Synopsis - List organization resources ``` @@ -17,13 +13,11 @@ oasisctl list organization [flags] ``` ## Options - ``` -h, --help help for organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl list organization [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources * [oasisctl list organization invites](list-organization-invites.md) - List invites of an organization the authenticated user is a member of * [oasisctl list organization members](list-organization-members.md) - List members of an organization the authenticated user is a member of diff --git a/site/content/3.10/arangograph/oasisctl/list/list-organizations.md b/site/content/3.10/arangograph/oasisctl/list/list-organizations.md index 39f08ec6b3..48075d3af1 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-organizations.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-organizations.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list organizations command title: Oasisctl List Organizations menuTitle: List Organizations -weight: 160 -description: >- - Description of the oasisctl list organizations command -archetype: default +weight: 165 --- -List all organizations the authenticated user is a member of - ## Synopsis - List all organizations the authenticated user is a member of ``` @@ -17,13 +13,11 @@ oasisctl list organizations [flags] ``` ## Options - ``` -h, --help help for organizations ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl list organizations [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-permissions.md b/site/content/3.10/arangograph/oasisctl/list/list-permissions.md index 75808e6579..6436c02bd7 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-permissions.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-permissions.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list permissions command title: Oasisctl List Permissions menuTitle: List Permissions -weight: 165 -description: >- - Description of the oasisctl list permissions command -archetype: default +weight: 170 --- -List the known permissions - ## Synopsis - List the known permissions ``` @@ -17,13 +13,11 @@ oasisctl list permissions [flags] ``` ## Options - ``` -h, --help help for permissions ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl list permissions [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-projects.md b/site/content/3.10/arangograph/oasisctl/list/list-projects.md index d1bfb5510b..4747d77884 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-projects.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-projects.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list projects command title: Oasisctl List Projects menuTitle: List Projects -weight: 170 -description: >- - Description of the oasisctl list projects command -archetype: default +weight: 175 --- -List all projects of the given organization - ## Synopsis - List all projects of the given organization ``` @@ -17,14 +13,12 @@ oasisctl list projects [flags] ``` ## Options - ``` -h, --help help for projects -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list projects [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-providers.md b/site/content/3.10/arangograph/oasisctl/list/list-providers.md index 2642f9a8f7..037a0824ab 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-providers.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-providers.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list providers command title: Oasisctl List Providers menuTitle: List Providers -weight: 175 -description: >- - Description of the oasisctl list providers command -archetype: default +weight: 180 --- -List all providers the authenticated user has access to - ## Synopsis - List all providers the authenticated user has access to ``` @@ -17,14 +13,12 @@ oasisctl list providers [flags] ``` ## Options - ``` -h, --help help for providers -o, --organization-id string Optional Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list providers [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-regions.md b/site/content/3.10/arangograph/oasisctl/list/list-regions.md index 645a645d33..37992ed23d 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-regions.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-regions.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list regions command title: Oasisctl List Regions menuTitle: List Regions -weight: 180 -description: >- - Description of the oasisctl list regions command -archetype: default +weight: 185 --- -List all regions of the given provider - ## Synopsis - List all regions of the given provider ``` @@ -17,15 +13,13 @@ oasisctl list regions [flags] ``` ## Options - ``` -h, --help help for regions -o, --organization-id string Optional Identifier of the organization -p, --provider-id string Identifier of the provider ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl list regions [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-roles.md b/site/content/3.10/arangograph/oasisctl/list/list-roles.md index 1f342d63ae..87bc7915eb 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-roles.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-roles.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list roles command title: Oasisctl List Roles menuTitle: List Roles -weight: 185 -description: >- - Description of the oasisctl list roles command -archetype: default +weight: 190 --- -List all roles of the given organization - ## Synopsis - List all roles of the given organization ``` @@ -17,14 +13,12 @@ oasisctl list roles [flags] ``` ## Options - ``` -h, --help help for roles -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl list roles [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/list/list-servers.md b/site/content/3.10/arangograph/oasisctl/list/list-servers.md index 144589ae92..f2515949e8 100644 --- a/site/content/3.10/arangograph/oasisctl/list/list-servers.md +++ b/site/content/3.10/arangograph/oasisctl/list/list-servers.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl list servers command title: Oasisctl List Servers menuTitle: List Servers -weight: 190 -description: >- - Description of the oasisctl list servers command -archetype: default +weight: 195 --- -List servers information - ## Synopsis - List servers information ``` @@ -17,13 +13,11 @@ oasisctl list servers [flags] ``` ## Options - ``` -h, --help help for servers ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl list servers [flags] ``` ## See also - * [oasisctl list](_index.md) - List resources diff --git a/site/content/3.10/arangograph/oasisctl/lock/_index.md b/site/content/3.10/arangograph/oasisctl/lock/_index.md index 6e54eef707..4b48ea782c 100644 --- a/site/content/3.10/arangograph/oasisctl/lock/_index.md +++ b/site/content/3.10/arangograph/oasisctl/lock/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl lock command title: Oasisctl Lock menuTitle: Lock -weight: 80 -description: >- - Description of the oasisctl lock command -archetype: chapter +weight: 5 --- -Lock resources - ## Synopsis - Lock resources ``` @@ -17,13 +13,11 @@ oasisctl lock [flags] ``` ## Options - ``` -h, --help help for lock ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl lock [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl lock cacertificate](lock-cacertificate.md) - Lock a CA certificate, so it cannot be deleted * [oasisctl lock deployment](lock-deployment.md) - Lock a deployment, so it cannot be deleted diff --git a/site/content/3.10/arangograph/oasisctl/lock/lock-cacertificate.md b/site/content/3.10/arangograph/oasisctl/lock/lock-cacertificate.md index 56c53c85c9..d56f8d37e5 100644 --- a/site/content/3.10/arangograph/oasisctl/lock/lock-cacertificate.md +++ b/site/content/3.10/arangograph/oasisctl/lock/lock-cacertificate.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl lock cacertificate command title: Oasisctl Lock Cacertificate -menuTitle: Lock CA Certificate -weight: 5 -description: >- - Description of the oasisctl lock cacertificate command -archetype: default +menuTitle: Lock Cacertificate +weight: 10 --- -Lock a CA certificate, so it cannot be deleted - ## Synopsis - Lock a CA certificate, so it cannot be deleted ``` @@ -17,7 +13,6 @@ oasisctl lock cacertificate [flags] ``` ## Options - ``` -c, --cacertificate-id string Identifier of the CA certificate -h, --help help for cacertificate @@ -25,8 +20,7 @@ oasisctl lock cacertificate [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl lock cacertificate [flags] ``` ## See also - * [oasisctl lock](_index.md) - Lock resources diff --git a/site/content/3.10/arangograph/oasisctl/lock/lock-deployment.md b/site/content/3.10/arangograph/oasisctl/lock/lock-deployment.md index 429c952a23..808862f277 100644 --- a/site/content/3.10/arangograph/oasisctl/lock/lock-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/lock/lock-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl lock deployment command title: Oasisctl Lock Deployment menuTitle: Lock Deployment -weight: 10 -description: >- - Description of the oasisctl lock deployment command -archetype: default +weight: 15 --- -Lock a deployment, so it cannot be deleted - ## Synopsis - Lock a deployment, so it cannot be deleted ``` @@ -17,7 +13,6 @@ oasisctl lock deployment [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for deployment @@ -25,8 +20,7 @@ oasisctl lock deployment [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl lock deployment [flags] ``` ## See also - * [oasisctl lock](_index.md) - Lock resources diff --git a/site/content/3.10/arangograph/oasisctl/lock/lock-ipallowlist.md b/site/content/3.10/arangograph/oasisctl/lock/lock-ipallowlist.md index 0c7b495e5f..a2a4c3da35 100644 --- a/site/content/3.10/arangograph/oasisctl/lock/lock-ipallowlist.md +++ b/site/content/3.10/arangograph/oasisctl/lock/lock-ipallowlist.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl lock ipallowlist command title: Oasisctl Lock Ipallowlist -menuTitle: Lock IP Allowlist -weight: 15 -description: >- - Description of the oasisctl lock ipallowlist command -archetype: default +menuTitle: Lock Ipallowlist +weight: 20 --- -Lock an IP allowlist, so it cannot be deleted - ## Synopsis - Lock an IP allowlist, so it cannot be deleted ``` @@ -17,7 +13,6 @@ oasisctl lock ipallowlist [flags] ``` ## Options - ``` -h, --help help for ipallowlist -i, --ipallowlist-id string Identifier of the IP allowlist @@ -25,8 +20,7 @@ oasisctl lock ipallowlist [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl lock ipallowlist [flags] ``` ## See also - * [oasisctl lock](_index.md) - Lock resources diff --git a/site/content/3.10/arangograph/oasisctl/lock/lock-organization.md b/site/content/3.10/arangograph/oasisctl/lock/lock-organization.md index 53d04eb469..a7a4362a13 100644 --- a/site/content/3.10/arangograph/oasisctl/lock/lock-organization.md +++ b/site/content/3.10/arangograph/oasisctl/lock/lock-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl lock organization command title: Oasisctl Lock Organization menuTitle: Lock Organization -weight: 20 -description: >- - Description of the oasisctl lock organization command -archetype: default +weight: 25 --- -Lock an organization, so it cannot be deleted - ## Synopsis - Lock an organization, so it cannot be deleted ``` @@ -17,14 +13,12 @@ oasisctl lock organization [flags] ``` ## Options - ``` -h, --help help for organization -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl lock organization [flags] ``` ## See also - * [oasisctl lock](_index.md) - Lock resources diff --git a/site/content/3.10/arangograph/oasisctl/lock/lock-policy.md b/site/content/3.10/arangograph/oasisctl/lock/lock-policy.md index 2a515b1564..012f882a75 100644 --- a/site/content/3.10/arangograph/oasisctl/lock/lock-policy.md +++ b/site/content/3.10/arangograph/oasisctl/lock/lock-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl lock policy command title: Oasisctl Lock Policy menuTitle: Lock Policy -weight: 25 -description: >- - Description of the oasisctl lock policy command -archetype: default +weight: 30 --- -Lock a backup policy - ## Synopsis - Lock a backup policy ``` @@ -17,14 +13,12 @@ oasisctl lock policy [flags] ``` ## Options - ``` -d, --backup-policy-id string Identifier of the backup policy -h, --help help for policy ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl lock policy [flags] ``` ## See also - * [oasisctl lock](_index.md) - Lock resources diff --git a/site/content/3.10/arangograph/oasisctl/lock/lock-project.md b/site/content/3.10/arangograph/oasisctl/lock/lock-project.md index 3bb58e61a4..804b0f4362 100644 --- a/site/content/3.10/arangograph/oasisctl/lock/lock-project.md +++ b/site/content/3.10/arangograph/oasisctl/lock/lock-project.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl lock project command title: Oasisctl Lock Project menuTitle: Lock Project -weight: 30 -description: >- - Description of the oasisctl lock project command -archetype: default +weight: 35 --- -Lock a project, so it cannot be deleted - ## Synopsis - Lock a project, so it cannot be deleted ``` @@ -17,15 +13,13 @@ oasisctl lock project [flags] ``` ## Options - ``` -h, --help help for project -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl lock project [flags] ``` ## See also - * [oasisctl lock](_index.md) - Lock resources diff --git a/site/content/3.10/arangograph/oasisctl/login.md b/site/content/3.10/arangograph/oasisctl/login.md index 1b5804d4cd..47456d4751 100644 --- a/site/content/3.10/arangograph/oasisctl/login.md +++ b/site/content/3.10/arangograph/oasisctl/login.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl login command title: Oasisctl Login menuTitle: Login -weight: 85 -description: >- - Description of the oasisctl login command -archetype: default +weight: 25 --- -Login to ArangoDB Oasis using an API key - ## Synopsis - To authenticate in a script environment, run: export OASIS_TOKEN=$(oasisctl login --key-id= --key-secret=) @@ -20,15 +16,13 @@ oasisctl login [flags] ``` ## Options - ``` -h, --help help for login -i, --key-id string API key identifier -s, --key-secret string API key secret ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl login [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/logs.md b/site/content/3.10/arangograph/oasisctl/logs.md index 1b9eaefacf..a72a8be1c2 100644 --- a/site/content/3.10/arangograph/oasisctl/logs.md +++ b/site/content/3.10/arangograph/oasisctl/logs.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl logs command title: Oasisctl Logs menuTitle: Logs -weight: 90 -description: >- - Description of the oasisctl logs command -archetype: default +weight: 30 --- -Get logs of the servers of a deployment the authenticated user has access to - ## Synopsis - Get logs of the servers of a deployment the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl logs [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment --end string End fetching logs at this timestamp (pass timestamp or duration before now) @@ -29,8 +24,7 @@ oasisctl logs [flags] --start string Start fetching logs from this timestamp (pass timestamp or duration before now) ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -38,6 +32,5 @@ oasisctl logs [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/options.md b/site/content/3.10/arangograph/oasisctl/options.md index 06da17bef8..e389267f47 100644 --- a/site/content/3.10/arangograph/oasisctl/options.md +++ b/site/content/3.10/arangograph/oasisctl/options.md @@ -1,15 +1,14 @@ --- -title: Oasisctl +layout: default +description: Command-line client tool for managing ArangoGraph +title: ArangoGraph Shell oasisctl menuTitle: Options weight: 5 -description: >- - Command-line client tool for managing ArangoGraph -archetype: default --- +## Oasisctl ArangoGraph Insights Platform ## Synopsis - ArangoGraph Insights Platform (formerly called Oasis): The Managed Cloud for ArangoDB ``` @@ -17,7 +16,6 @@ oasisctl [flags] ``` ## Options - ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -26,7 +24,6 @@ oasisctl [flags] ``` ## See also - * [oasisctl accept](accept/_index.md) - Accept invites * [oasisctl add](add/_index.md) - Add resources * [oasisctl auditlog](auditlog/_index.md) - AuditLog resources diff --git a/site/content/3.10/arangograph/oasisctl/pause/_index.md b/site/content/3.10/arangograph/oasisctl/pause/_index.md index 0b94f49978..a0bce65563 100644 --- a/site/content/3.10/arangograph/oasisctl/pause/_index.md +++ b/site/content/3.10/arangograph/oasisctl/pause/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl pause command title: Oasisctl Pause menuTitle: Pause -weight: 95 -description: >- - Description of the oasisctl pause command -archetype: chapter +weight: 5 --- -Pause resources - ## Synopsis - Pause resources ``` @@ -17,13 +13,11 @@ oasisctl pause [flags] ``` ## Options - ``` -h, --help help for pause ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl pause [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl pause notebook](pause-notebook.md) - Pause a notebook diff --git a/site/content/3.10/arangograph/oasisctl/pause/pause-notebook.md b/site/content/3.10/arangograph/oasisctl/pause/pause-notebook.md index 11d3c33d9e..88aeb6ffbc 100644 --- a/site/content/3.10/arangograph/oasisctl/pause/pause-notebook.md +++ b/site/content/3.10/arangograph/oasisctl/pause/pause-notebook.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl pause notebook command title: Oasisctl Pause Notebook menuTitle: Pause Notebook -weight: 5 -description: >- - Description of the oasisctl pause notebook command -archetype: default +weight: 10 --- -Pause a notebook - ## Synopsis - Pause a notebook ``` @@ -17,14 +13,12 @@ oasisctl pause notebook [flags] ``` ## Options - ``` -h, --help help for notebook -n, --notebook-id string Identifier of the notebook ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl pause notebook [flags] ``` ## See also - * [oasisctl pause](_index.md) - Pause resources diff --git a/site/content/3.10/arangograph/oasisctl/rebalance/_index.md b/site/content/3.10/arangograph/oasisctl/rebalance/_index.md index 2810d949ed..e1f5395cad 100644 --- a/site/content/3.10/arangograph/oasisctl/rebalance/_index.md +++ b/site/content/3.10/arangograph/oasisctl/rebalance/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl rebalance command title: Oasisctl Rebalance menuTitle: Rebalance -weight: 100 -description: >- - Description of the oasisctl rebalance command -archetype: chapter +weight: 5 --- -Rebalance resources - ## Synopsis - Rebalance resources ``` @@ -17,13 +13,11 @@ oasisctl rebalance [flags] ``` ## Options - ``` -h, --help help for rebalance ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl rebalance [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl rebalance deployment](rebalance-deployment.md) - Rebalance deployment resources diff --git a/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment-shards.md b/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment-shards.md index 281eb398a1..66858e437a 100644 --- a/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment-shards.md +++ b/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment-shards.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl rebalance deployment shards command title: Oasisctl Rebalance Deployment Shards menuTitle: Rebalance Deployment Shards -weight: 10 -description: >- - Description of the oasisctl rebalance deployment shards command -archetype: default +weight: 15 --- -Rebalance shards of a deployment - ## Synopsis - Rebalance shards of a deployment ``` @@ -17,14 +13,12 @@ oasisctl rebalance deployment shards [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for shards ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl rebalance deployment shards [flags] ``` ## See also - * [oasisctl rebalance deployment](rebalance-deployment.md) - Rebalance deployment resources diff --git a/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment.md b/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment.md index 631d3277fe..c309d9b30a 100644 --- a/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/rebalance/rebalance-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl rebalance deployment command title: Oasisctl Rebalance Deployment menuTitle: Rebalance Deployment -weight: 5 -description: >- - Description of the oasisctl rebalance deployment command -archetype: default +weight: 10 --- -Rebalance deployment resources - ## Synopsis - Rebalance deployment resources ``` @@ -17,13 +13,11 @@ oasisctl rebalance deployment [flags] ``` ## Options - ``` -h, --help help for deployment ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl rebalance deployment [flags] ``` ## See also - * [oasisctl rebalance](_index.md) - Rebalance resources * [oasisctl rebalance deployment shards](rebalance-deployment-shards.md) - Rebalance shards of a deployment diff --git a/site/content/3.10/arangograph/oasisctl/reject/_index.md b/site/content/3.10/arangograph/oasisctl/reject/_index.md index 9eabde0bef..3698b97059 100644 --- a/site/content/3.10/arangograph/oasisctl/reject/_index.md +++ b/site/content/3.10/arangograph/oasisctl/reject/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl reject command title: Oasisctl Reject menuTitle: Reject -weight: 105 -description: >- - Description of the oasisctl reject command -archetype: chapter +weight: 5 --- -Reject invites - ## Synopsis - Reject invites ``` @@ -17,13 +13,11 @@ oasisctl reject [flags] ``` ## Options - ``` -h, --help help for reject ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl reject [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl reject organization](reject-organization.md) - Reject organization related invites diff --git a/site/content/3.10/arangograph/oasisctl/reject/reject-organization-invite.md b/site/content/3.10/arangograph/oasisctl/reject/reject-organization-invite.md index 8a11ca9fda..d45852e85b 100644 --- a/site/content/3.10/arangograph/oasisctl/reject/reject-organization-invite.md +++ b/site/content/3.10/arangograph/oasisctl/reject/reject-organization-invite.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl reject organization invite command title: Oasisctl Reject Organization Invite menuTitle: Reject Organization Invite -weight: 10 -description: >- - Description of the oasisctl reject organization invite command -archetype: default +weight: 15 --- -Reject an organization invite the authenticated user has access to - ## Synopsis - Reject an organization invite the authenticated user has access to ``` @@ -17,15 +13,13 @@ oasisctl reject organization invite [flags] ``` ## Options - ``` -h, --help help for invite -i, --invite-id string Identifier of the organization invite -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl reject organization invite [flags] ``` ## See also - * [oasisctl reject organization](reject-organization.md) - Reject organization related invites diff --git a/site/content/3.10/arangograph/oasisctl/reject/reject-organization.md b/site/content/3.10/arangograph/oasisctl/reject/reject-organization.md index 54a5b7d017..635dfc540e 100644 --- a/site/content/3.10/arangograph/oasisctl/reject/reject-organization.md +++ b/site/content/3.10/arangograph/oasisctl/reject/reject-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl reject organization command title: Oasisctl Reject Organization menuTitle: Reject Organization -weight: 5 -description: >- - Description of the oasisctl reject organization command -archetype: default +weight: 10 --- -Reject organization related invites - ## Synopsis - Reject organization related invites ``` @@ -17,13 +13,11 @@ oasisctl reject organization [flags] ``` ## Options - ``` -h, --help help for organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl reject organization [flags] ``` ## See also - * [oasisctl reject](_index.md) - Reject invites * [oasisctl reject organization invite](reject-organization-invite.md) - Reject an organization invite the authenticated user has access to diff --git a/site/content/3.10/arangograph/oasisctl/renew/_index.md b/site/content/3.10/arangograph/oasisctl/renew/_index.md index 0a5c8d68e6..173533a1f8 100644 --- a/site/content/3.10/arangograph/oasisctl/renew/_index.md +++ b/site/content/3.10/arangograph/oasisctl/renew/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl renew command title: Oasisctl Renew menuTitle: Renew -weight: 110 -description: >- - Description of the oasisctl renew command -archetype: chapter +weight: 5 --- -Renew keys & tokens - ## Synopsis - Renew keys & tokens ``` @@ -17,13 +13,11 @@ oasisctl renew [flags] ``` ## Options - ``` -h, --help help for renew ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl renew [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl renew apikey](renew-apikey.md) - Renew API keys & tokens diff --git a/site/content/3.10/arangograph/oasisctl/renew/renew-apikey-token.md b/site/content/3.10/arangograph/oasisctl/renew/renew-apikey-token.md index 1ffe0394f7..167b7c05aa 100644 --- a/site/content/3.10/arangograph/oasisctl/renew/renew-apikey-token.md +++ b/site/content/3.10/arangograph/oasisctl/renew/renew-apikey-token.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl renew apikey token command title: Oasisctl Renew Apikey Token menuTitle: Renew API Key Token -weight: 10 -description: >- - Description of the oasisctl renew apikey token command -archetype: default +weight: 15 --- -Renew an API key token - ## Synopsis - Renew the token (resulting from API key authentication) ``` @@ -17,13 +13,11 @@ oasisctl renew apikey token [flags] ``` ## Options - ``` -h, --help help for token ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl renew apikey token [flags] ``` ## See also - * [oasisctl renew apikey](renew-apikey.md) - Renew API keys & tokens diff --git a/site/content/3.10/arangograph/oasisctl/renew/renew-apikey.md b/site/content/3.10/arangograph/oasisctl/renew/renew-apikey.md index 635c9f88a5..114ac2190b 100644 --- a/site/content/3.10/arangograph/oasisctl/renew/renew-apikey.md +++ b/site/content/3.10/arangograph/oasisctl/renew/renew-apikey.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl renew apikey command title: Oasisctl Renew Apikey -menuTitle: Renew API Key -weight: 5 -description: >- - Description of the oasisctl renew apikey command -archetype: default +menuTitle: Renew Apikey +weight: 10 --- -Renew API keys & tokens - ## Synopsis - Renew API keys & tokens ``` @@ -17,13 +13,11 @@ oasisctl renew apikey [flags] ``` ## Options - ``` -h, --help help for apikey ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl renew apikey [flags] ``` ## See also - * [oasisctl renew](_index.md) - Renew keys & tokens * [oasisctl renew apikey token](renew-apikey-token.md) - Renew an API key token diff --git a/site/content/3.10/arangograph/oasisctl/resume/_index.md b/site/content/3.10/arangograph/oasisctl/resume/_index.md index 691dc4b826..7ac7cfa7d9 100644 --- a/site/content/3.10/arangograph/oasisctl/resume/_index.md +++ b/site/content/3.10/arangograph/oasisctl/resume/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl resume command title: Oasisctl Resume menuTitle: Resume -weight: 115 -description: >- - Description of the oasisctl resume command -archetype: chapter +weight: 5 --- -Resume resources - ## Synopsis - Resume resources ``` @@ -17,13 +13,11 @@ oasisctl resume [flags] ``` ## Options - ``` -h, --help help for resume ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl resume [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl resume deployment](resume-deployment.md) - Resume a paused deployment the authenticated user has access to * [oasisctl resume notebook](resume-notebook.md) - Resume a notebook diff --git a/site/content/3.10/arangograph/oasisctl/resume/resume-deployment.md b/site/content/3.10/arangograph/oasisctl/resume/resume-deployment.md index 2ff87646be..3240d91400 100644 --- a/site/content/3.10/arangograph/oasisctl/resume/resume-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/resume/resume-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl resume deployment command title: Oasisctl Resume Deployment menuTitle: Resume Deployment -weight: 5 -description: >- - Description of the oasisctl resume deployment command -archetype: default +weight: 10 --- -Resume a paused deployment the authenticated user has access to - ## Synopsis - Resume a paused deployment the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl resume deployment [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for deployment @@ -25,8 +20,7 @@ oasisctl resume deployment [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl resume deployment [flags] ``` ## See also - * [oasisctl resume](_index.md) - Resume resources diff --git a/site/content/3.10/arangograph/oasisctl/resume/resume-notebook.md b/site/content/3.10/arangograph/oasisctl/resume/resume-notebook.md index 8e97ad6679..a10b0e1eba 100644 --- a/site/content/3.10/arangograph/oasisctl/resume/resume-notebook.md +++ b/site/content/3.10/arangograph/oasisctl/resume/resume-notebook.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl resume notebook command title: Oasisctl Resume Notebook menuTitle: Resume Notebook -weight: 10 -description: >- - Description of the oasisctl resume notebook command -archetype: default +weight: 15 --- -Resume a notebook - ## Synopsis - Resume a notebook ``` @@ -17,14 +13,12 @@ oasisctl resume notebook [flags] ``` ## Options - ``` -h, --help help for notebook -n, --notebook-id string Identifier of the notebook ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl resume notebook [flags] ``` ## See also - * [oasisctl resume](_index.md) - Resume resources diff --git a/site/content/3.10/arangograph/oasisctl/revoke/_index.md b/site/content/3.10/arangograph/oasisctl/revoke/_index.md index 1f423f74ea..1b40d63235 100644 --- a/site/content/3.10/arangograph/oasisctl/revoke/_index.md +++ b/site/content/3.10/arangograph/oasisctl/revoke/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl revoke command title: Oasisctl Revoke menuTitle: Revoke -weight: 120 -description: >- - Description of the oasisctl revoke command -archetype: chapter +weight: 5 --- -Revoke keys & tokens - ## Synopsis - Revoke keys & tokens ``` @@ -17,13 +13,11 @@ oasisctl revoke [flags] ``` ## Options - ``` -h, --help help for revoke ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl revoke [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl revoke apikey](revoke-apikey.md) - Revoke an API key with given identifier * [oasisctl revoke metrics](revoke-metrics.md) - Revoke keys & tokens diff --git a/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey-token.md b/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey-token.md index db5bc41039..aa54057d30 100644 --- a/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey-token.md +++ b/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey-token.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl revoke apikey token command title: Oasisctl Revoke Apikey Token menuTitle: Revoke API Key Token -weight: 10 -description: >- - Description of the oasisctl revoke apikey token command -archetype: default +weight: 15 --- -Revoke an API key token - ## Synopsis - Revoke the token (resulting from API key authentication) ``` @@ -17,13 +13,11 @@ oasisctl revoke apikey token [flags] ``` ## Options - ``` -h, --help help for token ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl revoke apikey token [flags] ``` ## See also - * [oasisctl revoke apikey](revoke-apikey.md) - Revoke an API key with given identifier diff --git a/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey.md b/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey.md index e83dc111f8..276a7e5ce4 100644 --- a/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey.md +++ b/site/content/3.10/arangograph/oasisctl/revoke/revoke-apikey.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl revoke apikey command title: Oasisctl Revoke Apikey -menuTitle: Revoke API Key -weight: 5 -description: >- - Description of the oasisctl revoke apikey command -archetype: default +menuTitle: Revoke Apikey +weight: 10 --- -Revoke an API key with given identifier - ## Synopsis - Revoke an API key with given identifier ``` @@ -17,14 +13,12 @@ oasisctl revoke apikey [flags] ``` ## Options - ``` -i, --apikey-id string Identifier of the API key to revoke -h, --help help for apikey ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,7 +26,6 @@ oasisctl revoke apikey [flags] ``` ## See also - * [oasisctl revoke](_index.md) - Revoke keys & tokens * [oasisctl revoke apikey token](revoke-apikey-token.md) - Revoke an API key token diff --git a/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics-token.md b/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics-token.md index 5aa40a104d..8f150fd778 100644 --- a/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics-token.md +++ b/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics-token.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl revoke metrics token command title: Oasisctl Revoke Metrics Token menuTitle: Revoke Metrics Token -weight: 20 -description: >- - Description of the oasisctl revoke metrics token command -archetype: default +weight: 25 --- -Revoke a metrics token for a deployment - ## Synopsis - Revoke a metrics token for a deployment ``` @@ -17,7 +13,6 @@ oasisctl revoke metrics token [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for token @@ -26,8 +21,7 @@ oasisctl revoke metrics token [flags] -t, --token-id string Identifier of the metrics token ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl revoke metrics token [flags] ``` ## See also - * [oasisctl revoke metrics](revoke-metrics.md) - Revoke keys & tokens diff --git a/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics.md b/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics.md index eecafa1442..2eee168f67 100644 --- a/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics.md +++ b/site/content/3.10/arangograph/oasisctl/revoke/revoke-metrics.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl revoke metrics command title: Oasisctl Revoke Metrics menuTitle: Revoke Metrics -weight: 15 -description: >- - Description of the oasisctl revoke metrics command -archetype: default +weight: 20 --- -Revoke keys & tokens - ## Synopsis - Revoke keys & tokens ``` @@ -17,13 +13,11 @@ oasisctl revoke metrics [flags] ``` ## Options - ``` -h, --help help for metrics ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl revoke metrics [flags] ``` ## See also - * [oasisctl revoke](_index.md) - Revoke keys & tokens * [oasisctl revoke metrics token](revoke-metrics-token.md) - Revoke a metrics token for a deployment diff --git a/site/content/3.10/arangograph/oasisctl/rotate/_index.md b/site/content/3.10/arangograph/oasisctl/rotate/_index.md index 452d2baf2e..b67c3e2e96 100644 --- a/site/content/3.10/arangograph/oasisctl/rotate/_index.md +++ b/site/content/3.10/arangograph/oasisctl/rotate/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl rotate command title: Oasisctl Rotate menuTitle: Rotate -weight: 125 -description: >- - Description of the oasisctl rotate command -archetype: chapter +weight: 5 --- -Rotate resources - ## Synopsis - Rotate resources ``` @@ -17,13 +13,11 @@ oasisctl rotate [flags] ``` ## Options - ``` -h, --help help for rotate ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl rotate [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl rotate deployment](rotate-deployment.md) - Rotate deployment resources diff --git a/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment-server.md b/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment-server.md index 15e2846467..5b48ce1dc1 100644 --- a/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment-server.md +++ b/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment-server.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl rotate deployment server command title: Oasisctl Rotate Deployment Server menuTitle: Rotate Deployment Server -weight: 10 -description: >- - Description of the oasisctl rotate deployment server command -archetype: default +weight: 15 --- -Rotate a single server of a deployment - ## Synopsis - Rotate a single server of a deployment ``` @@ -17,7 +13,6 @@ oasisctl rotate deployment server [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for server @@ -26,8 +21,7 @@ oasisctl rotate deployment server [flags] -s, --server-id strings Identifier of the deployment server ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl rotate deployment server [flags] ``` ## See also - * [oasisctl rotate deployment](rotate-deployment.md) - Rotate deployment resources diff --git a/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment.md b/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment.md index dff1c7462c..43f411fd1b 100644 --- a/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/rotate/rotate-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl rotate deployment command title: Oasisctl Rotate Deployment menuTitle: Rotate Deployment -weight: 5 -description: >- - Description of the oasisctl rotate deployment command -archetype: default +weight: 10 --- -Rotate deployment resources - ## Synopsis - Rotate deployment resources ``` @@ -17,13 +13,11 @@ oasisctl rotate deployment [flags] ``` ## Options - ``` -h, --help help for deployment ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl rotate deployment [flags] ``` ## See also - * [oasisctl rotate](_index.md) - Rotate resources * [oasisctl rotate deployment server](rotate-deployment-server.md) - Rotate a single server of a deployment diff --git a/site/content/3.10/arangograph/oasisctl/top.md b/site/content/3.10/arangograph/oasisctl/top.md index af2048bbef..d39a5e848a 100644 --- a/site/content/3.10/arangograph/oasisctl/top.md +++ b/site/content/3.10/arangograph/oasisctl/top.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl top command title: Oasisctl Top menuTitle: Top -weight: 130 -description: >- - Description of the oasisctl top command -archetype: default +weight: 35 --- -Show the most important server metrics - ## Synopsis - Show the most important server metrics ``` @@ -17,7 +13,6 @@ oasisctl top [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for top @@ -25,8 +20,7 @@ oasisctl top [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl top [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/unlock/_index.md b/site/content/3.10/arangograph/oasisctl/unlock/_index.md index 89f02b5e48..419fdbf0fb 100644 --- a/site/content/3.10/arangograph/oasisctl/unlock/_index.md +++ b/site/content/3.10/arangograph/oasisctl/unlock/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl unlock command title: Oasisctl Unlock menuTitle: Unlock -weight: 135 -description: >- - Description of the oasisctl unlock command -archetype: chapter +weight: 5 --- -Unlock resources - ## Synopsis - Unlock resources ``` @@ -17,13 +13,11 @@ oasisctl unlock [flags] ``` ## Options - ``` -h, --help help for unlock ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl unlock [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl unlock cacertificate](unlock-cacertificate.md) - Unlock a CA certificate, so it can be deleted * [oasisctl unlock deployment](unlock-deployment.md) - Unlock a deployment, so it can be deleted diff --git a/site/content/3.10/arangograph/oasisctl/unlock/unlock-cacertificate.md b/site/content/3.10/arangograph/oasisctl/unlock/unlock-cacertificate.md index 07b2d5052f..ca4ac55b0c 100644 --- a/site/content/3.10/arangograph/oasisctl/unlock/unlock-cacertificate.md +++ b/site/content/3.10/arangograph/oasisctl/unlock/unlock-cacertificate.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl unlock cacertificate command title: Oasisctl Unlock Cacertificate -menuTitle: Unlock CA Certificate -weight: 5 -description: >- - Description of the oasisctl unlock cacertificate command -archetype: default +menuTitle: Unlock Cacertificate +weight: 10 --- -Unlock a CA certificate, so it can be deleted - ## Synopsis - Unlock a CA certificate, so it can be deleted ``` @@ -17,7 +13,6 @@ oasisctl unlock cacertificate [flags] ``` ## Options - ``` -c, --cacertificate-id string Identifier of the CA certificate -h, --help help for cacertificate @@ -25,8 +20,7 @@ oasisctl unlock cacertificate [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl unlock cacertificate [flags] ``` ## See also - * [oasisctl unlock](_index.md) - Unlock resources diff --git a/site/content/3.10/arangograph/oasisctl/unlock/unlock-deployment.md b/site/content/3.10/arangograph/oasisctl/unlock/unlock-deployment.md index ca69ea2a4e..f6f0557b01 100644 --- a/site/content/3.10/arangograph/oasisctl/unlock/unlock-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/unlock/unlock-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl unlock deployment command title: Oasisctl Unlock Deployment menuTitle: Unlock Deployment -weight: 10 -description: >- - Description of the oasisctl unlock deployment command -archetype: default +weight: 15 --- -Unlock a deployment, so it can be deleted - ## Synopsis - Unlock a deployment, so it can be deleted ``` @@ -17,7 +13,6 @@ oasisctl unlock deployment [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for deployment @@ -25,8 +20,7 @@ oasisctl unlock deployment [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl unlock deployment [flags] ``` ## See also - * [oasisctl unlock](_index.md) - Unlock resources diff --git a/site/content/3.10/arangograph/oasisctl/unlock/unlock-ipallowlist.md b/site/content/3.10/arangograph/oasisctl/unlock/unlock-ipallowlist.md index 5dc9c3bf13..5a5942fb4a 100644 --- a/site/content/3.10/arangograph/oasisctl/unlock/unlock-ipallowlist.md +++ b/site/content/3.10/arangograph/oasisctl/unlock/unlock-ipallowlist.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl unlock ipallowlist command title: Oasisctl Unlock Ipallowlist -menuTitle: Unlock IP Allowlist -weight: 15 -description: >- - Description of the oasisctl unlock ipallowlist command -archetype: default +menuTitle: Unlock Ipallowlist +weight: 20 --- -Unlock an IP allowlist, so it can be deleted - ## Synopsis - Unlock an IP allowlist, so it can be deleted ``` @@ -17,7 +13,6 @@ oasisctl unlock ipallowlist [flags] ``` ## Options - ``` -h, --help help for ipallowlist -i, --ipallowlist-id string Identifier of the IP allowlist @@ -25,8 +20,7 @@ oasisctl unlock ipallowlist [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,6 +28,5 @@ oasisctl unlock ipallowlist [flags] ``` ## See also - * [oasisctl unlock](_index.md) - Unlock resources diff --git a/site/content/3.10/arangograph/oasisctl/unlock/unlock-organization.md b/site/content/3.10/arangograph/oasisctl/unlock/unlock-organization.md index c25f32ff9a..3aa5ef954d 100644 --- a/site/content/3.10/arangograph/oasisctl/unlock/unlock-organization.md +++ b/site/content/3.10/arangograph/oasisctl/unlock/unlock-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl unlock organization command title: Oasisctl Unlock Organization menuTitle: Unlock Organization -weight: 20 -description: >- - Description of the oasisctl unlock organization command -archetype: default +weight: 25 --- -Unlock an organization, so it can be deleted - ## Synopsis - Unlock an organization, so it can be deleted ``` @@ -17,14 +13,12 @@ oasisctl unlock organization [flags] ``` ## Options - ``` -h, --help help for organization -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl unlock organization [flags] ``` ## See also - * [oasisctl unlock](_index.md) - Unlock resources diff --git a/site/content/3.10/arangograph/oasisctl/unlock/unlock-policy.md b/site/content/3.10/arangograph/oasisctl/unlock/unlock-policy.md index 23b444999f..94bb8f957a 100644 --- a/site/content/3.10/arangograph/oasisctl/unlock/unlock-policy.md +++ b/site/content/3.10/arangograph/oasisctl/unlock/unlock-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl unlock policy command title: Oasisctl Unlock Policy menuTitle: Unlock Policy -weight: 25 -description: >- - Description of the oasisctl unlock policy command -archetype: default +weight: 30 --- -Unlock a backup policy - ## Synopsis - Unlock a backup policy ``` @@ -17,14 +13,12 @@ oasisctl unlock policy [flags] ``` ## Options - ``` -d, --backup-policy-id string Identifier of the backup policy -h, --help help for policy ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -32,6 +26,5 @@ oasisctl unlock policy [flags] ``` ## See also - * [oasisctl unlock](_index.md) - Unlock resources diff --git a/site/content/3.10/arangograph/oasisctl/unlock/unlock-project.md b/site/content/3.10/arangograph/oasisctl/unlock/unlock-project.md index 3d3868a15e..4e939de6a4 100644 --- a/site/content/3.10/arangograph/oasisctl/unlock/unlock-project.md +++ b/site/content/3.10/arangograph/oasisctl/unlock/unlock-project.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl unlock project command title: Oasisctl Unlock Project menuTitle: Unlock Project -weight: 30 -description: >- - Description of the oasisctl unlock project command -archetype: default +weight: 35 --- -Unlock a project, so it can be deleted - ## Synopsis - Unlock a project, so it can be deleted ``` @@ -17,15 +13,13 @@ oasisctl unlock project [flags] ``` ## Options - ``` -h, --help help for project -o, --organization-id string Identifier of the organization -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl unlock project [flags] ``` ## See also - * [oasisctl unlock](_index.md) - Unlock resources diff --git a/site/content/3.10/arangograph/oasisctl/update/_index.md b/site/content/3.10/arangograph/oasisctl/update/_index.md index 96f45a523b..3ef2bbfede 100644 --- a/site/content/3.10/arangograph/oasisctl/update/_index.md +++ b/site/content/3.10/arangograph/oasisctl/update/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update command title: Oasisctl Update menuTitle: Update -weight: 140 -description: >- - Description of the oasisctl update command -archetype: chapter +weight: 5 --- -Update resources - ## Synopsis - Update resources ``` @@ -17,13 +13,11 @@ oasisctl update [flags] ``` ## Options - ``` -h, --help help for update ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl update auditlog](update-auditlog.md) - Update an auditlog * [oasisctl update backup](update-backup.md) - Update a backup diff --git a/site/content/3.10/arangograph/oasisctl/update/update-auditlog.md b/site/content/3.10/arangograph/oasisctl/update/update-auditlog.md index e7575cfbe6..e8171ddc29 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-auditlog.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-auditlog.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update auditlog command title: Oasisctl Update Auditlog -menuTitle: Update Audit Log -weight: 5 -description: >- - Description of the oasisctl update auditlog command -archetype: default +menuTitle: Update Auditlog +weight: 10 --- -Update an auditlog - ## Synopsis - Update an auditlog ``` @@ -17,7 +13,6 @@ oasisctl update auditlog [flags] ``` ## Options - ``` -i, --auditlog-id string Identifier of the auditlog to update. --default If set, this AuditLog is the default for the organization. @@ -27,8 +22,7 @@ oasisctl update auditlog [flags] -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl update auditlog [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-backup-policy.md b/site/content/3.10/arangograph/oasisctl/update/update-backup-policy.md index e68727b28b..05dbf208a3 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-backup-policy.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-backup-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update backup policy command title: Oasisctl Update Backup Policy menuTitle: Update Backup Policy -weight: 15 -description: >- - Description of the oasisctl update backup policy command -archetype: default +weight: 20 --- -Update a backup policy - ## Synopsis - Update a backup policy ``` @@ -17,7 +13,6 @@ oasisctl update backup policy [flags] ``` ## Options - ``` --additional-region-ids strings Add backup to the specified addition regions -d, --backup-policy-id string Identifier of the backup policy @@ -44,8 +39,7 @@ oasisctl update backup policy [flags] --wednesday If set, a backup will be created on Wednesdays. Set to false explicitly to clear the flag. ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -53,6 +47,5 @@ oasisctl update backup policy [flags] ``` ## See also - * [oasisctl update backup](update-backup.md) - Update a backup diff --git a/site/content/3.10/arangograph/oasisctl/update/update-backup.md b/site/content/3.10/arangograph/oasisctl/update/update-backup.md index 6eb680288b..345310b3f0 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-backup.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-backup.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update backup command title: Oasisctl Update Backup menuTitle: Update Backup -weight: 10 -description: >- - Description of the oasisctl update backup command -archetype: default +weight: 15 --- -Update a backup - ## Synopsis - Update a backup ``` @@ -17,7 +13,6 @@ oasisctl update backup [flags] ``` ## Options - ``` --auto-deleted-at int Time (h) until auto delete of the backup -d, --backup-id string Identifier of the backup @@ -27,8 +22,7 @@ oasisctl update backup [flags] --upload The backups should be uploaded ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,7 +30,6 @@ oasisctl update backup [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources * [oasisctl update backup policy](update-backup-policy.md) - Update a backup policy diff --git a/site/content/3.10/arangograph/oasisctl/update/update-cacertificate.md b/site/content/3.10/arangograph/oasisctl/update/update-cacertificate.md index ff74c7788f..c77efca9ed 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-cacertificate.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-cacertificate.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update cacertificate command title: Oasisctl Update Cacertificate -menuTitle: Update CA Certificate -weight: 20 -description: >- - Description of the oasisctl update cacertificate command -archetype: default +menuTitle: Update Cacertificate +weight: 25 --- -Update a CA certificate the authenticated user has access to - ## Synopsis - Update a CA certificate the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update cacertificate [flags] ``` ## Options - ``` -c, --cacertificate-id string Identifier of the CA certificate --description string Description of the CA certificate @@ -28,8 +23,7 @@ oasisctl update cacertificate [flags] --use-well-known-certificate Sets the usage of a well known certificate ie. Let's Encrypt ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -37,6 +31,5 @@ oasisctl update cacertificate [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-deployment.md b/site/content/3.10/arangograph/oasisctl/update/update-deployment.md index d5d42b065a..17230b53b0 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update deployment command title: Oasisctl Update Deployment menuTitle: Update Deployment -weight: 25 -description: >- - Description of the oasisctl update deployment command -archetype: default +weight: 30 --- -Update a deployment the authenticated user has access to - ## Synopsis - Update a deployment the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update deployment [flags] ``` ## Options - ``` -c, --cacertificate-id string Identifier of the CA certificate to use for the deployment --coordinator-memory-size int32 Set memory size of Coordinators for flexible deployments (GB) (default 4) @@ -45,8 +40,7 @@ oasisctl update deployment [flags] --version string Version of ArangoDB to use for the deployment ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -54,6 +48,5 @@ oasisctl update deployment [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-group.md b/site/content/3.10/arangograph/oasisctl/update/update-group.md index d27eda8240..58e0017b6d 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-group.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-group.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update group command title: Oasisctl Update Group menuTitle: Update Group -weight: 30 -description: >- - Description of the oasisctl update group command -archetype: default +weight: 35 --- -Update a group the authenticated user has access to - ## Synopsis - Update a group the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update group [flags] ``` ## Options - ``` --description string Description of the group -g, --group-id string Identifier of the group @@ -26,8 +21,7 @@ oasisctl update group [flags] -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl update group [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-ipallowlist.md b/site/content/3.10/arangograph/oasisctl/update/update-ipallowlist.md index d3055e0502..33bc64da49 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-ipallowlist.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-ipallowlist.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update ipallowlist command title: Oasisctl Update Ipallowlist -menuTitle: Update IP Allowlist -weight: 35 -description: >- - Description of the oasisctl update ipallowlist command -archetype: default +menuTitle: Update Ipallowlist +weight: 40 --- -Update an IP allowlist the authenticated user has access to - ## Synopsis - Update an IP allowlist the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update ipallowlist [flags] ``` ## Options - ``` --add-cidr-range strings List of CIDR ranges to add to the IP allowlist --description string Description of the CA certificate @@ -30,8 +25,7 @@ oasisctl update ipallowlist [flags] --remove-cidr-range strings List of CIDR ranges to remove from the IP allowlist ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -39,6 +33,5 @@ oasisctl update ipallowlist [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-metrics-token.md b/site/content/3.10/arangograph/oasisctl/update/update-metrics-token.md index cda81ad5c0..b9184a16ef 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-metrics-token.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-metrics-token.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update metrics token command title: Oasisctl Update Metrics Token menuTitle: Update Metrics Token -weight: 45 -description: >- - Description of the oasisctl update metrics token command -archetype: default +weight: 50 --- -Update a metrics token - ## Synopsis - Update a metrics token ``` @@ -17,7 +13,6 @@ oasisctl update metrics token [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment --description string Description of the CA certificate @@ -28,8 +23,7 @@ oasisctl update metrics token [flags] -t, --token-id string Identifier of the metrics token ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -37,6 +31,5 @@ oasisctl update metrics token [flags] ``` ## See also - * [oasisctl update metrics](update-metrics.md) - Update metrics resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-metrics.md b/site/content/3.10/arangograph/oasisctl/update/update-metrics.md index 0448d6bd16..0eff7c47fd 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-metrics.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-metrics.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update metrics command title: Oasisctl Update Metrics menuTitle: Update Metrics -weight: 40 -description: >- - Description of the oasisctl update metrics command -archetype: default +weight: 45 --- -Update metrics resources - ## Synopsis - Update metrics resources ``` @@ -17,13 +13,11 @@ oasisctl update metrics [flags] ``` ## Options - ``` -h, --help help for metrics ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update metrics [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources * [oasisctl update metrics token](update-metrics-token.md) - Update a metrics token diff --git a/site/content/3.10/arangograph/oasisctl/update/update-notebook.md b/site/content/3.10/arangograph/oasisctl/update/update-notebook.md index 9dc54237fd..6cbe686231 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-notebook.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-notebook.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update notebook command title: Oasisctl Update Notebook menuTitle: Update Notebook -weight: 50 -description: >- - Description of the oasisctl update notebook command -archetype: default +weight: 55 --- -Update notebook - ## Synopsis - Update notebook ``` @@ -17,7 +13,6 @@ oasisctl update notebook [flags] ``` ## Options - ``` -d, --description string Description of the notebook -s, --disk-size int32 Notebook disk size in GiB @@ -27,8 +22,7 @@ oasisctl update notebook [flags] -m, --notebook-model string Identifier of the notebook model ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -36,6 +30,5 @@ oasisctl update notebook [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication-providers.md b/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication-providers.md index 8638062497..ba6be57eb9 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication-providers.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication-providers.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update organization authentication providers command title: Oasisctl Update Organization Authentication Providers menuTitle: Update Organization Authentication Providers -weight: 65 -description: >- - Description of the oasisctl update organization authentication providers command -archetype: default +weight: 70 --- -Update allowed authentication providers for an organization the authenticated user has access to - ## Synopsis - Update allowed authentication providers for an organization the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update organization authentication providers [flags] ``` ## Options - ``` --enable-github If set, allow access from user accounts authentication through Github --enable-google If set, allow access from user accounts authentication through Google @@ -28,8 +23,7 @@ oasisctl update organization authentication providers [flags] -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -37,6 +31,5 @@ oasisctl update organization authentication providers [flags] ``` ## See also - * [oasisctl update organization authentication](update-organization-authentication.md) - Update authentication settings for an organization diff --git a/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication.md b/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication.md index 9557dd9541..330e31bc3b 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-organization-authentication.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update organization authentication command title: Oasisctl Update Organization Authentication menuTitle: Update Organization Authentication -weight: 60 -description: >- - Description of the oasisctl update organization authentication command -archetype: default +weight: 65 --- -Update authentication settings for an organization - ## Synopsis - Update authentication settings for an organization ``` @@ -17,13 +13,11 @@ oasisctl update organization authentication [flags] ``` ## Options - ``` -h, --help help for authentication ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update organization authentication [flags] ``` ## See also - * [oasisctl update organization](update-organization.md) - Update an organization the authenticated user has access to * [oasisctl update organization authentication providers](update-organization-authentication-providers.md) - Update allowed authentication providers for an organization the authenticated user has access to diff --git a/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain-restrictions.md b/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain-restrictions.md index 49d51ef38b..0f3cf861cc 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain-restrictions.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain-restrictions.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update organization email domain restrictions command title: Oasisctl Update Organization Email Domain Restrictions menuTitle: Update Organization Email Domain Restrictions -weight: 80 -description: >- - Description of the oasisctl update organization email domain restrictions command -archetype: default +weight: 85 --- -Update which domain restrictions are placed on accessing a specific organization - ## Synopsis - Update which domain restrictions are placed on accessing a specific organization ``` @@ -17,15 +13,13 @@ oasisctl update organization email domain restrictions [flags] ``` ## Options - ``` -d, --allowed-domain strings Allowed email domains for users of the organization -h, --help help for restrictions -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl update organization email domain restrictions [flags] ``` ## See also - * [oasisctl update organization email domain](update-organization-email-domain.md) - Update email domain specific information for an organization diff --git a/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain.md b/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain.md index 5e959cab89..38e74f182d 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-organization-email-domain.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update organization email domain command title: Oasisctl Update Organization Email Domain menuTitle: Update Organization Email Domain -weight: 75 -description: >- - Description of the oasisctl update organization email domain command -archetype: default +weight: 80 --- -Update email domain specific information for an organization - ## Synopsis - Update email domain specific information for an organization ``` @@ -17,13 +13,11 @@ oasisctl update organization email domain [flags] ``` ## Options - ``` -h, --help help for domain ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update organization email domain [flags] ``` ## See also - * [oasisctl update organization email](update-organization-email.md) - Update email specific information for an organization * [oasisctl update organization email domain restrictions](update-organization-email-domain-restrictions.md) - Update which domain restrictions are placed on accessing a specific organization diff --git a/site/content/3.10/arangograph/oasisctl/update/update-organization-email.md b/site/content/3.10/arangograph/oasisctl/update/update-organization-email.md index 3cdb291479..dc94425a95 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-organization-email.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-organization-email.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update organization email command title: Oasisctl Update Organization Email menuTitle: Update Organization Email -weight: 70 -description: >- - Description of the oasisctl update organization email command -archetype: default +weight: 75 --- -Update email specific information for an organization - ## Synopsis - Update email specific information for an organization ``` @@ -17,13 +13,11 @@ oasisctl update organization email [flags] ``` ## Options - ``` -h, --help help for email ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update organization email [flags] ``` ## See also - * [oasisctl update organization](update-organization.md) - Update an organization the authenticated user has access to * [oasisctl update organization email domain](update-organization-email-domain.md) - Update email domain specific information for an organization diff --git a/site/content/3.10/arangograph/oasisctl/update/update-organization.md b/site/content/3.10/arangograph/oasisctl/update/update-organization.md index 245e1667c5..5d45280172 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-organization.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-organization.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update organization command title: Oasisctl Update Organization menuTitle: Update Organization -weight: 55 -description: >- - Description of the oasisctl update organization command -archetype: default +weight: 60 --- -Update an organization the authenticated user has access to - ## Synopsis - Update an organization the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update organization [flags] ``` ## Options - ``` --description string Description of the organization -h, --help help for organization @@ -25,8 +20,7 @@ oasisctl update organization [flags] -o, --organization-id string Identifier of the organization ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -34,7 +28,6 @@ oasisctl update organization [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources * [oasisctl update organization authentication](update-organization-authentication.md) - Update authentication settings for an organization * [oasisctl update organization email](update-organization-email.md) - Update email specific information for an organization diff --git a/site/content/3.10/arangograph/oasisctl/update/update-policy-add-binding.md b/site/content/3.10/arangograph/oasisctl/update/update-policy-add-binding.md index b8c52b7267..94b84e151b 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-policy-add-binding.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-policy-add-binding.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update policy add binding command title: Oasisctl Update Policy Add Binding menuTitle: Update Policy Add Binding -weight: 95 -description: >- - Description of the oasisctl update policy add binding command -archetype: default +weight: 100 --- -Add a role binding to a policy - ## Synopsis - Add a role binding to a policy ``` @@ -17,7 +13,6 @@ oasisctl update policy add binding [flags] ``` ## Options - ``` --group-id strings Identifiers of the groups to add bindings for -h, --help help for binding @@ -26,8 +21,7 @@ oasisctl update policy add binding [flags] --user-id strings Identifiers of the users to add bindings for ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl update policy add binding [flags] ``` ## See also - * [oasisctl update policy add](update-policy-add.md) - Add to a policy diff --git a/site/content/3.10/arangograph/oasisctl/update/update-policy-add.md b/site/content/3.10/arangograph/oasisctl/update/update-policy-add.md index d62e2a7002..d08ea08a70 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-policy-add.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-policy-add.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update policy add command title: Oasisctl Update Policy Add menuTitle: Update Policy Add -weight: 90 -description: >- - Description of the oasisctl update policy add command -archetype: default +weight: 95 --- -Add to a policy - ## Synopsis - Add to a policy ``` @@ -17,13 +13,11 @@ oasisctl update policy add [flags] ``` ## Options - ``` -h, --help help for add ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update policy add [flags] ``` ## See also - * [oasisctl update policy](update-policy.md) - Update a policy * [oasisctl update policy add binding](update-policy-add-binding.md) - Add a role binding to a policy diff --git a/site/content/3.10/arangograph/oasisctl/update/update-policy-delete-binding.md b/site/content/3.10/arangograph/oasisctl/update/update-policy-delete-binding.md index 8b8e3d4e56..73dd258d0a 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-policy-delete-binding.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-policy-delete-binding.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update policy delete binding command title: Oasisctl Update Policy Delete Binding menuTitle: Update Policy Delete Binding -weight: 105 -description: >- - Description of the oasisctl update policy delete binding command -archetype: default +weight: 110 --- -Delete a role binding from a policy - ## Synopsis - Delete a role binding from a policy ``` @@ -17,7 +13,6 @@ oasisctl update policy delete binding [flags] ``` ## Options - ``` --group-id strings Identifiers of the groups to delete bindings for -h, --help help for binding @@ -26,8 +21,7 @@ oasisctl update policy delete binding [flags] --user-id strings Identifiers of the users to delete bindings for ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl update policy delete binding [flags] ``` ## See also - * [oasisctl update policy delete](update-policy-delete.md) - Delete from a policy diff --git a/site/content/3.10/arangograph/oasisctl/update/update-policy-delete.md b/site/content/3.10/arangograph/oasisctl/update/update-policy-delete.md index b9874ac048..01a1b93837 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-policy-delete.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-policy-delete.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update policy delete command title: Oasisctl Update Policy Delete menuTitle: Update Policy Delete -weight: 100 -description: >- - Description of the oasisctl update policy delete command -archetype: default +weight: 105 --- -Delete from a policy - ## Synopsis - Delete from a policy ``` @@ -17,13 +13,11 @@ oasisctl update policy delete [flags] ``` ## Options - ``` -h, --help help for delete ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update policy delete [flags] ``` ## See also - * [oasisctl update policy](update-policy.md) - Update a policy * [oasisctl update policy delete binding](update-policy-delete-binding.md) - Delete a role binding from a policy diff --git a/site/content/3.10/arangograph/oasisctl/update/update-policy.md b/site/content/3.10/arangograph/oasisctl/update/update-policy.md index c03a2a77ce..d7a08323c0 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-policy.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-policy.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update policy command title: Oasisctl Update Policy menuTitle: Update Policy -weight: 85 -description: >- - Description of the oasisctl update policy command -archetype: default +weight: 90 --- -Update a policy - ## Synopsis - Update a policy ``` @@ -17,13 +13,11 @@ oasisctl update policy [flags] ``` ## Options - ``` -h, --help help for policy ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update policy [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources * [oasisctl update policy add](update-policy-add.md) - Add to a policy * [oasisctl update policy delete](update-policy-delete.md) - Delete from a policy diff --git a/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint-service.md b/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint-service.md index 603f6b6373..4dee376e16 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint-service.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint-service.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update private endpoint service command title: Oasisctl Update Private Endpoint Service menuTitle: Update Private Endpoint Service -weight: 120 -description: >- - Description of the oasisctl update private endpoint service command -archetype: default +weight: 125 --- -Update a Private Endpoint Service attached to an existing deployment - ## Synopsis - Update a Private Endpoint Service attached to an existing deployment ``` @@ -17,7 +13,6 @@ oasisctl update private endpoint service [flags] ``` ## Options - ``` --alternate-dns-name strings DNS names used for the deployment in the private network --aws-principal strings List of AWS Principals from which a Private Endpoint can be created (Format: [/Role/|/User/]) @@ -31,8 +26,7 @@ oasisctl update private endpoint service [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -40,6 +34,5 @@ oasisctl update private endpoint service [flags] ``` ## See also - * [oasisctl update private endpoint](update-private-endpoint.md) - diff --git a/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint.md b/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint.md index c676bd43a3..8c1b331c98 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-private-endpoint.md @@ -1,27 +1,23 @@ --- +layout: default +description: Description of the oasisctl update private endpoint command title: Oasisctl Update Private Endpoint menuTitle: Update Private Endpoint -weight: 115 -description: >- - Description of the oasisctl update private endpoint command -archetype: default +weight: 120 --- ## Synopsis - ``` oasisctl update private endpoint [flags] ``` ## Options - ``` -h, --help help for endpoint ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -29,7 +25,6 @@ oasisctl update private endpoint [flags] ``` ## See also - * [oasisctl update private](update-private.md) - Update private resources * [oasisctl update private endpoint service](update-private-endpoint-service.md) - Update a Private Endpoint Service attached to an existing deployment diff --git a/site/content/3.10/arangograph/oasisctl/update/update-private.md b/site/content/3.10/arangograph/oasisctl/update/update-private.md index e633f4329a..eb8767ad48 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-private.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-private.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update private command title: Oasisctl Update Private menuTitle: Update Private -weight: 110 -description: >- - Description of the oasisctl update private command -archetype: default +weight: 115 --- -Update private resources - ## Synopsis - Update private resources ``` @@ -17,13 +13,11 @@ oasisctl update private [flags] ``` ## Options - ``` -h, --help help for private ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl update private [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources * [oasisctl update private endpoint](update-private-endpoint.md) - diff --git a/site/content/3.10/arangograph/oasisctl/update/update-project.md b/site/content/3.10/arangograph/oasisctl/update/update-project.md index c73ba8a8d4..1af8169f91 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-project.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-project.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update project command title: Oasisctl Update Project menuTitle: Update Project -weight: 125 -description: >- - Description of the oasisctl update project command -archetype: default +weight: 130 --- -Update a project the authenticated user has access to - ## Synopsis - Update a project the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update project [flags] ``` ## Options - ``` --description string Description of the project -h, --help help for project @@ -26,8 +21,7 @@ oasisctl update project [flags] -p, --project-id string Identifier of the project ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl update project [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/update/update-role.md b/site/content/3.10/arangograph/oasisctl/update/update-role.md index 4ca53951a8..31cd8ac323 100644 --- a/site/content/3.10/arangograph/oasisctl/update/update-role.md +++ b/site/content/3.10/arangograph/oasisctl/update/update-role.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl update role command title: Oasisctl Update Role menuTitle: Update Role -weight: 130 -description: >- - Description of the oasisctl update role command -archetype: default +weight: 135 --- -Update a role the authenticated user has access to - ## Synopsis - Update a role the authenticated user has access to ``` @@ -17,7 +13,6 @@ oasisctl update role [flags] ``` ## Options - ``` --add-permission strings Permissions to add to the role --description string Description of the role @@ -28,8 +23,7 @@ oasisctl update role [flags] -r, --role-id string Identifier of the role ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -37,6 +31,5 @@ oasisctl update role [flags] ``` ## See also - * [oasisctl update](_index.md) - Update resources diff --git a/site/content/3.10/arangograph/oasisctl/upgrade.md b/site/content/3.10/arangograph/oasisctl/upgrade.md index 616976e84e..5b9a1d568d 100644 --- a/site/content/3.10/arangograph/oasisctl/upgrade.md +++ b/site/content/3.10/arangograph/oasisctl/upgrade.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl upgrade command title: Oasisctl Upgrade menuTitle: Upgrade -weight: 145 -description: >- - Description of the oasisctl upgrade command -archetype: default +weight: 40 --- -Upgrade Oasisctl tool - ## Synopsis - Check the latest, compatible version and upgrade this tool to that. ``` @@ -17,15 +13,13 @@ oasisctl upgrade [flags] ``` ## Options - ``` -d, --dry-run Do an upgrade without applying the version. -f, --force Force an upgrade even if the versions match. -h, --help help for upgrade ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -33,6 +27,5 @@ oasisctl upgrade [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/version.md b/site/content/3.10/arangograph/oasisctl/version.md index 2d90f57a52..9544db3225 100644 --- a/site/content/3.10/arangograph/oasisctl/version.md +++ b/site/content/3.10/arangograph/oasisctl/version.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl version command title: Oasisctl Version menuTitle: Version -weight: 150 -description: >- - Description of the oasisctl version command -archetype: default +weight: 45 --- -Show the current version of this tool - ## Synopsis - Show the current version of this tool ``` @@ -17,13 +13,11 @@ oasisctl version [flags] ``` ## Options - ``` -h, --help help for version ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,6 +25,5 @@ oasisctl version [flags] ``` ## See also - * [oasisctl](options.md) - ArangoGraph Insights Platform diff --git a/site/content/3.10/arangograph/oasisctl/wait/_index.md b/site/content/3.10/arangograph/oasisctl/wait/_index.md index bb6e12bdf0..1d4b8b27b4 100644 --- a/site/content/3.10/arangograph/oasisctl/wait/_index.md +++ b/site/content/3.10/arangograph/oasisctl/wait/_index.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl wait command title: Oasisctl Wait menuTitle: Wait -weight: 155 -description: >- - Description of the oasisctl wait command -archetype: chapter +weight: 5 --- -Wait for a status change - ## Synopsis - Wait for a status change ``` @@ -17,13 +13,11 @@ oasisctl wait [flags] ``` ## Options - ``` -h, --help help for wait ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -31,7 +25,6 @@ oasisctl wait [flags] ``` ## See also - * [oasisctl](../options.md) - ArangoGraph Insights Platform * [oasisctl wait deployment](wait-deployment.md) - Wait for a deployment to reach the ready status diff --git a/site/content/3.10/arangograph/oasisctl/wait/wait-deployment.md b/site/content/3.10/arangograph/oasisctl/wait/wait-deployment.md index 208b78109e..03cfdeb557 100644 --- a/site/content/3.10/arangograph/oasisctl/wait/wait-deployment.md +++ b/site/content/3.10/arangograph/oasisctl/wait/wait-deployment.md @@ -1,15 +1,11 @@ --- +layout: default +description: Description of the oasisctl wait deployment command title: Oasisctl Wait Deployment menuTitle: Wait Deployment -weight: 5 -description: >- - Description of the oasisctl wait deployment command -archetype: default +weight: 10 --- -Wait for a deployment to reach the ready status - ## Synopsis - Wait for a deployment to reach the ready status ``` @@ -17,7 +13,6 @@ oasisctl wait deployment [flags] ``` ## Options - ``` -d, --deployment-id string Identifier of the deployment -h, --help help for deployment @@ -26,8 +21,7 @@ oasisctl wait deployment [flags] -t, --timeout duration How long to wait for the deployment to reach the ready status (default 20m0s) ``` -## Options inherited from parent commands - +## Options Inherited From Parent Commands ``` --endpoint string API endpoint of the ArangoDB Oasis (default "api.cloud.arangodb.com") --format string Output format (table|json) (default "table") @@ -35,6 +29,5 @@ oasisctl wait deployment [flags] ``` ## See also - * [oasisctl wait](_index.md) - Wait for a status change diff --git a/site/data/3.10/allMetrics.yaml b/site/data/3.10/allMetrics.yaml new file mode 100644 index 0000000000..3dbbae2998 --- /dev/null +++ b/site/data/3.10/allMetrics.yaml @@ -0,0 +1,6104 @@ +- name: arangodb_agency_append_hist + introducedIn: "3.7.1" + help: | + Agency RAFT follower append time histogram. + unit: ms + type: histogram + category: Agency + complexity: medium + exposedBy: + - agent + description: | + This measures the time an Agency follower needs for individual + append operations resulting from `AppendEntriesRPC` requests. + Every event contributes a measurement to the histogram, which + also exposes the number of events and the total sum of all + measurements. + threshold: | + Normally these times should be clearly sub-second. + troubleshoot: | + If you see delays here, the Agents might not have enough IO bandwidth + or might be overloaded. Try to provision more IOPS or more CPU capacity, + potentially moving Agents to separate machines. + +- name: arangodb_agency_cache_callback_number + renamedFrom: arangodb_agency_cache_callback_count + introducedIn: "3.8.0" + help: | + Current number of entries in Agency cache callbacks table. + unit: number + type: gauge + category: Agency + complexity: advanced + exposedBy: + - dbserver + - coordinator + - single + description: | + This reflects the current number of callbacks the local `AgencyCache` + has registered. + This metric was named `arangodb_agency_cache_callback_count` in + previous versions of ArangoDB. + Note that on single servers this metric only has a non-zero value + in the Active Failover deployment mode. + threshold: | + This number is usually very low, something like `2` or `3`. + troubleshoot: | + If this number is considerably higher, this should be investigated. + Please contact support. + +- name: arangodb_agency_callback_number + renamedFrom: arangodb_agency_callback_count + introducedIn: "3.8.0" + help: | + Current number of Agency callbacks registered. + unit: number + type: gauge + category: Agency + complexity: advanced + exposedBy: + - coordinator + - dbserver + - single + description: | + This metric reflects the current number of Agency callbacks being + registered, including Agency cache callbacks. + This metric was named `arangodb_agency_callback_count` in previous versions + of ArangoDB. + Note that on single servers this metric only has a non-zero value + in the Active Failover deployment mode. + threshold: | + This number is usually very low, something like `2` or `3`. + troubleshoot: | + If this number is considerably higher, this should be investigated. + Please contact support. + +- name: arangodb_agency_callback_registered_total + renamedFrom: arangodb_agency_callback_registered + introducedIn: "3.8.0" + help: | + Total number of Agency callbacks ever registered. + unit: number + type: counter + category: Agency + complexity: advanced + exposedBy: + - coordinator + - dbserver + - single + description: | + This metric was named `arangodb_agency_callback_registered` in previous versions + of ArangoDB. + Note that on single servers this metric only has a non-zero value + in the Active Failover deployment mode. + +- name: arangodb_agency_client_lookup_table_size + introducedIn: "3.6.11" + help: | + Current number of entries in Agency client id lookup table. + unit: number + type: gauge + category: Agency + complexity: advanced + exposedBy: + - agent + description: | + Current number of entries in Agency client id lookup table. + The lookup table is used internally for Agency inquire operations + and should be compacted at the same time when the Agency's in-memory + log is compacted. + +- name: arangodb_agency_commit_hist + introducedIn: "3.7.1" + help: | + Agency RAFT commit histogram. + unit: ms + type: histogram + category: Agency + complexity: medium + exposedBy: + - agent + description: | + Agency RAFT commit time histogram. Provides a distribution + of commit times for all Agency write operations. + +- name: arangodb_agency_compaction_hist + introducedIn: "3.7.1" + help: | + Agency compaction time histogram. + unit: ms + type: histogram + category: Agency + complexity: medium + exposedBy: + - agent + description: | + Agency compaction time histogram. Provides a distribution + of Agency compaction run times. Compactions are triggered after + `--agency.compaction-keep-size` entries have accumulated in the + RAFT log. + troubleshoot: | + If compaction takes too long, it may be useful to reduce the number + of log entries to keep in `--agency.compaction-keep-size`. + +- name: arangodb_agency_local_commit_index + introducedIn: "3.7.1" + help: | + This Agent's commit index. + unit: number + type: gauge + category: Agency + complexity: simple + exposedBy: + - agent + description: | + This Agent's commit index (i.e. the index until it has advanced in + the Agency's RAFT protocol). + +- name: arangodb_agency_log_size_bytes + introducedIn: "3.6.9" + help: | + Agency replicated log size. + unit: bytes + type: gauge + category: Agency + complexity: simple + exposedBy: + - agent + description: | + Size of the Agency's in-memory part of replicated log in bytes. + The replicated log grows in memory until a certain number of + log entries have been accumulated. Then the in-memory log is + compacted. The number of in-memory log entries to keep before + log compaction kicks in can be controlled via the startup option + `--agency.compaction-keep-size`. + +- name: arangodb_agency_read_no_leader_total + renamedFrom: arangodb_agency_read_no_leader + introducedIn: "3.8.0" + help: | + Agency read operations with no leader or on followers. + unit: number + type: counter + category: Agency + complexity: simple + exposedBy: + - agent + description: | + Total number of Agency read operations with no leader or on followers. + threshold: | + This should normally not happen. If it happens regularly, the Agency + is reelecting its leader often. + troubleshoot: | + The latency of the network between the Agents might be too high or + the Agents may be overloaded. It might help to move Agent instances + to separate machines. + +- name: arangodb_agency_read_ok_total + renamedFrom: arangodb_agency_read_ok + introducedIn: "3.8.0" + help: | + Number of successful Agency read operations. + unit: number + type: counter + category: Agency + complexity: simple + exposedBy: + - agent + description: | + Number of Agency read operations which were successful (i.e. completed + without any error). Successful reads can only be executed on the leader, so + this metric is supposed to increase only on Agency leaders, but not on + followers. Read requests that are executed on followers are rejected + and can be tracked via the metric `arangodb_agency_read_no_leader_total`. + This metric was named `arangodb_agency_read_ok` in previous + versions of ArangoDB. + +- name: arangodb_agency_supervision_failed_server_total + renamedFrom: arangodb_agency_supervision_failed_server_count + introducedIn: "3.8.0" + help: | + Counter for FailedServer jobs. + unit: number + type: counter + category: Agency + complexity: medium + exposedBy: + - agent + description: | + Counter for FailedServer jobs. This counter is increased whenever a + supervision run encounters a failed server and starts a FailedServer job. + This metric was named `arangodb_agency_supervision_failed_server_count` + in previous versions of ArangoDB. + threshold: | + Many FailedServer jobs indicate frequent failures of DB-Servers. This + is generally not good. + troubleshoot: | + Find the root cause of server failures. Overload and bad network latency + can lead to misdetected server failures. + +- name: arangodb_agency_supervision_runtime_msec + introducedIn: "3.7.1" + help: | + Agency supervision runtime histogram. + unit: ms + type: histogram + category: Agency + complexity: simple + exposedBy: + - agent + description: | + Agency supervision runtime histogram. A new value is recorded for each + run of the supervision. + threshold: | + The supervision runtime goes up linearly with the number of collections + and shards. + +- name: arangodb_agency_supervision_runtime_wait_for_replication_msec + introducedIn: "3.7.1" + help: | + Agency supervision wait for replication time. + unit: ms + type: histogram + category: Agency + complexity: medium + exposedBy: + - agent + description: | + Agency supervision replication time histogram. Whenever the Agency + supervision carries out changes, it writes them to the leader's log + and replicates the changes to followers. This metric provides a histogram + of the time it took to replicate the supervision changes to followers. + +- name: arangodb_agency_term + introducedIn: "3.7.1" + help: | + Agency's term. + unit: number + type: gauge + category: Agency + complexity: medium + exposedBy: + - agent + description: | + The Agency's current term. + threshold: | + This number should usually not grow. If it does, the Agency is doing + repeated reelections, which suggests overload or bad network latency + between Agents. + troubleshoot: | + It might help to reduce network latency between Agents or move Agent + instances to separate machines. + +- name: arangodb_agency_write_hist + introducedIn: "3.7.1" + help: | + Agency write time histogram. + unit: ms + type: histogram + category: Agency + complexity: medium + exposedBy: + - agent + description: | + Agency write time histogram. This histogram provides the distribution + of the times spent in Agency write operations, in milliseconds. This only + includes the time required to write the data into the leader's log, but + does not include the time required to replicate the writes to the followers. + +- name: arangodb_agency_write_no_leader_total + renamedFrom: arangodb_agency_write_no_leader + introducedIn: "3.8.0" + help: | + Agency write operations with no leader or on followers. + unit: number + type: counter + category: Agency + complexity: medium + exposedBy: + - agent + description: | + Total number of Agency write operations with no leader or on followers. + threshold: | + This should normally not happen. If it happens regularly, the Agency + is reelecting its leader often. + troubleshoot: | + The latency of the network between the Agents might be too high or + the Agents may be overloaded. It might help to move Agent instances + to separate machines. + +- name: arangodb_agency_write_ok_total + renamedFrom: arangodb_agency_write_ok + introducedIn: "3.8.0" + help: | + Number of successful Agency write operations. + unit: number + type: counter + category: Agency + complexity: simple + exposedBy: + - agent + description: | + Number of Agency write operations which were successful (i.e. completed + without any error). Successful writes can only be executed on the leader, so + this metric is supposed to increase only on Agency leaders, but not on + followers. Write requests that are executed on followers are rejected + and can be tracked via the metric `arangodb_agency_write_no_leader_total`. + This metric was named `arangodb_agency_write_ok` in previous + versions of ArangoDB. + +- name: arangodb_agencycomm_request_time_msec + introducedIn: "3.7.1" + help: | + Request time for Agency requests. + unit: ms + type: histogram + category: Network + complexity: medium + exposedBy: + - coordinator + - dbserver + description: | + This histogram shows how long requests to the Agency took. + threshold: | + Usually, such requests should be relatively quick, mostly clearly + sub-second. + troubleshoot: | + If the network or the Agents are overloaded, it can help to move + Agent instances to separate machines. + +- name: arangodb_aql_all_query_total + renamedFrom: arangodb_aql_all_query + introducedIn: "3.8.0" + help: | + Total number of AQL queries finished. + unit: number + type: counter + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of AQL queries finished. + This metric was named `arangodb_aql_all_query` in previous + versions of ArangoDB. + +- name: arangodb_aql_current_query + introducedIn: "3.8.0" + help: | + Current number of AQL queries executing. + unit: number + type: gauge + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Current number of AQL queries executing. + +- name: arangodb_aql_global_memory_limit + introducedIn: "3.8.0" + help: | + Total memory limit for all AQL queries combined. + unit: bytes + type: gauge + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total memory limit for all AQL queries combined, in bytes. + If this value is reported as `0`, it means there is no total memory + limit in place for AQL queries. The value can be adjusted by the setting + the `--query.global-memory-limit` startup option. + +- name: arangodb_aql_global_memory_usage + introducedIn: "3.8.0" + help: | + Total memory usage of all AQL queries executing; granularity: 32768 bytes steps. + unit: bytes + type: gauge + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total memory usage of all AQL queries currently executing. + The granularity of this metric is steps of 32768 bytes. The current + memory usage of all AQL queries is compared against the configured + limit in the `--query.global-memory-limit` startup option. + If the startup option has a value of `0`, then no global memory limit + are enforced. If the startup option has a non-zero value, queries + are aborted once the total query memory usage goes above the configured + limit. + +- name: arangodb_aql_global_query_memory_limit_reached_total + introducedIn: "3.8.0" + help: | + Number of times the global query memory limit threshold was reached. + unit: number + type: counter + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of times the global query memory limit threshold was reached. + This can happen if all running AQL queries in total try to use more memory than + configured via the `--query.global-memory-limit` startup option. + Every time this counter increases, an AQL query aborted with a + "resource limit exceeded" error. + +- name: arangodb_aql_local_query_memory_limit_reached_total + introducedIn: "3.8.0" + help: | + Number of times a local query memory limit threshold was reached. + unit: number + type: counter + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of times a local query memory limit threshold was reached, i.e. + a single query tried to allocate more memory than configured in the query's + `memoryLimit` attribute or the value configured via the startup option + `--query.memory-limit`. + Every time this counter increases, an AQL query aborted with a + "resource limit exceeded" error. + +- name: arangodb_aql_query_time + introducedIn: "3.6.10" + help: | + Execution time histogram for all AQL queries. + unit: s + type: histogram + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Execution time histogram for all AQL queries, in seconds. + The histogram includes all slow queries. + +- name: arangodb_aql_slow_query_time + introducedIn: "3.6.10" + help: | + Execution time histogram for slow AQL queries. + unit: s + type: histogram + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Execution time histogram for slow AQL queries, in seconds. + Queries are considered "slow" if their execution time is above the + threshold configured in the startup options `--query.slow-threshold` + or `--query.slow-streaming-threshold`, respectively. + +- name: arangodb_aql_total_query_time_msec_total + renamedFrom: arangodb_aql_total_query_time_msec + introducedIn: "3.8.0" + help: | + Total execution time of all AQL queries. + unit: ms + type: counter + category: AQL + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total execution time of all AQL queries, in milliseconds, + including all slow queries. + +- name: arangodb_client_connection_statistics_bytes_received + introducedIn: "3.8.0" + help: | + Bytes received for requests. + unit: bytes + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the received request sizes in bytes. + +- name: arangodb_client_connection_statistics_bytes_sent + introducedIn: "3.8.0" + help: | + Bytes sent for responses. + unit: bytes + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the sent response sizes in bytes + +- name: arangodb_client_connection_statistics_client_connections + introducedIn: "3.6.1" + help: | + The number of client connections that are currently open. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of client connections that are currently open. + Note: this metric considers only HTTP and HTTP/2 connections, but not VST + connections. + +- name: arangodb_client_connection_statistics_connection_time + introducedIn: "3.8.0" + help: | + Total connection time of a client. + unit: s + type: histogram + category: Statistics + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the connection's total lifetime, i.e., the time between the + point when the connection was established until it was closed. Smaller + numbers indicate that there is not a lot of load and/or that connections + are not reused for multiple requests. Consider using keep-alive header + or HTTP/2 or VST. + +- name: arangodb_client_connection_statistics_io_time + introducedIn: "3.8.0" + help: | + I/O time needed to answer a request. + unit: number + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of I/O times needed to answer a request. This includes the time + required to read the incoming request as well as the time required to send + the response. + +- name: arangodb_client_connection_statistics_queue_time + introducedIn: "3.8.0" + help: | + Queueing time needed for requests. + unit: s + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the time requests are spending on a queue waiting to be + processed. The overwhelming majority of these times should be clearly + sub-second. + +- name: arangodb_client_connection_statistics_request_time + introducedIn: "3.8.0" + help: | + Request time needed to answer a request. + unit: s + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the time required to actually process a request. This does not + include the time required to read the incoming request, the time the request + is sitting on the queue, or the time required to send the response. + +- name: arangodb_client_connection_statistics_total_time + introducedIn: "3.8.0" + help: | + Total time needed to answer a request. + unit: s + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the total times required to process a request. This includes + the time required to read the incoming request, the time the request is + sitting in the queue, the time to actually process the request, and the + time required to send the response. + +- name: arangodb_client_user_connection_statistics_bytes_received + introducedIn: "3.10.2" + help: | + Bytes received for requests, only user traffic. + unit: bytes + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the received request sizes in bytes, only considering user + traffic, i.e. traffic authenticated with a real user (or role). + +- name: arangodb_client_user_connection_statistics_bytes_sent + introducedIn: "3.10.2" + help: | + Bytes sent for responses, only user traffic. + unit: bytes + type: histogram + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the sent response sizes in bytes, only user traffic, i.e. + traffic that has been authenticated with a real user (or role). + +- name: arangodb_collection_lock_acquisition_micros_total + renamedFrom: arangodb_collection_lock_acquisition_micros + introducedIn: "3.8.0" + help: | + Total amount of collection lock acquisition time. + unit: us + type: counter + category: Transactions + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + Total amount of time it took to acquire collection/shard locks for + write operations, summed up for all collections/shards. Does not increase + for any read operations. + The value is measured in microseconds. + troubleshoot: | + In case this value is considered too high, check if there are AQL queries + or transactions that use exclusive locks on collections, and try to reduce them. + Operations using exclusive locks may lock out other queries/transactions temporarily, + which leads to an increase in lock acquisition time. + +- name: arangodb_collection_lock_acquisition_time + introducedIn: "3.6.11" + help: | + Collection lock acquisition time histogram. + unit: s + type: histogram + category: RocksDB + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + Histogram of the collection/shard lock acquisition times. Locks are acquired for + all write operations, but not for read operations. + The values here are measured in seconds. + troubleshoot: | + In case these values are considered too high, check if there are AQL queries + or transactions that use exclusive locks on collections, and try to reduce them. + Operations using exclusive locks may lock out other queries/transactions temporarily, + which leads to an increase in lock acquisition times. + +- name: arangodb_collection_lock_sequential_mode_total + renamedFrom: arangodb_collection_lock_sequential_mode + introducedIn: "3.8.0" + help: | + Number of transactions using sequential locking of collections to avoid deadlocking. + unit: number + type: counter + category: Transactions + complexity: advanced + exposedBy: + - coordinator + description: | + Number of transactions using sequential locking of collections to avoid deadlocking. + By default, a Coordinator tries to lock all shards of a collection in parallel. + This approach is normally fast but can cause deadlocks with other transactions that + lock the same shards in a different order. In case such a deadlock is detected, the + Coordinator aborts the lock round and starts a new one that locks all shards in + sequential order. This avoids deadlocks, but has a higher setup overhead. + troubleshoot: | + In case this value is increasing, check if there are AQL queries or transactions that + use exclusive locks on collections, and try to reduce them. + Operations using exclusive locks may lock out other queries/transactions temporarily, + which can lead to (temporary) deadlocks in case the queries/transactions + are run on multiple shards on different servers. + +- name: arangodb_collection_lock_timeouts_exclusive_total + renamedFrom: arangodb_collection_lock_timeouts_exclusive + introducedIn: "3.8.0" + help: | + Number of timeouts when trying to acquire collection exclusive locks. + unit: number + type: counter + category: Transactions + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + Number of timeouts when trying to acquire collection exclusive locks. + This counter increases whenever an exclusive collection lock + cannot be acquired within the configured lock timeout. + troubleshoot: | + In case this value is considered too high, check if there are AQL queries + or transactions that use exclusive locks on collections, and try to reduce them. + Operations using exclusive locks may lock out other queries/transactions temporarily, + which can lead to other operations running into timeouts waiting for the same locks. + +- name: arangodb_collection_lock_timeouts_write_total + renamedFrom: arangodb_collection_lock_timeouts_write + introducedIn: "3.8.0" + help: | + Number of timeouts when trying to acquire collection write locks. + unit: number + type: counter + category: Transactions + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + Number of timeouts when trying to acquire collection write locks. + This counter increases whenever a collection write lock + cannot be acquired within the configured lock timeout. + This can only happen if writes on a collection are locked out by + other operations on the collection that use an exclusive lock. Writes + are not locked out by other, non-exclusively locked writes. + troubleshoot: | + In case this value is considered too high, check if there are AQL queries + or transactions that use exclusive locks on collections, and try to reduce them. + Operations using exclusive locks may lock out other queries/transactions temporarily, + which can lead to other operations running into timeouts waiting for the same locks. + +- name: arangodb_collection_truncate_time + introducedIn: "3.8.0" + help: | + Total time spent in collection truncate operations. + unit: s + type: histogram + category: Transactions + complexity: simple + exposedBy: + - dbserver + - agent + - single + description: | + Total time spent in collection truncate operations, including both + user-initiated truncate operations and truncate operations + executed by the synchronous replication on followers. + Note that this metric is only present when the command + line option `--server.export-read-write-metrics` is set to `true`. + +- name: arangodb_collection_truncates_replication_total + renamedFrom: arangodb_collection_truncates_replication + introducedIn: "3.8.0" + help: | + Total number of collection truncate operations by synchronous replication. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + Total number of collection truncate operations by synchronous + replication on followers. Note that this metric is only present when the command + line option `--server.export-read-write-metrics` is set to `true`. + +- name: arangodb_collection_truncates_total + renamedFrom: arangodb_collection_truncates + introducedIn: "3.8.0" + help: | + Total number of collection truncate operations (excluding synchronous replication). + unit: number + type: counter + category: Transactions + complexity: simple + exposedBy: + - agent + - dbserver + - single + description: | + Total number of collection truncate operations on leaders (excluding synchronous + replication). Note that this metric is only present when the command + line option `--server.export-read-write-metrics` is set to `true`. + +- name: arangodb_connection_pool_connections_created_total + renamedFrom: arangodb_connection_pool_connections_created + introducedIn: "3.8.0" + help: | + Total number of connections created for connection pool. + unit: number + type: counter + category: Connectivity + complexity: medium + exposedBy: + - coordinator + - dbserver + description: | + Total number of connections created for connection pool. There are + two pools, one for the Agency communication with label `AgencyComm` + and one for the other cluster internal communication with label + `ClusterComm`. + threshold: | + Because of idle timeouts, the total number of connections ever created + grows. However, under high load, most connections should usually + be reused and a fast growth of this number can indicate underlying + connectivity issues. + +- name: arangodb_connection_pool_connections_current + renamedFrom: arangodb_connection_connections_current + introducedIn: "3.8.0" + help: | + Current number of connections in pool. + unit: number + type: gauge + category: Connectivity + complexity: medium + exposedBy: + - coordinator + - dbserver + description: | + Current number of connections in pool. There are two pools, one for the + Agency communication with label `AgencyComm` and one for the other + cluster internal communication with label `ClusterComm`. + threshold: | + Normally, one should not see an excessive amount of open connections + here, unless a very high amount of operations happens concurrently. + +- name: arangodb_connection_pool_lease_time_hist + introducedIn: "3.8.0" + help: | + Time to lease a connection from the connection pool. + unit: ms + type: histogram + category: Connectivity + complexity: simple + exposedBy: + - coordinator + - dbserver + description: | + Time to lease a connection from the connection pool. There are two pools, + one for the Agency communication with label `AgencyComm` and one for + the other cluster internal communication with label `ClusterComm`. + threshold: | + Leasing connections from the pool should be fast, unless a new connection + has to be formed, which can easily take (in particular with TLS) several + milliseconds. If times are a lot higher, then some underlying network + problem might be there. + +- name: arangodb_connection_pool_leases_failed_total + renamedFrom: arangodb_connection_pool_leases_failed + introducedIn: "3.8.0" + help: | + Total number of failed connection leases. + unit: number + type: counter + category: Connectivity + complexity: medium + exposedBy: + - coordinator + - dbserver + description: | + Total number of failed connection leases. There are two pools, one for + the Agency communication with label `AgencyComm` and one for the other + cluster internal communication with label `ClusterComm`. + threshold: | + A failed lease can happen if a connection has been terminated + by some idle timeout or if it is already in use by some other request. + Since this can happen under concurrent load, failed leases are not + actually very worrying. + +- name: arangodb_connection_pool_leases_successful_total + renamedFrom: arangodb_connection_leases_successful + introducedIn: "3.8.0" + help: | + Total number of successful connection leases from connection pool. + unit: number + type: counter + category: Connectivity + complexity: medium + exposedBy: + - coordinator + - dbserver + description: | + Total number of successful connection leases from connection pool. + There are two pools, one for the Agency communication with label + `AgencyComm` and one for the other cluster internal communication with + label `ClusterComm`. + threshold: | + It is normal that this number is growing rapidly when there is any + kind of activity in the cluster. + +- name: arangodb_dirty_read_queries_total + introducedIn: "3.10.0" + help: | + Number of AQL queries which have been executed with dirty reads. + unit: number + type: counter + category: AQL + complexity: simple + exposedBy: + - coordinator + description: | + This counter exposes the number of AQL queries which have been executed + with "dirty reads". A dirty read is one which may also use follower shards + and not only leader shards. Note that it is the transaction in the context + of which the AQL runs which determines, if dirty reads are allowed. + +- name: arangodb_dirty_read_transactions_total + introducedIn: "3.10.0" + help: | + Number of read transactions, which are allowed to do dirty reads. + unit: number + type: counter + category: Transactions + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of read-only transactions, which allow for dirty reads + (read from followers). This metric is only collected for + transactions on Coordinators in a cluster. Other instances may expose + the value as `0`. + +- name: arangodb_document_insert_time + introducedIn: "3.8.0" + help: | + Total time spent in document insert operations. + unit: s + type: histogram + category: Transactions + complexity: simple + exposedBy: + - agent + - dbserver + - single + description: | + Total time spent in document insert operations, including both + user-initiated insert operations and insert operations executed by + the synchronous replication on followers. This metric + is only present if the option `--server.export-read-write-metrics` is set + to `true`. + +- name: arangodb_document_read_time + introducedIn: "3.8.0" + help: | + Total time spent in document read-by-primary-key operations. + unit: s + type: histogram + category: Transactions + complexity: simple + exposedBy: + - dbserver + - single + - agent + description: | + Total time spent in document read-by-primary-key operations. This metric + is only present if the option `--server.export-read-write-metrics` is set + to `true`. + +- name: arangodb_document_remove_time + introducedIn: "3.8.0" + help: | + Total time spent in document remove operations. + unit: s + type: histogram + category: Transactions + complexity: simple + exposedBy: + - agent + - dbserver + - single + description: | + Total time spent in document replace operations, including both + user-initiated replace operations and replace operations executed by + the synchronous replication on followers. This metric + is only present if the option `--server.export-read-write-metrics` is set + to `true`. + +- name: arangodb_document_replace_time + introducedIn: "3.8.0" + help: | + Total time spent in document replace operations. + unit: s + type: histogram + category: Transactions + complexity: simple + exposedBy: + - agent + - dbserver + - single + description: | + Total time spent in document replace operations, including both + user-initiated replace operations and replace operations executed by + the synchronous replication on followers. This metric + is only present if the option `--server.export-read-write-metrics` is set + to `true`. + +- name: arangodb_document_update_time + introducedIn: "3.8.0" + help: | + Total time spent in document update operations. + unit: s + type: histogram + category: Transactions + complexity: simple + exposedBy: + - agent + - dbserver + - single + description: | + Total time spent in document update operations, including both + user-initiated update operations and update operations executed by + the synchronous replication on followers. This metric + is only present if the option `--server.export-read-write-metrics` is set + to `true`. + +- name: arangodb_document_writes_replication_total + renamedFrom: arangodb_document_writes_replication + introducedIn: "3.8.0" + help: | + Total number of document write operations by synchronous replication. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + Total number of document write operations by synchronous replication. + This metric is only present if the option + `--server.export-read-write-metrics` is set to `true`. + Total number of document write operations (insert, update, replace, remove) + executed by the synchronous replication on followers. + This metric is only present if the option `--server.export-read-write-metrics` + is set to `true`. + +- name: arangodb_document_writes_total + renamedFrom: arangodb_document_writes + introducedIn: "3.8.0" + help: | + Total number of document write operations (excluding synchronous replication). + unit: number + type: counter + category: Transactions + complexity: medium + exposedBy: + - agent + - dbserver + - single + description: | + Total number of document write operations (insert, update, replace, remove) on + leaders, excluding writes by the synchronous replication on followers. + This metric is only present if the option `--server.export-read-write-metrics` + is set to `true`. + +- name: arangodb_dropped_followers_total + renamedFrom: arangodb_dropped_followers_count + introducedIn: "3.8.0" + help: | + Number of drop-follower events. + unit: number + type: counter + category: Health + complexity: simple + exposedBy: + - dbserver + description: | + Total number of drop-follower events. This metric is increased on leaders + whenever a write operation cannot be replicated to a follower during + synchronous replication, and it would be unsafe in terms of data consistency + to keep that follower. + This metric was named `arangodb_dropped_followers_count` in previous + versions of ArangoDB. + threshold: | + Usually, drop-follower events should only happen if servers are + restarted or if there are real problems on followers. + +- name: arangodb_file_descriptors_current + introducedIn: "3.10.7" + help: | + Number of file descriptors currently opened by the arangod process. + unit: number + type: gauge + category: Statistics + complexity: medium + exposedBy: + - agent + - coordinator + - dbserver + - single + description: | + Number of file descriptors currently opened by the arangod process. + This will include regular files as well as sockets. + The metric is only available on platforms that support it. + As counting the number of file descriptors can be expensive and can have + an impact on performance, the metric will only be updated in a controllable + interval. The interval can be adjusted via the startup option + `--server.count-descriptors-interval`. Shorter intervals mean more up-to-date + count values, at the potential expense of more IO operations that are + required for counting. + It is possible to turn off counting of file descriptors by setting the + interval to 0. In this case, the metric will report a value of 0. + +- name: arangodb_file_descriptors_limit + introducedIn: "3.10.7" + help: | + System limit for the number of open file descriptors for the arangod process. + unit: number + type: gauge + category: Statistics + complexity: medium + exposedBy: + - agent + - coordinator + - dbserver + - single + description: | + System limit for the number of open file descriptors for the arangod process. + It is only available on platforms that support it. The limit is imposed by + the operating system or system configuration. + The value of this metric will remain constant for the entire lifetime of + the process. + +- name: arangodb_flush_subscriptions + introducedIn: "3.9.10" + help: | + Number of currently active flush subscriptions. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exposes the number of currently active flush subscriptions. + Flush subscriptions can be created by `arangosearch` View links and by background + index creation. + +- name: arangodb_heartbeat_failures_total + renamedFrom: arangodb_heartbeat_failures + introducedIn: "3.8.0" + help: | + Total number of failed heartbeat transmissions. + unit: number + type: counter + category: Health + complexity: simple + exposedBy: + - coordinator + - dbserver + - single + description: | + Total number of failed heartbeat transmissions. + Servers in a cluster periodically send their heartbeats to + the Agency to report their own liveliness. This counter gets + increased whenever sending such a heartbeat fails. In the single + server, this counter is only used in the Active Failover deployment mode. + threshold: | + It is a bad sign for health if heartbeat transmissions fail. This can + lead to failover actions which are ultimately bad for the service. + troubleshoot: | + This can be a sign of overload or of bad network connectivity. Potentially + move the Agent instances to separate machines. + +- name: arangodb_heartbeat_send_time_msec + introducedIn: "3.7.1" + help: | + Time required to send a heartbeat. + unit: ms + type: histogram + category: Health + complexity: medium + exposedBy: + - coordinator + - dbserver + - single + description: | + Histogram of times required to send heartbeats. For every heartbeat + sent the time is measured and an event is put into the histogram. + In the single server, this counter is only used in the Active Failover + deployment mode. + threshold: | + It is a bad sign for health if heartbeat transmissions are not fast. + If there are heartbeats which frequently take longer than a few hundred + milliseconds, or even seconds, this can eventually lead to failover actions + which are ultimately bad for the service. + troubleshoot: | + High heartbeat send times can be a sign of overload or of bad network + connectivity. Potentially move the Agent instances to separate machines. + +- name: arangodb_http1_connections_total + introducedIn: "3.10.2" + help: | + Total number of HTTP/1.1 connections accepted. + unit: number + type: counter + category: Connectivity + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of connections accepted for HTTP/1.1. Note that this can + include connections that are negotiated to be upgraded to HTTP/2. + +- name: arangodb_http2_connections_total + introducedIn: "3.7.15" + help: | + Total number of HTTP/2 connections accepted. + unit: number + type: counter + category: Connectivity + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of connections accepted for HTTP/2, this can be upgraded + connections from HTTP/1.1 or connections negotiated to be HTTP/2 during + the TLS handshake. + +- name: arangodb_http_request_statistics_async_requests_total + renamedFrom: arangodb_http_request_statistics_async_requests + introducedIn: "3.8.0" + help: | + Number of asynchronously executed HTTP requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of **asynchronous** HTTP (or VST) + requests which have hit this particular instance of `arangod`. Asynchronous + refers to the fact that the response is not sent with the HTTP response, + but is rather queried separately using the `/_api/jobs` API. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_http_delete_requests_total + renamedFrom: arangodb_http_request_statistics_http_delete_requests + introducedIn: "3.8.0" + help: | + Number of HTTP DELETE requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **DELETE** + requests which have hit this particular instance of `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_http_get_requests_total + renamedFrom: arangodb_http_request_statistics_http_get_requests + introducedIn: "3.8.0" + help: | + Number of HTTP GET requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **GET** + requests which have hit this particular instance of `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_http_head_requests_total + renamedFrom: arangodb_http_request_statistics_http_head_requests + introducedIn: "3.8.0" + help: | + Number of HTTP HEAD requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **HEAD** + requests which have hit this particular instance of `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_http_options_requests_total + renamedFrom: arangodb_http_request_statistics_http_options_requests + introducedIn: "3.8.0" + help: | + Number of HTTP OPTIONS requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **OPTIONS** + requests which have hit this particular instance of `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_http_patch_requests_total + renamedFrom: arangodb_http_request_statistics_http_patch_requests + introducedIn: "3.8.0" + help: | + Number of HTTP PATCH requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **PATCH** + requests which have hit this particular instance of `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_http_post_requests_total + renamedFrom: arangodb_http_request_statistics_http_post_requests + introducedIn: "3.8.0" + help: | + Number of HTTP POST requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **POST** + requests which have hit this particular instance of `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_http_put_requests_total + renamedFrom: arangodb_http_request_statistics_http_put_requests + introducedIn: "3.8.0" + help: | + Number of HTTP PUT requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **PUT** + requests which have hit this particular instance of `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_other_http_requests_total + renamedFrom: arangodb_http_request_statistics_other_http_requests + introducedIn: "3.8.0" + help: | + Number of other HTTP requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) **other** + or **ILLEGAL** requests which have hit this particular instance of + `arangod`. These are all requests, which are not one of the following: + `DELETE`, `GET`, `HEAD`, `POST`, `PUT`, `OPTIONS`, `PATCH`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_superuser_requests_total + renamedFrom: arangodb_http_request_statistics_superuser_requests + introducedIn: "3.8.0" + help: | + Total number of HTTP requests executed by superuser/JWT. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) + requests that have been authenticated with the JWT superuser token, + which have hit this particular instance of + `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_total_requests_total + renamedFrom: arangodb_http_request_statistics_total_requests + introducedIn: "3.8.0" + help: | + Total number of HTTP requests. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) requests which + have hit this particular instance of `arangod`. Note that this counter + is ever growing during the lifetime of the `arangod` process. However, + when the process is restarted, it starts from scratch. In the Grafana + dashboards, it is usually visualized as a rate per second, averaged + with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_http_request_statistics_user_requests_total + renamedFrom: arangodb_http_request_statistics_user_requests + introducedIn: "3.8.0" + help: | + Total number of HTTP requests executed by user clients. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of HTTP (or VST) requests + that have been authenticated for some user (as opposed to with the + JWT superuser token), which have hit this particular instance of + `arangod`. + + Note that this counter is ever growing during the lifetime of the + `arangod` process. However, when the process is restarted, it starts + from scratch. In the Grafana dashboards, it is usually visualized as a + rate per second, averaged with a sliding window of a minute. + threshold: | + This metrics reflects the performance of an instance in a certain way. + Note that your mileage may vary according to available resources as well + as to complexity of the requests the client sends. + +- name: arangodb_intermediate_commits_total + renamedFrom: arangodb_intermediate_commits + introducedIn: "3.8.0" + help: | + Number of intermediate commits performed in transactions. + unit: number + type: counter + category: Statistics + complexity: medium + exposedBy: + - dbserver + - single + description: | + Number of intermediate commits performed in transactions. + An intermediate commit happens if a logical transaction needs to be + split into multiple physical transaction because of the volume of data + handled in the transaction. The thresholds for when to perform an + intermediate commit can be controlled by startup options + `--rocksdb.intermediate-commit-count` (number of write operations after + which an intermediate commit is triggered) and `--rocksdb.intermediate-commit-size` + (cumulated size of write operations after which an intermediate commit is triggered). + The values can also be overridden for individual transactions. + This metric was named `arangodb_intermediate_commits` in previous + versions of ArangoDb. + troubleshoot: | + If this value is non-zero, it doesn't necessarily indicate a problem. It can + happen for large transactions and large data-loading jobs. However, as modifications + performed by intermediate commits are persisted and cannot simply be rolled back in + memory, it should be monitored whether the intermediate commits only happen for + operations where they are expected. If they also happen for operations that are + supposed to be atomic, then the intermediate commit size and count parameters need + to be adjusted, or larger operations should be broken up into smaller ones in the + client application. + +- name: arangodb_ioheartbeat_delays_total + introducedIn: "3.8.7" + help: | + Number of delays in the io heartbeat test. + unit: number + type: counter + category: Health + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This counter is increased whenever the io heartbeat encounters a delay + of at least 1s when writing a small file to the database directory, + reading it and then removing it again. + This test is done periodically to ensure that the underlying volume is + usable and performs reasonably well. The test can be switched off + explicitly with the flag `--database.io-heartbeat=false`, but the + default is `true`. Furthermore, every such failure leads to a line in + the log at INFO level for the `ENGINES` topic. + +- name: arangodb_ioheartbeat_duration + introducedIn: "3.8.7" + help: | + Histogram of execution times of a single IO heartbeat check. + unit: us + type: histogram + category: Health + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This histogram is updated whenever the io heartbeat runs its test in + the database directory. It writes a small file, syncs it to durable + storage, reads it, and then unlinks the file again. This test is done + periodically to ensure that the underlying volume is usable and performs + reasonably well. The test can be switched off explicitly with the flag + `--database.io-heartbeat=false`, but the default is `true`. + +- name: arangodb_ioheartbeat_failures_total + introducedIn: "3.8.7" + help: | + Number of failures in the io heartbeat test. + unit: number + type: counter + category: Health + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This counter is increased whenever the io heartbeat encounters a problem + when writing a small file to the database directory, reading it and then + removing it again. This test is done + periodically to ensure that the underlying volume is usable. The test can + be switched off explicitly with the flag `--database.io-heartbeat=false`, + but the default is `true`. Furthermore, every such failure leads to a + line in the log at INFO level for the `ENGINES` topic. + +- name: arangodb_license_expires + introducedIn: "3.9.1" + help: | + This instance's license expiry in days. + unit: number + type: gauge + category: License + complexity: simple + exposedBy: + - coordinator + - dbserver + description: | + This instance's remaining license validity time. + +- name: arangodb_load_current_runtime + introducedIn: "3.7.1" + help: | + `Current` loading runtimes. + unit: ms + type: histogram + category: Maintenance + complexity: medium + exposedBy: + - coordinator + - dbserver + description: | + Histogram of `Current` loading runtimes, i.e. the runtimes + of the `ClusterInfo::loadCurrent` internal method. Provides a + distribution of all loading times for the `Current` + section of the Agency data. The `Current` section gets + loaded on server startup, and then gets reloaded on servers + only for any databases in which there have been recent structural + changes (i.e. DDL changes). + troubleshoot: | + In case this histogram contains very high loading times, this + may be due to using many collections or many shards inside a + database for which there are often structural changes. It then + may make sense to reduce the number of collections or number + of shards. Note that this can have other effects, so it requires + an informed decision. + +- name: arangodb_load_plan_runtime + introducedIn: "3.7.1" + help: | + `Plan` loading runtimes. + unit: ms + type: histogram + category: Maintenance + complexity: medium + exposedBy: + - coordinator + - dbserver + description: | + Histogram of `Plan` loading runtimes, i.e. the runtimes + of the `ClusterInfo::loadPlan` internal method. Provides a + distribution of all loading times for the `Plan` + section of the Agency data. The `Plan` section normally gets + loaded on server startup, and then gets reloaded on servers + only for any databases in which there have been recent structural + changes (i.e. DDL changes). + troubleshoot: | + In case this histogram contains very high loading times, this + may be due to using many collections or many shards inside a + database for which there are often structural changes. It then + may make sense to reduce the number of collections or number + of shards. Note that this can have other effects, so it requires + an informed decision. + +- name: arangodb_logger_errors_total + introducedIn: "3.9.0" + help: | + Total number of errors logged. + unit: number + type: counter + category: Errors + complexity: simple + exposedBy: + - agent + - coordinator + - dbserver + - single + description: | + Total number of errors (ERR messages) logged by the logger. + + If a problem is encountered which is fatal to some operation, but not for + the service or the application as a whole, then an _error is logged. + + Reasons for log entries of this severity are for example include missing + data, inability to open required files, incorrect connection strings, + missing services. + + If an error is logged then it should be taken seriously as it may require + user intervention to solve. + +- name: arangodb_logger_warnings_total + introducedIn: "3.9.0" + help: | + Total number of warnings logged. + unit: number + type: counter + category: Errors + complexity: simple + exposedBy: + - agent + - coordinator + - dbserver + - single + description: | + Total number of warnings (WARN messages) logged by the logger, + including startup warnings. + + Warnings might indicate problems, or might not. For example, + expected transient environmental conditions such as short loss of + network or database connectivity are logged as warnings, not errors. + +- name: arangodb_maintenance_action_done_total + renamedFrom: arangodb_maintenance_action_done_counter + introducedIn: "3.8.0" + help: | + Counter of actions that are done and have been removed from the registry. + unit: number + type: counter + category: Maintenance + complexity: simple + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. Actions are created, registered, queued and executed. + Once they are done, they are eventually removed. + + This metric counts the number of actions that are done and have been removed. + +- name: arangodb_maintenance_action_duplicate_total + renamedFrom: arangodb_maintenance_action_duplicate_counter + introducedIn: "3.8.0" + help: | + Counter of actions that have been discarded because of a duplicate. + unit: number + type: counter + category: Maintenance + complexity: advanced + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. Actions are created, registered, queued and executed. + Once they are done, they are eventually removed. + + This metric counts the number of actions that have been created but found to + be a duplicate of a already queued action. + +- name: arangodb_maintenance_action_failure_total + renamedFrom: arangodb_maintenance_action_failure_counter + introducedIn: "3.8.0" + help: | + Failure counter for the maintenance actions. + unit: number + type: counter + category: Maintenance + complexity: simple + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. Actions are created, registered, queued and executed. + Once they are done, they are eventually removed. + + Those action can fail for different reasons. This metric counts the failed + actions and can thus provide hints to investigate a malfunction. + +- name: arangodb_maintenance_action_queue_time_msec + introducedIn: "3.7.1" + help: | + Time spent in the queue before execution for maintenance actions. + unit: ms + type: histogram + category: Maintenance + complexity: advanced + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. Actions are created, registered, queued and executed. + Once they are done, they are eventually removed. + + This metric tracks the time actions spend waiting in the queue in a histogram. + +- name: arangodb_maintenance_action_registered_total + renamedFrom: arangodb_maintenance_action_registered_counter + introducedIn: "3.8.0" + help: | + Counter of actions that have been registered in the action registry. + unit: number + type: counter + category: Maintenance + complexity: simple + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. Actions are created, registered, queued and executed. + Once they are done, they are eventually removed. + + This metric counts the number of actions that are queued or active. + +- name: arangodb_maintenance_action_runtime_msec + introducedIn: "3.7.1" + help: | + Time spent executing a maintenance action. + unit: ms + type: histogram + category: Maintenance + complexity: advanced + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. Actions are created, registered, queued and executed. + Once they are done, they are eventually removed. + + This metric tracks the time actions spend executing in a histogram. + +- name: arangodb_maintenance_agency_sync_runtime_msec + introducedIn: "3.7.1" + help: | + Total time spent on Agency sync. + unit: ms + type: histogram + category: Maintenance + complexity: simple + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. To identify the target state differences in the meta + data store provided by the Agency are investigated and local changes are + reported. This process is called Agency sync and is executed in regular + intervals. + + This metric tracks the runtime of individual Agency syncs in a histogram. + During DDL operations the runtime can increase but should generally be below + 1s. + +- name: arangodb_maintenance_phase1_runtime_msec + introducedIn: "3.7.1" + help: | + Maintenance Phase 1 runtime histogram. + unit: ms + type: histogram + category: Maintenance + complexity: advanced + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. To identify the target state differences in the meta + data store provided by the Agency are investigated and local changes are + reported. This process is called Agency sync and is executed in regular + intervals. + + This metric tracks the runtime of phase1 of an Agency sync. Phase1 calculates + the difference between the local and the target state. + +- name: arangodb_maintenance_phase2_runtime_msec + introducedIn: "3.7.1" + help: | + Maintenance Phase 2 runtime histogram. + unit: ms + type: histogram + category: Maintenance + complexity: advanced + exposedBy: + - dbserver + description: | + DB-Servers execute reconciliation actions to let the cluster converge + to the desired state. To identify the target state differences in the meta + data store provided by the Agency are investigated and local changes are + reported. This process is called Agency sync and is executed in regular + intervals. + + This metric tracks the runtime of phase2 of an Agency sync. Phase2 calculates + what actions to execute given the difference of the local and target state. + +- name: arangodb_network_dequeue_duration + introducedIn: "3.10.6" + help: | + Internal request duration for the dequeue in seconds. + unit: seconds + type: histogram + category: Network + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + description: | + Histogram providing the time from submitting an internal requests until + the IO thread in the fuerte driver starts working on it. Times are in + seconds. + troubleshoot: | + Counts in the high brackets indicate that the IO threads cannot keep up + with the work. + +- name: arangodb_network_forwarded_requests_total + renamedFrom: arangodb_network_forwarded_requests + introducedIn: "3.8.0" + help: | + Number of requests forwarded to another Coordinator. + unit: number + type: counter + category: Network + complexity: simple + exposedBy: + - coordinator + description: | + Number of requests forwarded to another Coordinator. + Request forwarding can happen in load-balanced setups, + when one Coordinator receives and forwards requests + that can only be handled by a different Coordinator. + This includes requests for streaming transactions, + AQL, query cursors, Pregel jobs and some others. + +- name: arangodb_network_request_duration_as_percentage_of_timeout + introducedIn: "3.8.0" + help: | + Internal request round-trip time as a percentage of timeout. + unit: percentage + type: gauge + category: Network + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + description: | + Histogram providing the round-trip time of internal requests as a percentage + of the respective request timeout. + This metric provides values between `0` and `100`. + troubleshoot: | + High values indicate problems with requests that have timed out or have not been + far away from running into timeouts. If many requests timeout, this is normally + a symptom of overload. This can normally be mitigated by reducing the workload + or adjusting the type of operations that are causing the high response times. + If the timeouts happen as a result of not enough processing power, it may be + useful to scale up the cluster. + +- name: arangodb_network_request_timeouts_total + renamedFrom: arangodb_network_request_timeouts + introducedIn: "3.8.0" + help: | + Number of internal requests that have timed out. + unit: number + type: counter + category: Network + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + description: | + Number of internal requests that have timed out. This metric is increased + whenever any cluster-internal request executed in the underlying connection + pool runs into a timeout. + troubleshoot: | + Request timeouts can be caused by the destination servers being overloaded + and thus slow to respond, or by network errors. If this counter increases, + it is advised to check network connectivity and server loads. + +- name: arangodb_network_requests_in_flight + introducedIn: "3.8.0" + help: | + Number of outgoing internal requests in flight. + unit: number + type: gauge + category: Network + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + description: | + Number of outgoing internal requests in flight. This metric is increased + whenever any cluster-internal request is about to be sent via the underlying + connection pool, and is decreased whenever a response for such a request is + received or the request runs into a timeout. + This metric provides an estimate of the fan-out of operations. For example, + a user operation on a collection with a single shard normally leads to + a single internal request (plus replication), whereas an operation on a + collection with 10 shards may lead to a fan-out of 10 (plus replication). + +- name: arangodb_network_response_duration + introducedIn: "3.10.6" + help: | + Internal request duration from fully sent till response received in seconds. + unit: seconds + type: histogram + category: Network + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + description: | + Histogram providing the time from when the request was fully sent off + until the response has been received of internal requests in seconds. + troubleshoot: | + Counts in the high brackets indicate problems with the network infrastructure. + +- name: arangodb_network_send_duration + introducedIn: "3.10.6" + help: | + Internal request send duration in seconds. + unit: seconds + type: histogram + category: Network + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + description: | + Histogram providing the sending time of internal requests in seconds. + troubleshoot: | + Counts in the high brackets indicate problems with the network infrastructure. + +- name: arangodb_network_unfinished_sends_total + introducedIn: "3.10.6" + help: | + Number of internal requests for which sending has not finished. + unit: number + type: counter + category: Network + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + description: | + Number of internal requests for which sending has not finished. This is + usually due to some connection problem or to a timeout in case the + receiving side did not receive the data fast enough. + troubleshoot: | + If this counter moves, it is a sign that either there are delays in the + networking infrastructure or on the receiving side. + +- name: arangodb_potentially_dirty_document_reads_total + introducedIn: "3.10.0" + help: | + Number of document reads which have been executed with dirty reads. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + description: | + This counter exposes the number of document reads (single or batch to + shards in the cluster) which have been executed with "dirty reads". + A dirty read is one which may also use follower shards and not only + leader shards. Note that it is the transaction in the context of which + the read runs which determines, if dirty reads are allowed. + +- name: arangodb_pregel_conductors_loading_number + introducedIn: "3.10.0" + help: | + Number of loading Pregel conductors. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of loading Pregel conductors. + +- name: arangodb_pregel_conductors_number + introducedIn: "3.10.0" + help: | + Number of Pregel conductors. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of Pregel conductors. + +- name: arangodb_pregel_conductors_running_number + introducedIn: "3.10.0" + help: | + Number of running Pregel conductors. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of running Pregel conductors. + +- name: arangodb_pregel_conductors_storing_number + introducedIn: "3.10.0" + help: | + Number of storing Pregel conductors. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of storing Pregel conductors. + +- name: arangodb_pregel_graph_memory_bytes_number + introducedIn: "3.10.0" + help: | + Memory allocated by Pregel for graph storage. + unit: bytes + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + The number of bytes allocated by Pregel. + +- name: arangodb_pregel_messages_received_total + introducedIn: "3.10.0" + help: | + Number of messages received by Pregel. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + The number of messages received by Pregel. + +- name: arangodb_pregel_messages_sent_total + introducedIn: "3.10.0" + help: | + Number of messages sent by Pregel. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of messages sent by Pregel. + +- name: arangodb_pregel_threads_number + introducedIn: "3.10.0" + help: | + Number of threads running for Pregel. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of threads running for Pregel. + +- name: arangodb_pregel_workers_loading_number + introducedIn: "3.10.0" + help: | + Number of loading Pregel workers. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of loading Pregel workers. + +- name: arangodb_pregel_workers_number + introducedIn: "3.10.0" + help: | + Number of Pregel workers. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of Pregel Workers. + +- name: arangodb_pregel_workers_running_number + introducedIn: "3.10.0" + help: | + Number of running Pregel workers. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of running Pregel workers. + +- name: arangodb_pregel_workers_storing_number + introducedIn: "3.10.0" + help: | + Number of storing Pregel workers. + unit: number + type: gauge + category: Pregel + complexity: simple + exposedBy: + - dbserver + - single + - coordinator + description: | + Number of storing Pregel workers. + +- name: arangodb_process_statistics_major_page_faults_total + renamedFrom: arangodb_process_statistics_major_page_faults + introducedIn: "3.8.0" + help: | + Number of major page faults. + unit: number + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + On Windows, this figure contains the total number of page faults. + On other system, this figure contains the number of major faults the + process has made which have required loading a memory page from disk. + troubleshooting: | + If the rate of this is high, i.e. it increases fast, it could be an indication + that the memory usage is too high, or the memory is too low, or paging is done + too aggressively (for Linux, this see sysctl and vm.swappiness). + +- name: arangodb_process_statistics_minor_page_faults_total + renamedFrom: arangodb_process_statistics_minor_page_faults + introducedIn: "3.8.0" + help: | + Number of minor page faults. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of minor faults the process has made which have not required + loading a memory page from disk. This figure is not reported on Windows. + +- name: arangodb_process_statistics_number_of_threads + introducedIn: "3.6.1" + help: | + Number of threads. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Number of threads in the arangod process. + +- name: arangodb_process_statistics_resident_set_size + introducedIn: "3.6.1" + help: | + Resident set size. + unit: bytes + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The total size of the number of pages the process has in real memory. + This is just the pages which count toward text, data, or stack space. + This does not include pages which have not been demand-loaded in, or + which are swapped out. The resident set size is reported in bytes. + +- name: arangodb_process_statistics_resident_set_size_percent + introducedIn: "3.6.1" + help: | + Resident set size as fraction of system memory. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The relative size of the number of pages the process has in real + memory compared to system memory. This is just the pages which count + toward text, data, or stack space. This does not include pages which + have not been demand-loaded in, or which are swapped out. The value is a + ratio between 0.00 and 1.00. + threshold: | + This value can be consistently relatively high, even when not under load, + due to different caches like the RocksDB block cache or the edge cache. There + should be some safety margin left, so it should not get too close to 1. + troubleshooting: | + If the memory is nearly full, this can lead to performance degradation, errors + because queries can't be executed, or the process being killed by the + operating system to free memory. This can be mitigated by adding more memory, + decreasing the size of caches if they aren't much needed, or restricting the + amount of memory AQL queries may use. + +- name: arangodb_process_statistics_system_time + introducedIn: "3.6.1" + help: | + Process system time. + unit: s + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Amount of time that this process has been scheduled in kernel mode, + measured in seconds. + threshold: | + This metric can vary significantly dependent on the workload. If the rate is + consistently very high, it could be an indication of some problem. + troubleshooting: | + There are many possible reasons for this, and specific advice cannot be given + here. Examples can be costly or inefficient queries being executed, or just + that the machine's performance is not sufficient for the tasks. + +- name: arangodb_process_statistics_user_time + introducedIn: "3.6.1" + help: | + Process user time. + unit: s + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Amount of time that this process has been scheduled in user mode, + measured in seconds. + threshold: | + This metric can vary significantly dependent on the workload. If the rate is + consistently very high, it could be an indication of some problem. + troubleshooting: | + There are many possible reasons for this, and specific advice cannot be given + here. Examples can be costly or inefficient queries being executed, or just + that the machine's performance is not sufficient for the tasks. + +- name: arangodb_process_statistics_virtual_memory_size + introducedIn: "3.6.1" + help: | + Virtual memory size. + unit: bytes + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + On Windows, this figure contains the total amount of memory that the + memory manager has committed for the arangod process. On other systems, + this figure contains the size of the virtual memory the process is + using. + +- name: arangodb_read_transactions_total + introducedIn: "3.8.2" + help: | + Number of read transactions. + unit: number + type: counter + category: Transactions + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of read-only transactions. In the cluster, this metric is + collected separately for transactions on Coordinators and the + transaction counterparts on leaders and followers. + +- name: arangodb_refused_followers_total + renamedFrom: arangodb_refused_followers_count + introducedIn: "3.8.0" + help: | + Number of refusal answers from a follower during synchronous replication. + unit: number + type: counter + category: Replication + complexity: advanced + exposedBy: + - dbserver + description: | + Number of refusal answers from a follower during synchronous replication. + A refusal answer is only sent by a follower if the follower is under + the impression that the replication request was not sent by the current + shard leader. This can happen if replication requests to the follower are + delayed or the follower is slow to process incoming requests and there was + a leader change for the shard. + If such a refusal answer is received by the shard leader, it drops the + follower from the list of followers. + This metrics was named `arangodb_refused_followers_count` in previous + versions of ArangoDB. + threshold: | + Usually, refusal answers only occur if request processing on followers is + delayed and there was a recent leadership change. This should not be a + common case and normally indicates a problem with the setup or with the load. + +- name: arangodb_replication_clients + introducedIn: "3.10.5" + help: | + Number of currently connected/active replication clients. + unit: number + type: gauge + category: Replication + complexity: medium + exposedBy: + - single + - dbserver + description: | + This metric contains the number of currently active/connected replication clients + that have started or are currently receiving data from this server for replication + purposes. + +- name: arangodb_replication_cluster_inventory_requests_total + renamedFrom: arangodb_replication_cluster_inventory_requests + introducedIn: "3.8.0" + help: | + (DC-2-DC only) Number of times the database and collection overviews have been requested. + unit: number + type: counter + category: Replication + complexity: advanced + exposedBy: + - coordinator + description: | + When using a DC-2-DC configuration of ArangoDB this metric is active on both data-centers. + It indicates that the follower data-center periodically matches the available databases and collections + in order to mirror them. If no DC-2-DC is set up this value is expected to be 0. + troubleshoot: | + If you have a DC-2-DC installation, and this metric stays constant over a longer period of time in any of the two data centers + this indicates that the follower data center is not properly connected anymore. + The issue most likely is within the sync process on either of the two data-centers as they do not compare their inventory anymore. + This gives no information about the healthiness of the ArangoDB cluster itself, please check other metrics for this. + +- name: arangodb_replication_dump_apply_time_total + renamedFrom: arangodb_replication_dump_apply_time + introducedIn: "3.8.0" + help: | + Accumulated time needed to apply asynchronously replicated data on initial synchronization of shards. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + Measures the time required to clone the existing leader copy of the data onto a new replica shard. + It is only measured on the follower server. This time is expected to increase whenever new followers + are created, e.g. increasing replication factor, shard redistribution. + troubleshoot: | + This metric measures as typical operation to keep the cluster resilient, so no reaction is required. + In a stable cluster situation (no outages, no collection modification) this metric should also be stable. + +- name: arangodb_replication_dump_bytes_received_total + renamedFrom: arangodb_replication_dump_bytes_received + introducedIn: "3.8.0" + help: | + Total number of bytes replicated in initial asynchronous phase. + unit: bytes + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + During initial replication the existing data from the leader is copied asynchronously + over to new shards. The amount of requests required to transport data to this server, + as a replica for a shard, is counted here. + +- name: arangodb_replication_dump_documents_total + renamedFrom: arangodb_replication_dump_documents + introducedIn: "3.8.0" + help: | + Total number of documents replicated in initial asynchronous phase. + unit: number + type: counter + category: Replication + complexity: simple + exposedBy: + - dbserver + description: | + During initial replication the existing data from the leader is copied asynchronously + over to new shards. The amount of documents transported to this server, as a replica for + a shard, is counted here. + +- name: arangodb_replication_dump_request_time_total + renamedFrom: arangodb_replication_dump_request_time + introducedIn: "3.8.0" + help: | + Accumulated wait time for replication requests in initial asynchronous phase. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + During initial replication the existing data from the leader is copied asynchronously + over to new shards. The accumulated time the follower waited for the leader to send + the data is counted here. + +- name: arangodb_replication_dump_requests_total + renamedFrom: arangodb_replication_dump_requests + introducedIn: "3.8.0" + help: | + Number of requests used in initial asynchronous replication phase. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + During initial replication the existing data from the leader is copied asynchronously + over to new shards. The amount of data transported to this server, as a replica for + a shard, is counted here. + +- name: arangodb_replication_failed_connects_total + renamedFrom: arangodb_replication_failed_connects + introducedIn: "3.8.0" + help: | + Number of failed connection attempts and response errors during initial + asynchronous replication. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + During initial replication the existing data from the leader is copied asynchronously + over to new shards. Whenever there is a communication issue between the follower and + the leader of the shard, it is counted here for the follower. This communication + issues cover failed connections or http errors, but they also cover invalid or + unexpected data formats received on the follower. + threshold: | + In ideal situation this counter should be 0. It is expected to increase if there is + server or network outage. However it is not guaranteed that this metric increases + in such a situation. + troubleshoot: | + If this counter increases this typically indicates an issue with the communication + between servers. If it is just occasionally an increase of one, it can be a simple + network hiccup, if you see constant increases here that indicates serious issues. + This also indicates that there is a shard trying to get into sync with the existing + data, which cannot make progress. So you have only replicationFactor - 1 copies of + the data right now. If more servers suffer outage you may lose data in this case. + * First thing to check: Network connectivity, make sure all servers are online + and the machines can communicate to one-another. + * Second: Check ArangoDB logs of this server for more details, most likely + you see `WARN` or `ERROR` messages in the `replication` log topic. If you contact + ArangoDB support for this issue, it helps to include these servers logs as well. + * Third: (Unlikely) If the logs contain unexpected format or value entries + please check if you are running all ArangoDB DB-Servers within the same + version of ArangoDB. Only upgrades of one minor version at a time are supported + in general, so if you are running one server with a much newer / older version + please upgrade all servers to the newest version. + * Forth: If none of the above applies, please contact ArangoDB Support. + +- name: arangodb_replication_initial_chunks_requests_time_total + renamedFrom: arangodb_replication_initial_chunks_requests_time + introducedIn: "3.8.0" + help: | + Accumulated wait time for replication key chunks determination requests. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the accumulated wait time for replication key + chunks determination requests, in milliseconds. This is part of the + older (pre 3.8) initial replication protocol, which might still be used + in 3.8 for collections which have been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the time used for the initial step of getting + the checksums for the key chunks. + +- name: arangodb_replication_initial_docs_requests_time_total + renamedFrom: arangodb_replication_initial_docs_requests_time + introducedIn: "3.8.0" + help: | + Accumulated time needed to request replication docs data. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the accumulated wait time for requesting actual + documents for the initial replication, in milliseconds. This is part + of the older (pre 3.8) initial replication protocol, which might + still be used in 3.8 for collections which have been created by older + versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the time used for the final step of actually + getting the needed documents. + +- name: arangodb_replication_initial_insert_apply_time_total + renamedFrom: arangodb_replication_initial_insert_apply_time + introducedIn: "3.8.0" + help: | + Accumulated time needed to apply replication initial sync insertions. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + Accumulated time needed to apply replication initial sync insertions. + This counter exhibits the accumulated wait time for actually inserting + documents for the initial synchronization, in milliseconds. This is + part of the older (pre 3.8) initial replication protocol, which might + still be used in 3.8 for collections which have been created by older + versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the time used for the actual insertion of + replicated documents on the follower. + +- name: arangodb_replication_initial_keys_requests_time_total + renamedFrom: arangodb_replication_initial_keys_requests_time + introducedIn: "3.8.0" + help: | + Accumulated wait time for replication keys requests. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the accumulated wait time for fetching key + lists for a chunk, in milliseconds. This is part of the + older (pre 3.8) initial replication protocol, which might still be used + in 3.8 for collections which have been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the time used for the second step of getting + lists of key/revision pairs for each chunk. + +- name: arangodb_replication_initial_remove_apply_time_total + renamedFrom: arangodb_replication_initial_remove_apply_time + introducedIn: "3.8.0" + help: | + Accumulated time needed to apply replication initial sync removals. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the accumulated wait time for removing local + documents during initial synchronization of a shard on the follower, + in milliseconds. This is part of the older (pre 3.8) initial + replication protocol, which might still be used in 3.8 for collections + which have been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the time used for the intermediate step of + removing unneeded documents on the follower. + +- name: arangodb_replication_initial_sync_bytes_received_total + renamedFrom: arangodb_replication_initial_sync_bytes_received + introducedIn: "3.8.0" + help: | + Accumulated amount of bytes received in initial sync. + unit: bytes + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the accumulated number of bytes received + for initial synchronization of shards. This is part of the + older (pre 3.8) initial replication protocol, which might still be used + in 3.8 for collections which have been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates number of bytes received for all three steps. + +- name: arangodb_replication_initial_sync_docs_inserted_total + renamedFrom: arangodb_replication_initial_sync_docs_inserted + introducedIn: "3.8.0" + help: | + Number of documents inserted by replication initial sync. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the total number of documents inserted on the + follower during initial synchronization of shards. This is part of the + older (pre 3.8) initial replication protocol, which might still be + used in 3.8 for collections which have been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the total number of documents inserted in the + third step. + +- name: arangodb_replication_initial_sync_docs_removed_total + renamedFrom: arangodb_replication_initial_sync_docs_removed + introducedIn: "3.8.0" + help: | + Number of documents removed by replication initial sync. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the total number of documents removed on the + follower during initial synchronization of shards. This is part of the + older (pre 3.8) initial replication protocol, which might still be + used in 3.8 for collections which have been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the total number of documents removed in the + third step. + +- name: arangodb_replication_initial_sync_docs_requested_total + renamedFrom: arangodb_replication_initial_sync_docs_requested + introducedIn: "3.8.0" + help: | + Number of documents requested by replication initial sync. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the total number of documents fetched on the + follower from the leader during initial synchronization of shards. + This is part of the older (pre 3.8) initial replication protocol, + which might still be used in 3.8 for collections which have been + created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the total number of documents fetched from the + leader in the third step. + +- name: arangodb_replication_initial_sync_docs_requests_total + renamedFrom: arangodb_replication_initial_sync_docs_requests + introducedIn: "3.8.0" + help: | + Number of replication initial sync docs requests. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the total number of times documents have been + fetched on the follower from the leader during initial synchronization + of shards. This is part of the older (pre 3.8) initial replication + protocol, which might still be used in 3.8 for collections which have + been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric accumulates the total number of times documents have been + fetched from the leader in the third step. + +- name: arangodb_replication_initial_sync_keys_requests_total + renamedFrom: arangodb_replication_initial_sync_keys_requests + introducedIn: "3.8.0" + help: | + Number of replication initial sync keys requests. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + This counter exhibits the accumulated number of keys requests for + initial synchronization of shards. This is part of the + older (pre 3.8) initial replication protocol, which might still be used + in 3.8 for collections which have been created by older versions. + + In this older protocol, the follower first fetches an overview over + a shard from the leader. This does a full collection scan and + divides the primary keys in the collection into equal sized chunks. + Then, a checksum for each chunk is returned. The same is then done + on the follower and the checksums are compared, chunk by chunk. For + each chunk, for which the checksums do not match, the list of keys and + revisions is fetched from the leader. This then enables the follower + to fetch the actually needed documents and remove superfluous ones + locally. + + This metric counts the number of times the follower fetches a list of + keys for some chunk. + +- name: arangodb_replication_synchronous_requests_total_number_total + renamedFrom: arangodb_replication_synchronous_requests_total_number + introducedIn: "3.8.0" + help: | + Total number of synchronous replication requests. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + The total amount of all synchronous replication operation requests + between DB-Servers being done. + +- name: arangodb_replication_synchronous_requests_total_time_total + renamedFrom: arangodb_replication_synchronous_requests_total_time + introducedIn: "3.8.0" + help: | + Total time needed for all synchronous replication requests. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + The total time needed for all synchronous replication requests + between DB-Servers being done. + +- name: arangodb_replication_tailing_apply_time_total + renamedFrom: arangodb_replication_tailing_apply_time + introducedIn: "3.8.0" + help: | + Accumulated time needed to apply replication tailing data. + unit: ms + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + The accumulated time needed to locally process the continuous + replication log on a follower received from a replication + leader. + troubleshoot: | + If you see unusual spikes here, the follower might not have enough + IO bandwidth or might be overloaded. Try to provision more IOPS or + more CPU capacity. Additionally, it could make sense to compare the + value with all other available follower DB-Servers to detect potential + differences. + +- name: arangodb_replication_tailing_bytes_received_total + renamedFrom: arangodb_replication_tailing_bytes_received + introducedIn: "3.8.0" + help: | + Accumulated number of bytes received for replication tailing requests. + unit: bytes + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: + The accumulated number of bytes received from a leader for replication + tailing requests. The higher the amount of bytes is, the more data + is being processed afterwards on the follower DB-Server. + troubleshoot: + Compare this metric with all other related participating follower + DB-Servers. If the given value on a DB-Server is considerable higher, + you might want to think about rebalancing your data as the overall + work might not be evenly distributed. + +- name: arangodb_replication_tailing_documents_total + renamedFrom: arangodb_replication_tailing_documents + introducedIn: "3.8.0" + help: | + Accumulated number of replication tailing document inserts/replaces processed. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: + The accumulated number of replication tailing document inserts/replaces + processed on a follower. + troubleshoot: + Compare this metric with all other related participating follower + DB-Servers. If the given value on a DB-Server is considerable higher, + you might want to think about rebalancing your data as the overall + work might not be evenly distributed. It is important to understand + that this metric only enumerates the amount of documents and does not + compare document sizes. Even if values compared to other DB-Servers + may vary, work load could be fine. Therefore also check the metric + arangodb_replication_tailing_bytes_received_total to have an overall + and more precise picture. + +- name: arangodb_replication_tailing_follow_tick_failures_total + renamedFrom: arangodb_replication_tailing_follow_tick_failures + introducedIn: "3.8.0" + help: | + Number of replication tailing failures due to missing tick on leader. + unit: number + type: counter + category: Replication + complexity: advanced + exposedBy: + - dbserver + description: | + The number of replication tailing failures due to missing tick on leader. + troubleshoot: + If this is non-zero, action is required. A required follower tick is not present (potentially + removed) on a leader DB-Server. Please check the related leader DB-Server + log-files to identify the origin of the cause. It may be required to do + a full re-sync and/or increase the number of historic logfiles on the + leader(s). + +- name: arangodb_replication_tailing_markers_total + renamedFrom: arangodb_replication_tailing_markers + introducedIn: "3.8.0" + help: | + Number of replication tailing markers processed. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + The number of replication tailing markers processed on a follower + DB-Server. Markers are specific operations which are part of the + write-ahead log (WAL). Example actions which are being used in + markers: Create or drop a database. Create, drop, rename, change + or truncate a collection. Create or drop an index. Create, drop, + change a view. Start, commit or abort a transaction. + +- name: arangodb_replication_tailing_removals_total + renamedFrom: arangodb_replication_tailing_removals + introducedIn: "3.8.0" + help: | + Number of replication tailing document removals processed. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + The amount of document removal based marker operations on a + follower DB-Server. + +- name: arangodb_replication_tailing_request_time_total + renamedFrom: arangodb_replication_tailing_request_time + introducedIn: "3.8.0" + help: | + Aggregated wait time for replication tailing requests. + unit: ms + type: counter + category: Replication + complexity: advanced + exposedBy: + - dbserver + description: | + Aggregated wait time for replication tailing requests. + troubleshoot: + If you see unusual spikes here, please inspect potential + network issues. It may help to increase network bandwidth + and/or reduce network latency. In case there are no network + issues, also check the load of the serving leader DB-Server, + as well as the follower DB-Server, as they could potentially + be overloaded and reaching hardware-based limits. + +- name: arangodb_replication_tailing_requests_total + renamedFrom: arangodb_replication_tailing_requests + introducedIn: "3.8.0" + help: | + Number of replication tailing requests. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + The total amount of network replication tailing requests. + +- name: arangodb_request_body_size_http1 + introducedIn: "3.7.15" + help: | + Body size in bytes for HTTP/1.1 requests. + unit: bytes + type: histogram + category: Statistics + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the body sizes of the received HTTP/1.1 requests in bytes. + Note that this does not account for the header. + +- name: arangodb_request_body_size_http2 + introducedIn: "3.7.15" + help: | + Body size in bytes for HTTP/2 requests. + unit: bytes + type: histogram + category: Statistics + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the body sizes of the received HTTP/2 requests in bytes. + Note that this does not account for the header. + +- name: arangodb_request_body_size_vst + introducedIn: "3.7.15" + help: | + Body size in bytes for VST requests. + unit: bytes + type: histogram + category: Statistics + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Histogram of the body sizes of the received VST requests in bytes. + Note that this does include the binary header. + +- name: arangodb_revision_tree_hibernations_total + introducedIn: "3.8.5" + help: | + Number of revision tree hibernations. + unit: number + type: counter + category: Replication + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + The revision trees of collections/shards are normally present + in RAM in an uncompressed state. However, to reduce the memory + usage of keeping all revision trees in RAM at the same time, + revision trees can be put into "hibernation" mode. Any inactive + revision tree is automatically hibernated by ArangoDB after + a while. For the hibernation step, a revision tree is + compressed in RAM, and only the compressed version is then kept. + Later accesses of a compressed revision tree require uncompressing + the tree again. + This metric is increased whenever a revision tree is hibernated. + This can happened many times during the lifetime of a revision tree. + +- name: arangodb_revision_tree_memory_usage + introducedIn: "3.8.5" + help: | + Total memory usage of all revision trees (both hibernated and uncompressed). + unit: bytes + type: gauge + category: Replication + complexity: simple + exposedBy: + - dbserver + - agent + - single + description: | + Total memory usage of all revision trees for collections/shards. + The revision trees of collections/shards are normally present + in RAM in an uncompressed state. However, to reduce the memory + usage of keeping all revision trees in RAM at the same time, + revision trees can be put into "hibernation" mode. Any inactive + revision tree is automatically hibernated by ArangoDB after + a while. For the hibernation step, a revision tree is + compressed in RAM, and only the compressed version is then kept. + Later accesses of a compressed revision tree require uncompressing + the tree again. + This metrics reports the total memory usage of all revision trees, + including both the hibernated and uncompressed forms). + +- name: arangodb_revision_tree_rebuilds_failure_total + introducedIn: "3.8.2" + help: | + Number of failed revision tree rebuilds. + unit: number + type: counter + category: Replication + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + Number of failed background revision tree rebuilds. + Ideally this value stays at 0, because if a revision tree rebuild + fails, the system may stall and not be able to make progress in + terms of WAL file collection. When the counter increases, + an error message is also logged to the server logfile. + +- name: arangodb_revision_tree_rebuilds_success_total + introducedIn: "3.8.2" + help: | + Number of successful revision tree rebuilds. + unit: number + type: counter + category: Replication + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + Number of successful background revision tree rebuilds. + Ideally this value stays at 0, because a revision tree rebuild + indicates a problem with a collection/shard's revision tree that + has happened before. + +- name: arangodb_revision_tree_resurrections_total + introducedIn: "3.8.5" + help: | + Number of revision tree resurrections. + unit: number + type: counter + category: Replication + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + The revision trees of collections/shards are normally present + in RAM in an uncompressed state. However, to reduce the memory + usage of keeping all revision trees in RAM at the same time, + revision trees can be put into "hibernation" mode. Any inactive + revision tree is automatically hibernated by ArangoDB after + a while. For the hibernation step, a revision tree is + compressed in RAM, and only the compressed version is then kept. + Later accesses of a compressed revision tree require uncompressing + the tree again. + This metric is increased whenever a revision tree is restored from + its hibernated state back into an uncompressed form in RAM. + This can happened many times during the lifetime of a revision tree. + +- name: arangodb_rocksdb_write_stalls_total + renamedFrom: rocksdb_write_stalls + introducedIn: "3.8.0" + help: | + Number of times RocksDB has entered a stalled (slowed) write state. + unit: number + type: counter + category: RocksDB + complexity: simple + exposedBy: + - dbserver + - agent + - single + description: | + This counter reflects the number of times RocksDB was observed by + ArangoDB to have entered a stalled (slowed) write state. + + If the RocksDB background threads which do cleanup and compaction + cannot keep up with the writing, then RocksDB first throttles its + write rate ("write stall") and later stops the writing entirely + ("write stop"). Both are suboptimal, since the write rate is too high. + threshold: | + If this number grows, you are probably writing faster to ArangoDB than + RocksDB can keep up with its background processing. This is OK for + a while, but might eventually lead to actual write stops, which are + bad since they can lead to unavailability. + troubleshoot: | + Quite often, RocksDB is limited by the available I/O bandwidth. Sometimes, + it is not the bandwidth itself, but the number of I/O operations per + second (IOPS) which is limited. If you are in a cloud environment, + IOPS are often scarce (or expensive) and you might be able to + deploy more. + +- name: arangodb_rocksdb_write_stops_total + renamedFrom: rocksdb_write_stops + introducedIn: "3.8.0" + help: | + Number of times RocksDB has entered a stopped write state. + unit: number + type: counter + category: RocksDB + complexity: simple + exposedBy: + - dbserver + - agent + - single + description: | + This counter reflects the number of times RocksDB was observed by + ArangoDB to have entered a stopped write state. + + If the RocksDB background threads which do cleanup and compaction + cannot keep up with the writing, then RocksDB first throttles its + write rate ("write stall") and later stops the writing entirely + ("write stop"). Both are suboptimal, since the write rate is too high, + but write stops are considerably worse, since they can lead to service + unavailability. + threshold: | + If this number grows, you are probably writing a lot faster to + ArangoDB than RocksDB can keep up with its background processing. + This has lead to actual write stops, which are bad since they can lead + to unavailability. If you see this number grow, you need to act, + if in doubt, contact ArangoDB support. + troubleshoot: | + Quite often, RocksDB is limited by the available I/O bandwidth. Sometimes, + it is not the bandwidth itself, but the number of I/O operations per + second (IOPS) which is limited. If you are in a cloud environment, + IOPS are often scarce (or expensive) and you might be able to + deploy more. + +- name: arangodb_scheduler_handler_tasks_created_total + introducedIn: "3.8.2" + help: | + Total number of REST handler tasks created for the scheduler. + unit: number + type: counter + category: Scheduler + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of REST handler tasks that were created for execution + via the scheduler. This counter is increased for each incoming + request for which a REST handler mapping exists and that does not + need to be forwarded to another Coordinator in the cluster. + +- name: arangodb_scheduler_high_prio_queue_length + introducedIn: "3.8.0" + help: | + Current queue length of the high priority queue in the scheduler. + unit: number + type: gauge + category: Scheduler + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of jobs currently queued on the scheduler's high priority queue. + The capacity of the high priority queue can be configured via the startup + option `--server.prio1-size`. + +- name: arangodb_scheduler_jobs_dequeued_total + introducedIn: "3.8.0" + help: | + Total number of jobs dequeued. + unit: number + type: counter + category: Scheduler + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The total number of jobs dequeued from all scheduler queues. + Calculating the difference between arangodb_scheduler_jobs_submitted_total + and arangodb_scheduler_jobs_dequeued_total gives the total number of + currently queued jobs. + Calculating the difference between arangodb_scheduler_jobs_dequeued_total + and arangodb_scheduler_jobs_done_total gives the number of jobs currently + being processed. + +- name: arangodb_scheduler_jobs_done_total + introducedIn: "3.8.0" + help: | + Total number of queue jobs done. + unit: number + type: gauge + category: Scheduler + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The total number of queue jobs done. + Calculating the difference between arangodb_scheduler_jobs_dequeued_total + and arangodb_scheduler_jobs_done_total gives the total number of jobs + currently being processed. + +- name: arangodb_scheduler_jobs_submitted_total + introducedIn: "3.8.0" + help: | + Total number of jobs submitted to the scheduler. + unit: number + type: gauge + category: Scheduler + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of jobs submitted to the scheduler. + Calculating the difference between arangodb_scheduler_jobs_submitted_total + and arangodb_scheduler_jobs_dequeued_total gives the total number of + currently queued jobs. + +- name: arangodb_scheduler_low_prio_queue_last_dequeue_time + introducedIn: "3.8.0" + help: | + Last recorded dequeue time for a low priority queue item. + unit: ms + type: gauge + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Last recorded dequeue time for a low priority queue item, i.e., the amount of + time the job was sitting in the queue. If there is nothing to do for a long + time, this metric is reset to zero. + A large value for this metric indicates that the server is under heavy load + and low priority jobs cannot be dequeued in a timely manner + threshold: Normally this time should be clearly sub-second. + troubleshoot: If you see larger values here, in particular over a longer period + of time, you should consider reducing the load of the server (if possible), + scaling up (bigger machine) or scaling out (more Coordinators). Otherwise + requests cannot be processed in a timely manner and you run the risk that the + queue becomes full and requests are declined. + +- name: arangodb_scheduler_low_prio_queue_length + introducedIn: "3.8.0" + help: | + Current queue length of the low priority queue in the scheduler. + unit: number + type: gauge + category: Scheduler + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of jobs currently queued on the scheduler's low priority queue. + The capacity of the low priority queue can be configured via the startup + option `--server.maximal-queue-size`. + +- name: arangodb_scheduler_maintenance_prio_queue_length + introducedIn: "3.8.0" + help: | + Current queue length of the maintenance priority queue in the scheduler. + unit: number + type: gauge + category: Scheduler + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of jobs currently queued on the scheduler's maintenance priority + queue. These are the jobs with the highest priority and are mainly used for + cluster internal operations. The capacity of the maintenance priority queue + can be configured via the startup option `--server.scheduler-queue-size`. + +- name: arangodb_scheduler_medium_prio_queue_length + introducedIn: "3.8.0" + help: | + Current queue length of the medium priority queue in the scheduler. + unit: number + type: gauge + category: Scheduler + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of jobs currently queued on the scheduler's medium priority queue. + The capacity of the medium priority queue can be configured via the startup + option `--server.prio2-size`. + +- name: arangodb_scheduler_num_awake_threads + renamedFrom: arangodb_scheduler_awake_threads + introducedIn: "3.8.0" + help: | + Number of awake worker threads. + unit: number + type: gauge + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of worker threads currently working on some job or spinning while + waiting for new work (i.e., not sleeping). + +- name: arangodb_scheduler_num_worker_threads + introducedIn: "3.6.7" + help: | + Current number of worker threads. + unit: number + type: gauge + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The number of worker threads currently started. Worker threads can be started + and stopped dynamically based on the server load. + +- name: arangodb_scheduler_num_working_threads + introducedIn: "3.6.10" + help: | + Current number of working threads. + unit: number + type: gauge + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The current number of threads actually working on some job (i.e., not + spinning while waiting for new work). + +- name: arangodb_scheduler_ongoing_low_prio + introducedIn: "3.8.0" + help: | + Total number of ongoing RestHandlers coming from the low priority queue. + unit: number + type: gauge + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of low priority jobs currently being processed. + +- name: arangodb_scheduler_queue_full_failures_total + renamedFrom: arangodb_scheduler_queue_full_failures + introducedIn: "3.8.0" + help: | + Number of tasks dropped and not added to internal queue. + unit: number + type: counter + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Number of tasks dropped because the queue was already full. The queue capacities + can be configured via the startup options `--server.scheduler-queue-size`, + `--server.prio1-size`, `--server.prio2-size` and `--server.maximal-queue-size`. + +- name: arangodb_scheduler_queue_length + introducedIn: "3.6.7" + help: | + Server's internal queue length. + unit: number + type: gauge + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + The total number of currently queued jobs in all queues. + +- name: arangodb_scheduler_queue_time_violations_total + introducedIn: "3.9.0" + help: | + Number of tasks/requests dropped and not added to internal queue + due to the client-specified queue time requirements not being + satisfiable. + unit: number + type: counter + category: Scheduler + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Number of tasks/requests dropped because the client-specified queue time + requirements, as indicated by client applications in the + `x-arango-queue-time-seconds` HTTP request header could not be satisfied by + the receiving server instance. This happens when the actual time needed to + queue/dequeue requests on the scheduler queue exceeds the maximum time value + that the client has specified in the request. + Whenever this happens, the client application gets an HTTP 412 error + response back with error code 21004 ("queue time violated"). + Although the metric is exposed on all instance types, it is likely + always `0` on DB-Servers, simply because Coordinators do not forward the + `x-arango-queue-time-seconds` when they send internal requests to DB-Servers. + +- name: arangodb_scheduler_threads_started_total + renamedFrom: arangodb_scheduler_threads_started + introducedIn: "3.8.0" + help: | + Total accumulated number of scheduler threads started. + unit: number + type: counter + category: Scheduler + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total accumulated number of scheduler threads started. Worker threads can be + started and stopped dynamically based on the server load. + +- name: arangodb_scheduler_threads_stopped_total + renamedFrom: arangodb_scheduler_threads_stopped + introducedIn: "3.8.0" + help: | + Accumulated total number of scheduler threads stopped. + unit: number + type: counter + category: Scheduler + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total accumulated number of scheduler threads stopped. Worker threads can be + started and stopped dynamically based on the server load. + +- name: arangodb_search_cleanup_time + introducedIn: "3.10.0" + help: | + Average time of few last cleanups. + unit: ms + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Average time of few last cleanups. + +- name: arangodb_search_columns_cache_size + introducedIn: "3.9.5" + help: | + ArangoSearch columns cache usage. + unit: bytes + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Size of all ArangoSearch columns currently loaded into the cache. + troubleshoot: | + If this metric contains a value close to configured + `--arangosearch.columns-cache-limit`, there might be columns + that are marked to be cached but do not fit into the cache. + That may result in query performance degradation. Check the + log for pattern "Failed to allocate memory for buffered column" + +- name: arangodb_search_commit_time + introducedIn: "3.10.0" + help: | + Average time of few last commits. + unit: ms + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Average time of few last commits. + +- name: arangodb_search_consolidation_time + introducedIn: "3.10.0" + help: | + Average time of few last consolidations. + unit: ms + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Average time of few last consolidations. + +- name: arangodb_search_index_size + introducedIn: "3.10.0" + help: | + Size of the index in bytes for current snapshot. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Size of the index in bytes for current snapshot. + +- name: arangodb_search_num_docs + introducedIn: "3.10.0" + help: | + Number of documents for current snapshot. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of documents for current snapshot. + +- name: arangodb_search_num_failed_cleanups + introducedIn: "3.10.0" + help: | + Number of failed cleanups. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of failed cleanups. + +- name: arangodb_search_num_failed_commits + introducedIn: "3.10.0" + help: | + Number of failed commits. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of failed commits. + +- name: arangodb_search_num_failed_consolidations + introducedIn: "3.10.0" + help: | + Number of failed consolidations. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of failed consolidations. + +- name: arangodb_search_num_files + introducedIn: "3.10.0" + help: | + Number of files for current snapshot. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of files for current snapshot. + +- name: arangodb_search_num_live_docs + introducedIn: "3.10.0" + help: | + Number of live documents for current snapshot. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of live documents for current snapshot. + +- name: arangodb_search_num_out_of_sync_links + introducedIn: "3.9.4" + help: | + Number of out-of-sync arangosearch links/inverted indexes. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of `arangosearch` View links and inverted indexes that are + currently out of sync. A link or inverted index is out of sync + if the recovery for it is intentionally skipped or a commit + operation on the link/index has failed. + troubleshoot: | + If this metric contains a value greater than zero, the + log files should be checked to find out which links/indexes + are affected. The out-of-sync links/indexes should then + be dropped and recreated. + +- name: arangodb_search_num_segments + introducedIn: "3.10.0" + help: | + Number of segments for current snapshot. + unit: number + type: gauge + category: ArangoSearch + complexity: advanced + exposedBy: + - dbserver + - single + description: | + Number of segments for current snapshot. + +- name: arangodb_server_statistics_cpu_cores + introducedIn: "3.8.0" + help: | + Number of CPU cores visible to the arangod process. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Number of CPU cores visible to the arangod process, unless the + environment variable `ARANGODB_OVERRIDE_DETECTED_NUMBER_OF_CORES` + is set. In that case, the environment variable's value is reported. + +- name: arangodb_server_statistics_idle_percent + introducedIn: "3.8.0" + help: | + Percentage of time that the system CPUs have been idle. + unit: percentage + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Percentage of time that the system CPUs have been idle, as + a value between `0` and `100`, and as reported by the operating system. + This metric is only reported on some operating systems. + +- name: arangodb_server_statistics_iowait_percent + introducedIn: "3.8.0" + help: | + Percentage of time that the system CPUs have been waiting for I/O. + unit: percentage + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Percentage of time that the system CPUs have been waiting for I/O, as + a value between `0` and `100`, and as reported by the operating system. + This metric is only reported on some operating systems. + +- name: arangodb_server_statistics_physical_memory + introducedIn: "3.6.7" + help: | + Physical memory in bytes. + unit: bytes + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Physical memory of the system in bytes, as reported by the operating system + unless the environment variable `ARANGODB_OVERRIDE_DETECTED_TOTAL_MEMORY` + is set. In that case, the environment variable's value is reported. + +- name: arangodb_server_statistics_server_uptime_total + renamedFrom: arangodb_server_statistics_server_uptime + introducedIn: "3.8.0" + help: | + Number of seconds elapsed since server start. + unit: s + type: counter + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Number of seconds elapsed since server start, including fractional + seconds. + This metric was named `arangodb_server_statistics_server_uptime` + in previous versions of ArangoDB. + +- name: arangodb_server_statistics_system_percent + introducedIn: "3.8.0" + help: | + Percentage of time that the system CPUs have spent in kernel mode. + unit: percentage + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Percentage of time that the system CPUs have spent in kernel mode, as + a value between `0` and `100`, and as reported by the operating system. + This metric is only reported on some operating systems. + +- name: arangodb_server_statistics_user_percent + introducedIn: "3.8.0" + help: | + Percentage of time that the system CPUs have spent in user mode. + unit: percentage + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Percentage of time that the system CPUs have spent in user mode, as + a value between `0` and `100`, and as reported by the operating system. + This metric is only reported on some operating systems. + +- name: arangodb_shards_leader_number + renamedFrom: arangodb_shards_leader_count + introducedIn: "3.8.0" + help: | + Number of leader shards on this machine. + unit: number + type: gauge + category: Replication + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + description: | + Number of leader shards on this machine. Every shard has a leader and + potentially multiple followers. + troubleshoot: | + Since the leaders perform all the read and write operations and + the followers only replicate the writes, one should usually have a + relatively even distribution of leader shards across DB-Servers. An + exception can be one-shard deployments, in which every collection has + a single shard and all shards in a database must have the same leader. + If you have few databases in a one-shard deployment, then an uneven + distribution of leader shards is natural. + + You can either move shards manually, use the **Rebalance shards** button + in the ArangoDB web interface, or use the + [cluster maintenance tools](https://github.com/arangodb/cluster-maintenance) + (`create-move-plan` and `execute-move-plan` specifically). In the latter + case, contact ArangoDB customer support. + +- name: arangodb_shards_not_replicated + introducedIn: "3.7.1" + help: | + Number of shards not replicated at all. + unit: number + type: gauge + category: Replication + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + description: | + Number of shards not replicated at all. This is counted for all shards + for which this server is currently the leader. The number is increased + by one for every shards for which no follower is in sync. + troubleshoot: | + Needless to say, such a situation is very bad for resilience, since it + indicates a single point of failure. So, if this number is greater than 0, + then some action is indicated. During an upgrade or when some DB-Server + was restarted, it can happen that shard followers are out of sync. + Normally, shards should get in sync on their own, so observation + and waiting is a good measure at first. However, if the situation + persists, something is wrong, potentially some constant server crash + (maybe out of memory crashes?) or another situation preventing + shards to get in sync. Contact ArangoDB customer support in this case. + +- name: arangodb_shards_number + renamedFrom: arangodb_shards_total_count + introducedIn: "3.8.0" + help: | + Number of shards on this machine. + unit: number + type: gauge + category: Replication + complexity: simple + exposedBy: + - dbserver + description: | + Number of shards on this machine. Every shard has a leader and + potentially multiple followers. This metric counts both leader and + follower shards. + troubleshoot: | + Since both leader and follower shards use memory and disk space, + the total number of shards should be approximately balanced + evenly across the DB-Servers. To achieve this, you can either + move shards manually, use the **Rebalance shards** button in the + ArangoDB web interface, or use the + [cluster maintenance tools](https://github.com/arangodb/cluster-maintenance) + (`create-move-plan` and `execute-move-plan` specifically). In the latter + case, contact ArangoDB customer support. + +- name: arangodb_shards_out_of_sync + introducedIn: "3.7.1" + help: | + Number of leader shards not fully replicated. + unit: number + type: gauge + category: Replication + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + description: | + Number of leader shards not fully replicated. This is counted for all + shards for which this server is currently the leader. The number is + increased by one for every shards for which not all followers are in sync. + troubleshoot: | + Needless to say, such a situation is not good resilience, since we + do not have as many copies of the data as the `replicationFactor` + prescribes. If this metrics has a value greater than 0, then some + action is indicated. During an upgrade or when some DB-Server was + restarted, it can happen that shard followers are out of sync. + Normally, shards should get in sync on their own, so observation + and waiting is a good measure at first. However, if the situation + persists, something is wrong, potentially some constant server crash + (maybe out of memory crashes?) or another situation preventing shards + to get in sync. Contact ArangoDB customer support in this case. + +- name: arangodb_sync_rebuilds_total + introducedIn: "3.8.0" + help: | + Number of times a follower shard needed to be completely rebuilt because of + too many synchronization failures. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + - single + description: | + Number of times a follower shard needed to be completely rebuilt + because of too many subsequent shard synchronization failures. + This metric is always zero from version 3.9.3 onwards. In previous + releases, a non-zero value indicates that a follower shard could + not get in sync with the leader even after many attempts. When + the metric got increased, the follower shard was dropped and + completely rebuilt from leader data, in order to increase its + chances of getting in sync. + troubleshoot: | + This number is always `0` from version 3.9.3 onwards. If it is + non-zero in previous versions, then something is wrong, please + contact ArangoDB customer support in this case. + +- name: arangodb_sync_timeouts_total + introducedIn: "3.9.2" + help: | + Number of times the synchronization of a follower shard synchronization + attempt ran into a timeout. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + description: | + Number of times a follower shard synchronization attempt ran into the + timeout controlled by the startup option `--cluster.shard-synchronization-attempt-timeout`. + Running into this timeout is not an error. The timeout simply restricts + individual shard synchronization attempts to a certain maximum runtime. + When it happens, the shard synchronization attempt is aborted by the + follower, but immediately retried afterwards. This abort-and-retry + operation allows the leader DB-Servers to purge their archived WAL files + for the aborted snapshots timely, so that long-running shard synchronization + aborts do not lead to overly long WAL file retention periods on leaders. + +- name: arangodb_sync_tree_rebuilds_total + introducedIn: "3.10.6" + help: | + Number of times a revision tree for a shard was completely + rebuilt because of too many subsequent failures in the shard + synchronization. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + - single + description: | + Number of times a revision tree for a shard was completely + rebuilt because of too many subsequent failures in the shard + synchronization. + If shards cannot get in sync after several attempts, the shard's + revision tree is first rebuilt on the follower, and then on the + leader. If the value is greater than zero, it means there have + been shard synchronization failures. + +- name: arangodb_sync_wrong_checksum_total + renamedFrom: arangodb_sync_wrong_checksum + introducedIn: "3.8.0" + help: | + Number of times a mismatching shard checksum was detected when syncing shards. + unit: number + type: counter + category: Replication + complexity: medium + exposedBy: + - dbserver + - single + description: | + Number of times a mismatching shard checksum was detected when + syncing shards. This is a very special metric which is rarely used. + When followers of shards get in sync with their leaders, just when + everything is completed a final checksum is taken as an additional + precaution. If this checksum differs between leader an follower, the + incremental resync process starts from scratch. + troubleshoot: | + Normally, this number is always `0`. If it is not, then usually + something is wrong, please contact ArangoDB customer support in this + case. + +- name: arangodb_transactions_aborted_total + renamedFrom: arangodb_transactions_aborted + introducedIn: "3.8.0" + help: | + Number of transactions aborted. + unit: number + type: counter + category: Transactions + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of transactions aborted. In the cluster, this metric is + collected separately for transactions on Coordinators and the + transaction counterparts on leaders and followers. + This metric was named `arangodb_transactions_aborted` in previous + versions of ArangoDB. + +- name: arangodb_transactions_committed_total + renamedFrom: arangodb_transactions_committed + introducedIn: "3.8.0" + help: | + Number of transactions committed. + unit: number + type: counter + category: Transactions + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of transactions committed. In the cluster, this metric is + collected separately for transactions on Coordinators and the + transaction counterparts on leaders and followers. + This metric was named `arangodb_transactions_committed` in previous + versions of ArangoDB. + +- name: arangodb_transactions_expired_total + renamedFrom: arangodb_transactions_expired + introducedIn: "3.8.0" + help: | + Total number of expired transactions. + unit: number + type: counter + category: Transactions + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of expired transactions, i.e. transactions that have + been begun but that were automatically garbage-collected due to + inactivity within the transactions' time-to-live (TTL) period. + In the cluster, this metric is collected separately for transactions + on Coordinators and the transaction counterparts on leaders and followers. + This metric was named `arangodb_transactions_expired` in previous + versions of ArangoDB. + +- name: arangodb_transactions_started_total + renamedFrom: arangodb_transactions_started + introducedIn: "3.8.0" + help: | + Number of transactions started. + unit: number + type: counter + category: Transactions + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of transactions started/begun. In the cluster, this metric is + collected separately for transactions on Coordinators and the + transaction counterparts on leaders and followers. + This metric was named `arangodb_transactions_started` in previous + versions of ArangoDB. + +- name: arangodb_v8_context_alive + introducedIn: "3.6.7" + help: | + Number of V8 contexts currently alive. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Number of V8 contexts currently alive. Normally, only Coordinators and + single servers should have V8 contexts, for DB-Servers and Agents the + value is always zero. + threshold: | + If this number is close to the maximum allowed number of V8 contexts, + there might be a shortage. This can delay Foxx queries and AQL + user defined functions. On the other hand, V8 contexts can use + quite a lot of memory, so one should not have too many if RAM + is scarce. + +- name: arangodb_v8_context_busy + introducedIn: "3.6.7" + help: | + Number of V8 contexts currently busy. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Number of V8 contexts currently busy, that means, they are currently + working on some JavaScript task. Normally, only Coordinators and + single servers should have V8 contexts, for DB-Servers and Agents the + value is always zero. + threshold: | + If this number is close to the maximum allowed number of V8 contexts, + there might be a shortage. This can delay Foxx queries and AQL + user defined functions. On the other hand, V8 contexts can use + quite a lot of memory, so one should not have too many if RAM + is scarce. + +- name: arangodb_v8_context_created_total + renamedFrom: arangodb_v8_context_created + introducedIn: "3.8.0" + help: | + Total number of V8 contexts ever created. + unit: number + type: counter + category: V8 + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of V8 contexts ever created. It is + OK if this number keeps growing since the V8 contexts are created and + destroyed as needed. In rare cases a high fluctuation can indicate + some unfortunate usage pattern. + +- name: arangodb_v8_context_creation_time_msec_total + renamedFrom: arangodb_v8_context_creation_time_msec + introducedIn: "3.8.0" + help: | + Accumulated total time for creating V8 contexts. + unit: ms + type: counter + category: V8 + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the accumulated total time for creating V8 + contexts, in milliseconds. It is OK if this number keeps growing since + the V8 contexts are created and destroyed as needed. In rare cases a + high fluctuation can indicate some unfortunate usage pattern. + +- name: arangodb_v8_context_destroyed_total + renamedFrom: arangodb_v8_context_destroyed + introducedIn: "3.8.0" + help: | + Total number of V8 contexts ever destroyed. + unit: number + type: counter + category: V8 + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of V8 contexts ever destroyed. + It is OK if this number keeps growing since the V8 contexts are + created and destroyed as needed. In rare cases a high fluctuation can + indicate some unfortunate usage pattern. + +- name: arangodb_v8_context_dirty + introducedIn: "3.6.7" + help: | + Number of V8 contexts currently dirty. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This gauge reflects the number of V8 contexts that are currently dirty. + A V8 context is dirty, if it has executed JavaScript for some time and + is due for a garbage collection. + +- name: arangodb_v8_context_enter_failures_total + renamedFrom: arangodb_v8_context_enter_failures + introducedIn: "3.8.0" + help: | + Total number of V8 context enter failures. + unit: number + type: counter + category: V8 + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of V8 context enter failures. A context receives a context + enter event every time it begins to execute some JavaScript. If no + context is available at such a time the system waits for 60s for a + context to become free. If this does not happen within the 60s, the + context enter event fails, a warning is logged and this counter is + increased by one. + threshold: | + If you see V8 context enter failures, then you do not have enough + V8 contexts or the server is overloaded by JavaScript tasks. If some + JavaScript code blocks V8 contexts for too long, the free V8 contexts + can run out and these failures begin to happen. + +- name: arangodb_v8_context_entered_total + renamedFrom: arangodb_v8_context_entered + introducedIn: "3.8.0" + help: | + Total number of V8 context enter events. + unit: number + type: counter + category: V8 + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of V8 context enter events. A context receives a context + enter event every time it begins to execute some JavaScript. This number + is a rough estimate as to how much JavaScript the server executes. + +- name: arangodb_v8_context_exited_total + renamedFrom: arangodb_v8_context_exited + introducedIn: "3.8.0" + help: | + Total number of V8 context exit events. + unit: number + type: counter + category: V8 + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This counter reflects the total number of V8 context exit events. + A context receives a context exit event every time it finishes to + execute some JavaScript. + +- name: arangodb_v8_context_free + introducedIn: "3.6.7" + help: | + Number of V8 contexts currently free. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This gauge reflects the number of V8 contexts that are currently free. + If this number drops to `0` there might be a shortage of V8 contexts. + +- name: arangodb_v8_context_max + introducedIn: "3.6.7" + help: | + Maximum number of concurrent V8 contexts. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This is the maximum number of concurrent V8 contexts. This is limited + by a server option, since V8 contexts can use a lot of RAM. V8 contexts + are created and destroyed as needed up to the limit shown in this metric. + +- name: arangodb_v8_context_min + introducedIn: "3.6.7" + help: | + Minimum number of concurrent V8 contexts. + unit: number + type: gauge + category: Statistics + complexity: simple + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This is the minimum number of concurrent V8 contexts. This is limited + by a server option. V8 contexts are created and destroyed as needed + but there are never fewer than the limit shown in this metric. + +- name: arangodb_vst_connections_total + introducedIn: "3.7.15" + help: | + Total number of VST connections accepted. + unit: number + type: counter + category: Connectivity + complexity: medium + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + Total number of connections accepted for VST, this are upgraded + connections from HTTP/1.1. + +- name: rocksdb_actual_delayed_write_rate + introducedIn: "3.6.1" + help: | + Actual delayed RocksDB write rate. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-actual-delayed-write-rate`. + It shows the current actual delayed write rate. The value `0` means no delay. + +- name: rocksdb_archived_wal_files + introducedIn: "3.8.2" + help: | + Number of RocksDB WAL files in the archive. + unit: number + type: gauge + category: RocksDB + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the total number of RocksDB WAL files in the + "archive" subdirectory. These are WAL files that can be garbage-collected + eventually, when they are not used anymore by replication, WAL tailing + or other purposes. + +- name: rocksdb_archived_wal_files_size + introducedIn: "3.10.6" + help: | + Cumulated size of RocksDB WAL files in the archive. + unit: bytes + type: gauge + category: RocksDB + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the cumulated size of RocksDB WAL files in the + "archive" subdirectory on disk. These are WAL files that can be + garbage-collected eventually, when they are not used anymore by + replication, WAL tailing or other purposes. + +- name: rocksdb_background_errors + introducedIn: "3.6.1" + help: | + Total number of RocksDB background errors. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `background-errors`. It shows + the accumulated number of background errors. + +- name: rocksdb_base_level + introducedIn: "3.6.1" + help: | + RocksDB base level. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-base-level`. + It shows the number of the level to which L0 data is compacted. + +- name: rocksdb_block_cache_capacity + introducedIn: "3.6.1" + help: | + RocksDB block cache capacity. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-block-cache-capacity`. + It shows the block cache capacity in bytes. This can be configured with + the `--rocksdb.block-cache-size` startup option. + +- name: rocksdb_block_cache_pinned_usage + introducedIn: "3.6.1" + help: | + Size of pinned RocksDB block cache entries. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-block-cache-pinned-usage`. + It shows the memory size for the RocksDB block cache for the entries + which are pinned, in bytes. + +- name: rocksdb_block_cache_usage + introducedIn: "3.6.1" + help: | + Cumulated size of RocksDB block cache entries. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-block-cache-usage`. + It shows the total memory size for the entries residing in the block cache, + in bytes. + +- name: rocksdb_cache_active_tables + introducedIn: "3.10.0" + help: | + Global current number of hash tables in ArangoDB cache. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the current number of active hash tables used by the + in-memory cache which sits in front of RocksDB. Active tables are used for + caching index entries. There should be one active table per index per shard + for each index that has in-memory caching enabled. There can also be + additional active tables while an existing hash table is migrated to a + larger table. + +- name: rocksdb_cache_allocated + introducedIn: "3.6.1" + help: | + Global current memory allocation of ArangoDB in-memory caches. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the current global allocation for the ArangoDB + in-memory cache which sits in front of RocksDB. For example, the edge caches + counts towards this allocation. All these caches together have a + global limit which can be controlled with the `--cache.size` startup option. + +- name: rocksdb_cache_auto_refill_dropped_total + introducedIn: "3.10.2" + help: | + Total number of dropped entries in automatic in-memory edge cache refilling. + unit: number + type: counter + category: RocksDB + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This metric shows the total number of entries for which no automatic refilling + happened in the in-memory edge cache. + This counter increases only for insert, update, replace, and remove operations + affecting edge indexes and with requested automatic refilling, + if no refill operation could be queued due to capacity constraints. + A refill operation request can be rejected if the number of currently queued + refill operations exceeds the maximum value configured via the + `--rocksdb.auto-refill-index-cache-queue-capacity` startup option. + Correctness of index lookups is not affected if this metric is non-zero, as + it only reports the number of failed refilling attempts in the in-memory cache + of any edge index. This in-memory cache is optional and its fill grade does not + affect correctness. + troubleshoot: | + If this metric keeps increasing, it indicates that the index refill background + thread can't keep up with the incoming data modification requests. + In this case, consider increasing the background thread's queueing capacity via + the `--rocksdb.auto-refill-index-cache-queue-capacity` startup option. + Increasing the capacity helps to handle bursts of request, but does not help + if the background thread is overwhelmed by a continuous high load. + +- name: rocksdb_cache_auto_refill_loaded_total + introducedIn: "3.10.2" + help: | + Total number of automatically refilled in-memory edge cache entries. + unit: number + type: counter + category: RocksDB + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This metric shows the total number of automatically refilled in-memory + edge cache entries. Entries in the in-memory edge cache are automatically + refilled for edge indexes if an insert, update, replace, or remove operation + requests the cache refilling, or if the `--rocksdb.auto-refill-index-caches` + startup option is enabled. + On Agents and Coordinators, the values reported by this metric are always zero. + +- name: rocksdb_cache_full_index_refills_total + introducedIn: "3.10.2" + help: | + Total number of in-memory edge cache refill operations for a complete + edge index. + unit: number + type: counter + category: RocksDB + complexity: advanced + exposedBy: + - coordinator + - dbserver + - agent + - single + description: | + This metric shows the total number of refill operations to in-memory + edge caches for entire edge indexes. On DB-Servers, a full index reload can + increase this metric by more than one, as counting is done per shard. + On Coordinators and Agents, this metric always contains a value of zero. + +- name: rocksdb_cache_hit_rate_lifetime + introducedIn: "3.6.1" + help: | + Lifetime hit rate of the ArangoDB cache in front of RocksDB. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the lifetime hit rate of the ArangoDB in-memory + cache which is sitting in front of RocksDB. For example, the edge + cache is a part of this. The value is a ratio between `0` and `1`. + "Lifetime" means here that accounting is done from the most recent + start of the `arangod` instance. + If the hit rate is too low, you might have to little RAM available + for the in-memory caches. + +- name: rocksdb_cache_hit_rate_recent + introducedIn: "3.6.1" + help: | + Recent hit rate of the ArangoDB cache in front of RocksDB. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the recent hit rate of the ArangoDB in-memory + cache which is sitting in front of RocksDB. For example, the edge + cache is a part of this. The value is a ratio between `0` and `1`. + If the hit rate is too low, you might have to little RAM available + for the in-memory caches. + +- name: rocksdb_cache_limit + introducedIn: "3.6.1" + help: | + Global allocation limit for the ArangoDB cache in front of RocksDB. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the current global allocation limit for the + ArangoDB caches which sit in front of RocksDB. For example, the + edge cache counts towards this allocation. This global limit can + be controlled with the `--cache.size` startup option. + +- name: rocksdb_cache_peak_allocated + introducedIn: "3.10.7" + help: | + Global peak memory allocation of ArangoDB in-memory caches. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the peak global allocation for the ArangoDB + in-memory cache which sits in front of RocksDB. It records the peak value + of the metric `rocksdb_cache_allocated` during the lifetime of the + arangod instance. + +- name: rocksdb_cache_unused_memory + introducedIn: "3.10.0" + help: | + Global current memory allocation of inactive/reserve hash tables in ArangoDB cache. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the current memory allocation for unused hash tables + used by the in-memory cache which sits in front of RocksDB. Unused tables + can be kept as backups to provide new, readily initialized tables for new + caches. The overall memory usage of unused tables is capped by the system, + so it does not grow overly large. + +- name: rocksdb_cache_unused_tables + introducedIn: "3.10.0" + help: | + Global current number of inactive/reserve hash tables in ArangoDB cache. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reflects the current number of unused hash tables used by the + in-memory cache which sits in front of RocksDB. Unused tables can be kept as + backups to provide new, readily initialized tables for new caches. + Unused tables can consume some memory, but the overall memory usage of + unused tables is capped. + +- name: rocksdb_compaction_pending + introducedIn: "3.6.1" + help: | + Number of RocksDB column families with pending compaction. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `compaction-pending`. + It shows the number of column families for which at least one compaction + is pending. + +- name: rocksdb_compression_ratio_at_level0 + introducedIn: "3.6.1" + help: | + RocksDB compression ratio at level 0. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the compression ratio of data at level 0 in RocksDB's + log structured merge tree. Here, compression + ratio is defined as uncompressed data size / compressed file size. + Returns `-1.0` if there are no open files at level 0. + +- name: rocksdb_compression_ratio_at_level1 + introducedIn: "3.6.1" + help: | + RocksDB compression ratio at level 1. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the compression ratio of data at level 1 in RocksDB's + log structured merge tree. Here, compression + ratio is defined as uncompressed data size / compressed file size. + Returns `-1.0` if there are no open files at level 1. + +- name: rocksdb_compression_ratio_at_level2 + introducedIn: "3.6.1" + help: | + RocksDB compression ratio at level 2. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the compression ratio of data at level 2 in RocksDB's + log structured merge tree. Here, compression + ratio is defined as uncompressed data size / compressed file size. + Returns `-1.0` if there are no open files at level 2. + +- name: rocksdb_compression_ratio_at_level3 + introducedIn: "3.6.1" + help: | + RocksDB compression ratio at level 3. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the compression ratio of data at level 3 in RocksDB's + log structured merge tree. Here, compression + ratio is defined as uncompressed data size / compressed file size. + Returns `-1.0` if there are no open files at level 3. + +- name: rocksdb_compression_ratio_at_level4 + introducedIn: "3.6.1" + help: | + RocksDB compression ratio at level 4. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the compression ratio of data at level 4 in RocksDB's + log structured merge tree. Here, compression + ratio is defined as uncompressed data size / compressed file size. + Returns `-1.0` if there are no open files at level 4. + +- name: rocksdb_compression_ratio_at_level5 + introducedIn: "3.6.1" + help: | + RocksDB compression ratio at level 5. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the compression ratio of data at level 5 in RocksDB's + log structured merge tree. Here, compression + ratio is defined as uncompressed data size / compressed file size. + Returns `-1.0` if there are no open files at level 5. + +- name: rocksdb_compression_ratio_at_level6 + introducedIn: "3.6.1" + help: | + RocksDB compression ratio at level 6. + unit: ratio + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the compression ratio of data at level 6 in RocksDB's + log structured merge tree. Here, compression + ratio is defined as uncompressed data size / compressed file size. + Returns `-1.0` if there are no open files at level 6. + +- name: rocksdb_cur_size_active_mem_table + introducedIn: "3.6.1" + help: | + Approximate size of RocksDB's active memtable. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-cur-size-active-mem-table`. + It shows the approximate size of the active memtable in bytes, summed + over all column families. + +- name: rocksdb_cur_size_all_mem_tables + introducedIn: "3.6.1" + help: | + Approximate size of all active and unflushed RocksDB memtables. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-cur-size-all-mem-tables`. + It shows the approximate size of active and unflushed immutable memtables + in bytes, summed over all column families. + +- name: rocksdb_engine_throttle_bps + renamedFrom: rocksdbengine_throttle_bps + introducedIn: "3.8.0" + help: | + Current rate of the RocksDB throttle in bytes per second. + unit: bytes per second + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exposes the current write rate limit of the ArangoDB + RocksDB throttle. The throttle limits the write rate to allow + RocksDB's background threads to catch up with compactions and not + fall behind too much, since this would in the end lead to nasty + write stops in RocksDB and incur considerable delays. If `0` is + shown, no throttling happens, otherwise, you see the current + write rate limit in bytes per second. Also see the `--rocksdb.*` + startup options. + +- name: rocksdb_estimate_live_data_size + introducedIn: "3.6.1" + help: | + Estimated amount of live RocksDB data. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-estimate-live-data-size`. + It shows an estimate of the amount of live data in bytes, summed over + all column families. + +- name: rocksdb_estimate_num_keys + introducedIn: "3.6.1" + help: | + Estimated number of RocksDB keys. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-estimate-num-keys`. + It shows the estimated number of total keys in the active and unflushed + immutable memtables and storage, summed over all column families. + +- name: rocksdb_estimate_pending_compaction_bytes + introducedIn: "3.6.1" + help: | + Estimated number of bytes awaiting RocksDB compaction. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric + `rocksdb-estimate-pending-compaction-bytes`. + It shows the estimated total number of bytes compaction needs to + rewrite to get all levels down to under target size. Not valid for + other compactions than level-based. This value is summed over all + column families. + +- name: rocksdb_estimate_table_readers_mem + introducedIn: "3.6.1" + help: | + Estimated memory usage for reading RocksDB SST tables. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric + `rocksdb-estimate-table-readers-mem`. + It shows the estimated memory used for reading SST tables, excluding + memory used in block cache (e.g. filter and index blocks), summed over + all column families. + +- name: rocksdb_free_disk_space + introducedIn: "3.8.0" + help: | + Free disk space in bytes on volume used by RocksDB. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric shows the currently free disk space in bytes on the volume + which is used by RocksDB. Since RocksDB does not like out of disk + space scenarios, please make sure that there is enough free disk space + available at all times! Note that this metric is only available/populated on some platforms. + +- name: rocksdb_free_inodes + introducedIn: "3.8.0" + help: | + Number of free inodes on the volume used by RocksDB. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric shows the currently free number of inodes on the disk volume + used by RocksDB. Since RocksDB does not like out of disk space + scenarios, please make sure that there is enough free inodes available + at all times! Note that this metric is only available/populated on some platforms. + +- name: rocksdb_is_file_deletions_enabled + introducedIn: "3.6.1" + help: | + Whether RocksDB file deletion is enabled. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-is-file-deletions-enabled`. + It shows `0` if deletion of obsolete files is enabled, and otherwise, + it shows a non-zero number. Note that for ArangoDB, this is supposed + to always return `1`, since the deletion of obsolete WAL files is done + from ArangoDB, externally to RocksDB. + +- name: rocksdb_is_write_stopped + introducedIn: "3.6.1" + help: | + Whether RocksDB writes are stopped. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-is-write-stopped`. + It shows `1` if writing to RocksDB has been stopped, and otherwise 0. + If `1` is shown, this usually means that there are too many uncompacted + files and the RocksDB background threads have not managed to keep up + with their compaction work. This situation should be avoided, since + nasty delays in database operations are incurred. If in doubt, + contact ArangoDB support. + +- name: rocksdb_live_sst_files_size + introducedIn: "3.6.1" + help: | + Size of live RocksDB SST files. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-live-sst-files-size`. + It shows the total size in bytes of all SST files belonging to the latest + LSM tree, summed over all column families. + +- name: rocksdb_live_wal_files + introducedIn: "3.10.5" + help: | + Number of live RocksDB WAL files. + unit: number + type: gauge + category: RocksDB + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the total number of live RocksDB WAL files. These are + WAL files that cannot be garbage-collected until they are moved over to the + archive. + +- name: rocksdb_live_wal_files_size + introducedIn: "3.10.6" + help: | + Cumulated live RocksDB WAL files. + unit: bytes + type: gauge + category: RocksDB + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the cumulated size of live RocksDB WAL files on disk. + WAL files that cannot be garbage-collected until they are moved over to the + archive. + +- name: rocksdb_mem_table_flush_pending + introducedIn: "3.6.1" + help: | + Number of RocksDB column families awaiting memtable flush. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `mem-table-flush-pending`. It + shows the number of column families for which a memtable flush is + pending. + +- name: rocksdb_min_log_number_to_keep + introducedIn: "3.6.1" + help: | + Minimum number of RocksDB log files to keep. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-min-log-number-to-keep`. + It shows the minimum log number of the log files that should be kept. + +- name: rocksdb_num_deletes_active_mem_table + introducedIn: "3.6.1" + help: | + Number of deletes in active RocksDB memtable. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric + `rocksdb-num-deletes-active-mem-table`. + It shows the total number of delete entries in the active memtable, + summed over all column families. + +- name: rocksdb_num_deletes_imm_mem_tables + introducedIn: "3.6.1" + help: | + Number of deletes in unflushed immutable RocksDB memtables. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric + `rocksdb-num-deletes-imm-mem-tables`. + It shows the total number of delete entries in the unflushed immutable + memtables, summed over all column families. + +- name: rocksdb_num_entries_active_mem_table + introducedIn: "3.6.1" + help: | + Number of entries in the active RocksDB memtable. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric + `rocksdb-num-entries-active-mem-table`. + It shows the total number of entries in the active memtable, + summed over all column families. + +- name: rocksdb_num_entries_imm_mem_tables + introducedIn: "3.6.1" + help: | + Number of entries in unflushed immutable RocksDB memtables. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric + `rocksdb-num-entries-imm-mem-tables`. + It shows the total number of entries in the unflushed immutable memtables, + summed over all column families. + +- name: rocksdb_num_files_at_level0 + introducedIn: "3.6.1" + help: | + Number of RocksDB files at level 0. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of files at level 0 in the log structured + merge tree of RocksDB. + +- name: rocksdb_num_files_at_level1 + introducedIn: "3.6.1" + help: | + Number of RocksDB files at level 1. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of files at level 1 in the log structured + merge tree of RocksDB. + +- name: rocksdb_num_files_at_level2 + introducedIn: "3.6.1" + help: | + Number of RocksDB files at level 2. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of files at level 2 in the log structured + merge tree of RocksDB. + +- name: rocksdb_num_files_at_level3 + introducedIn: "3.6.1" + help: | + Number of RocksDB files at level 3. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of files at level 3 in the log structured + merge tree of RocksDB. + +- name: rocksdb_num_files_at_level4 + introducedIn: "3.6.1" + help: | + Number of RocksDB files at level 4. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of files at level 4 in the log structured + merge tree of RocksDB. + +- name: rocksdb_num_files_at_level5 + introducedIn: "3.6.1" + help: | + Number of RocksDB files at level 5. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of files at level 5 in the log structured + merge tree of RocksDB. + +- name: rocksdb_num_files_at_level6 + introducedIn: "3.6.1" + help: | + Number of RocksDB files at level 6. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of files at level 6 in the log structured + merge tree of RocksDB. + +- name: rocksdb_num_immutable_mem_table + introducedIn: "3.6.1" + help: | + Number of unflushed immutable RocksDB memtables. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `num-immutable-mem-table`, + which shows the number of immutable memtables that have not yet been + flushed. This value is the sum over all column families. + + Memtables are sorted tables of key/value pairs which begin + to be built up in memory. At some stage they are closed and become + immutable, and some time later they are flushed to disk. + +- name: rocksdb_num_immutable_mem_table_flushed + introducedIn: "3.6.1" + help: | + Number of flushed immutable RocksDB memtables. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `num-immutable-mem-table-flushed`, + which shows the number of immutable memtables that have already been + flushed. This value is the sum over all column families. + + Memtables are sorted tables of key/value pairs which begin + to be built up in memory. At some stage they are closed and become + immutable, and some time later they are flushed to disk. + +- name: rocksdb_num_live_versions + introducedIn: "3.6.1" + help: | + Number of live RocksDB versions. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-num-live-versions`. + It shows the number of live versions. `Version` is an internal data + structure. See `version_set.h` in the RocksDB source for details. More + live versions often mean more SST files are held from being deleted, + by iterators or unfinished compactions. This number is the number + summed up over all column families. + +- name: rocksdb_num_running_compactions + introducedIn: "3.6.1" + help: | + Number of running RocksDB compactions. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-num-running-compactions`. + It shows the number of currently running compactions. + +- name: rocksdb_num_running_flushes + introducedIn: "3.6.1" + help: | + Number of running RocksDB flushes. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-num-running-flushes`. + It shows the number of currently running flushes. + +- name: rocksdb_num_snapshots + introducedIn: "3.6.1" + help: | + Number of unreleased RocksDB snapshots. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-num-snapshots`. + It shows the number of unreleased snapshots of the database. + +- name: rocksdb_oldest_snapshot_time + introducedIn: "3.6.1" + help: | + Timestamp of oldest unreleased RocksDB snapshot. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-oldest-snapshot-time`. + It shows a number representing the Unix timestamp of the oldest + unreleased snapshot. + +- name: rocksdb_prunable_wal_files + introducedIn: "3.8.2" + help: | + Number of prunable RocksDB WAL files in the archive. + unit: number + type: gauge + category: RocksDB + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the total number of RocksDB WAL files in the + "archive" subdirectory that can be pruned. These are WAL files that + can be pruned by a background thread to reclaim disk space. + +- name: rocksdb_read_only + introducedIn: "3.8.1" + help: | + RocksDB metric "background-errors". + unit: number + type: gauge + category: RocksDB + complexity: simple + exposedBy: + - dbserver + - agent + - single + description: | + This metric indicates whether RocksDB currently is in read-only + mode, due to a background error. If RocksDB is in read-only mode, + this metric has a value of `1`. When in read-only mode, all + writes into RocksDB fail. When RocksDB is in normal operations + mode, this metric has a value of `0`. + troubleshoot: | + If this value is non-zero, it means that all write operations in + RocksDB fail until the RocksDB background error is resolved. + The arangod server logfile should show more details about the exact + errors that are happening, so logs should be inspected first. + RocksDB can set a background error when some I/O operation fails. + This is often due to disk space usage issues, so often either freeing + disk space or increasing the disk capacity help. + Under some conditions, RocksDB can automatically resume from the + background error and go back into normal operations. However, if the + background error happens during certain RocksDB operations, it cannot + resume operations automatically, so the instance needs a manual + restart after the error condition is removed. + +- name: rocksdb_size_all_mem_tables + introducedIn: "3.6.1" + help: | + Approximate size of all RocksDB memtables. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-size-all-mem-tables`. + It shows the approximate size of all active, unflushed immutable, and + pinned immutable memtables in bytes, summed over all column families. + +- name: rocksdb_total_disk_space + introducedIn: "3.8.0" + help: | + Used disk space in bytes on volume used by RocksDB. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric shows the currently used disk space in bytes on the volume + which is used by RocksDB. Since RocksDB does not like out of disk + space scenarios, please make sure that there is enough free disk space + available at all times! Note that this metric is only available/populated on some platforms. + +- name: rocksdb_total_inodes + introducedIn: "3.8.0" + help: | + Number of used inodes on the volume used by RocksDB. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric shows the currently used number of inodes on the disk volume + used by RocksDB. Since RocksDB does not like out of disk space + scenarios, please make sure that there are enough free inodes available + at all times! Note that this metric is only available/populated on some platforms. + +- name: rocksdb_total_sst_files + introducedIn: "3.10.7" + help: | + Total number of RocksDB sst files, aggregated over all levels. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric reports the number of sst files of the log structured + merge tree of RocksDB, aggregated over all levels. + +- name: rocksdb_total_sst_files_size + introducedIn: "3.6.1" + help: | + Size of all RocksDB SST files. + unit: bytes + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exhibits the RocksDB metric `rocksdb-total-sst-files-size`. + It shows the total size in bytes of all SST files, summed over all + column families. + +- name: rocksdb_wal_pruning_active + introducedIn: "3.8.2" + help: | + Whether or not the pruning of archived RocksDB WAL files is currently + activated. + unit: number + type: gauge + category: RocksDB + complexity: medium + exposedBy: + - dbserver + - agent + - single + description: | + This metric contains a value of `0` if the pruning of archived RocksDB WAL + files is not activated, and `1` if it is activated. + WAL file pruning is normally deactivated for the first few minutes after + an instance is started, so that other instances in the cluster can start + replicating from the instance before all archived WAL files are deleted. + The value should flip from `0` to `1` a few minutes after server start. + +- name: rocksdb_wal_released_tick_flush + introducedIn: "3.10.5" + help: | + Lower bound sequence number from which WAL files need to be kept because + of external flushing needs. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exposes the RocksDB WAL sequence number from which onwards + WAL files have to be kept because the WAL data could be used by external + flushing needs. WAL files with sequence numbers higher than this value + are not garbage-collected. + The candidates that can keep WAL files from being garbage-collected are + `arangosearch` View links or inverted indexes that are still syncing data, + and background index creation. + +- name: rocksdb_wal_released_tick_replication + introducedIn: "3.10.5" + help: | + Lower bound sequence number from which WAL files need to be kept because + of replication. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exposes the RocksDB WAL sequence number from which onwards + WAL files have to kept in the archive because the WAL data could be used + by the replication. + WAL files with sequence numbers higher than this value are not + garbage-collected. + +- name: rocksdb_wal_sequence + introducedIn: "3.8.5" + help: | + Current RocksDB WAL sequence number. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exposes the current RocksDB WAL sequence number. Any + write operations into the database increases the sequence number. + +- name: rocksdb_wal_sequence_lower_bound + introducedIn: "3.8.2" + help: | + RocksDB sequence number until which the background sync thread + has caught up. + unit: number + type: gauge + category: RocksDB + complexity: advanced + exposedBy: + - dbserver + - agent + - single + description: | + This metric exposes the RocksDB WAL sequence number until which the + ArangoDB background sync thread has fully caught up to. The value exposed + here should be monotonically increasing and always progress if there are + write operations executing. + diff --git a/site/data/3.10/arangobench.json b/site/data/3.10/arangobench.json new file mode 100644 index 0000000000..01d120ce55 --- /dev/null +++ b/site/data/3.10/arangobench.json @@ -0,0 +1,1688 @@ +{ + "async" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Send asynchronous requests.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "batch-size" : { + "base" : 1, + "category" : "option", + "default" : 0, + "deprecatedIn" : null, + "description" : "The number of operations in one batch (0 = disable batching)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "check-configuration" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "collection" : { + "category" : "option", + "default" : "ArangoBenchmark", + "deprecatedIn" : null, + "description" : "The collection name to use in tests (if they involve collections).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "complexity" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The complexity parameter for the test (meaning depends on test case).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "config" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "create-collection" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to create the collection specified via the `--collection` option.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "create-database" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to create the database specified via the `--server.database` option.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "custom-query" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The query to be used in the \"custom-query\" test case.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "custom-query-bindvars" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The bind parameters to be used in the \"custom-query\" test case.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "custom-query-file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A path to the file with the query to use in the \"custom-query\" test case. If `--custom-query` is specified as well, it has higher priority.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "define" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "delay" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use a startup delay (necessary only when run in series).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-dependencies" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "duration" : { + "base" : 1, + "category" : "option", + "default" : 0, + "deprecatedIn" : null, + "description" : "Test for a duration of this many seconds instead of a fixed test count.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "histogram.generate" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Display a histogram.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "histogram", + "type" : "boolean" + }, + "histogram.interval-size" : { + "base" : 1, + "category" : "option", + "default" : 0, + "deprecatedIn" : null, + "description" : "The bucket width, dynamically calculated by default: `(first measured time * 20) / num-intervals`.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "histogram", + "type" : "double" + }, + "histogram.num-intervals" : { + "base" : 1, + "category" : "option", + "default" : 1000, + "deprecatedIn" : null, + "description" : "The number of buckets (resolution).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "histogram", + "type" : "uint64" + }, + "histogram.percentiles" : { + "category" : "option", + "default" : [ + 50, + 80, + 85, + 90, + 95, + 99, + 99.99 + ], + "deprecatedIn" : null, + "description" : "Which percentiles to calculate.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "histogram", + "type" : "double..." + }, + "json-report-file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The filename to write a report in JSON format to.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "junit-report-file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The filename to write junit-style report to.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "keep-alive" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use HTTP keep-alive.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "log" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.color" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "number-of-shards" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The number of shards of created collections (cluster only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "progress" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log intermediate progress.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "quiet" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "suppress status messages", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "replication-factor" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The replication factor of created collections (cluster only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "requests" : { + "base" : 1, + "category" : "option", + "default" : 1000, + "deprecatedIn" : null, + "description" : "The total number of operations.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "runs" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "Run test this many times (and calculate statistics based on the median).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "server.authentication" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.connection-timeout" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The connection timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.database" : { + "category" : "option", + "default" : "_system", + "deprecatedIn" : null, + "description" : "The database name to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.endpoint" : { + "category" : "option", + "default" : [ + "tcp://127.0.0.1:8529" + ], + "deprecatedIn" : null, + "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.max-packet-size" : { + "base" : 1, + "category" : "option", + "default" : 1073741824, + "deprecatedIn" : null, + "description" : "The maximum packet size (in bytes) for client/server communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.password" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The password to use when connecting. If not specified and authentication is required, the user is prompted for a password", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.request-timeout" : { + "base" : 1, + "category" : "option", + "default" : 1200, + "deprecatedIn" : null, + "description" : "The request timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.username" : { + "category" : "option", + "default" : "root", + "deprecatedIn" : null, + "description" : "The username to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "temp.path" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path for temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses the path for storing temporary\nfiles, for extracting data from uploaded zip files (e.g. for Foxx services),\nand other things.\n\nIdeally, the temporary path is set to an instance-specific subdirectory of the\noperating system's temporary directory. To avoid data loss, the temporary path\nshould not overlap with any directories that contain important data, for\nexample, the instance's database directory.\n\nIf you set the temporary path to the same directory as the instance's database\ndirectory, a startup error is logged and the startup is aborted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "test-case" : { + "category" : "option", + "default" : "version", + "deprecatedIn" : null, + "description" : "The test case to use.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string", + "values" : "Possible values: \"aqlinsert\", \"collection\", \"crud\", \"crud-append\", \"crud-write-read\", \"custom-query\", \"document\", \"edge\", \"import-document\", \"persistent-index\", \"version\"" + }, + "threads" : { + "base" : 1, + "category" : "option", + "default" : 32, + "deprecatedIn" : null, + "description" : "The number of parallel threads and connections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "use-splice-syscall" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "wait-for-sync" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use waitForSync for created collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + } +} diff --git a/site/data/3.10/arangod.json b/site/data/3.10/arangod.json new file mode 100644 index 0000000000..300cfb3b2b --- /dev/null +++ b/site/data/3.10/arangod.json @@ -0,0 +1,13525 @@ +{ + "agency.activate" : { + "category" : "option", + "component" : [ + "agent" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Activate the Agency.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "agency", + "type" : "boolean" + }, + "agency.compaction-keep-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 50000, + "deprecatedIn" : null, + "description" : "Keep as many Agency log entries before compaction point.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "uint64" + }, + "agency.compaction-step-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 1000, + "deprecatedIn" : null, + "description" : "The step size between state machine compactions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "uint64" + }, + "agency.disaster-recovery-id" : { + "category" : "option", + "component" : [ + "agent" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Specify the ID for this agent. WARNING: This is a dangerous option, for disaster recover only!", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "string" + }, + "agency.election-timeout-max" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 5, + "deprecatedIn" : null, + "description" : "The maximum timeout before an Agent calls for a new election (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "double" + }, + "agency.election-timeout-min" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The minimum timeout before an Agent calls for a new election (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : false, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "double" + }, + "agency.endpoint" : { + "category" : "option", + "component" : [ + "agent" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "The Agency endpoints.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "string..." + }, + "agency.max-append-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 250, + "deprecatedIn" : null, + "description" : "The maximum size of appendEntries document (number of log entries).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "uint64" + }, + "agency.my-address" : { + "category" : "option", + "component" : [ + "agent" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Which address to advertise to the outside.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "string" + }, + "agency.pool-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The number of Agents in the pool.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "uint64" + }, + "agency.size" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The number of Agents.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "uint64" + }, + "agency.supervision" : { + "category" : "option", + "component" : [ + "agent" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Perform ArangoDB cluster supervision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "agency", + "type" : "boolean" + }, + "agency.supervision-delay-add-follower" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The delay in supervision, before an AddFollower job is executed (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.6", + "v3.10.2" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "uint64" + }, + "agency.supervision-delay-failed-follower" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The delay in supervision, before a FailedFollower job is executed (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.6", + "v3.10.2" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "uint64" + }, + "agency.supervision-failed-leader-adds-follower" : { + "category" : "option", + "component" : [ + "agent" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Flag indicating whether or not the FailedLeader job adds a new follower.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.7", + "v3.10.2" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "agency", + "type" : "boolean" + }, + "agency.supervision-frequency" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The ArangoDB cluster supervision frequency (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "double" + }, + "agency.supervision-grace-period" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The supervision time after which a server is considered to have failed (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "A value of `10` seconds is recommended for regular\ncluster deployments. For Active Failover deployments, it is recommended to use a\nhigher value for the grace period to avoid unnecessary failovers.\n\nIn Active Failover setups, the leader server needs to handle all the load and is\nthus expected to get overloaded and unresponsive more easily than a server in a\nregular cluster, which needs to handle only a part of the overall load.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "double" + }, + "agency.supervision-ok-threshold" : { + "base" : 1, + "category" : "option", + "component" : [ + "agent" + ], + "default" : 5, + "deprecatedIn" : null, + "description" : "The supervision time after which a server is considered to be bad (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "agency", + "type" : "double" + }, + "agency.wait-for-sync" : { + "category" : "option", + "component" : [ + "agent" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Wait for hard disk syncs on every persistence call (required in production).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "agency", + "type" : "boolean" + }, + "arangosearch.columns-cache-limit" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "Limit in bytes for ArangoSearch columns cache. (0 = no caching)", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.5" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "uint64" + }, + "arangosearch.columns-cache-only-leader" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Cache ArangoSearch columns only for leader shards.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.6" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "arangosearch", + "type" : "boolean" + }, + "arangosearch.commit-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The upper limit to the allowed number of commit threads (0 = auto-detect).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.5" + ], + "longDescription" : "The option value must fall in the range\n`[ 1..4 * NumberOfCores ]`. Set it to `0` to automatically choose a sensible\nnumber based on the number of cores in the system.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "uint32" + }, + "arangosearch.commit-threads-idle" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The upper limit to the allowed number of idle threads to use for commit tasks (0 = auto-detect)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.5" + ], + "longDescription" : "The option value must fall in the range\n`[ 1..arangosearch.commit-threads ]`. Set it to `0` to automatically choose a\nsensible number based on the number of cores in the system.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "uint32" + }, + "arangosearch.consolidation-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The upper limit to the allowed number of consolidation threads (0 = auto-detect).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.5" + ], + "longDescription" : "The option value must fall in the range\n`[ 1..arangosearch.consolidation-threads ]`. Set it to `0` to automatically\nchoose a sensible number based on the number of cores in the system.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "uint32" + }, + "arangosearch.consolidation-threads-idle" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The upper limit to the allowed number of idle threads to use for consolidation tasks (0 = auto-detect).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.5" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "uint32" + }, + "arangosearch.fail-queries-on-out-of-sync" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether or not retrieval queries on out-of-sync View links and inverted indexes should fail.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "If set to `true`, any data retrieval queries on\nout-of-sync links/indexes fail with the error 'collection/view is out of sync'\n(error code 1481).\n\nIf set to `false`, queries on out-of-sync links/indexes are answered normally,\nbut the returned data may be incomplete.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "arangosearch", + "type" : "boolean" + }, + "arangosearch.skip-recovery" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Skip the data recovery for the specified View link or inverted index on startup. The value for this option needs to have the format '/' or '/'. You can use the option multiple times, for each View link and inverted index to skip the recovery for. The pseudo-value 'all' disables the recovery for all View links and inverted indexes. The links/indexes skipped during the recovery are marked as out-of-sync when the recovery completes. You need to recreate them manually afterwards.\nWARNING: Using this option causes data of affected links/indexes to become incomplete or more incomplete until they have been manually recreated.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "string..." + }, + "arangosearch.threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : [ + "v3.7.5" + ], + "description" : "The exact number of threads to use for asynchronous tasks (0 = auto-detect).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "From version 3.7.5 on, you should set the commit\nand consolidation thread counts separately via the following options instead:\n\n- `--arangosearch.commit-threads`\n- `--arangosearch.commit-threads-idle`\n- `--arangosearch.consolidation-threads`\n- `--arangosearch.consolidation-threads-idle`\n\nIf either `--arangosearch.commit-threads` or\n`--arangosearch.consolidation-threads` is set, then `--arangosearch.threads` and\n`arangosearch.threads-limit` are ignored. If only the legacy options are set,\nthen the commit and consolidation thread counts are calculated as follows:\n\n- Maximum: The smaller value out of `--arangosearch.threads` and\n `arangosearch.threads-limit` divided by 2, but at least 1.\n- Minimum: the maximum divided by 2, but at least 1.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "uint32" + }, + "arangosearch.threads-limit" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : [ + "v3.7.5" + ], + "description" : "The upper limit to the auto-detected number of threads to use for asynchronous tasks (0 = use default).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "From version 3.7.5 on, you should set the commit\nand consolidation thread counts separately via the following options instead:\n\n- `--arangosearch.commit-threads`\n- `--arangosearch.commit-threads-idle`\n- `--arangosearch.consolidation-threads`\n- `--arangosearch.consolidation-threads-idle`\n\nIf either `--arangosearch.commit-threads` or\n`--arangosearch.consolidation-threads` is set, then `--arangosearch.threads` and\n`arangosearch.threads-limit` are ignored. If only the legacy options are set,\nthen the commit and consolidation thread counts are calculated as follows:\n\n- Maximum: The smaller value out of `--arangosearch.threads` and\n `arangosearch.threads-limit` divided by 2, but at least 1.\n- Minimum: the maximum divided by 2, but at least 1.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "arangosearch", + "type" : "uint32" + }, + "audit.hostname" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The server name to be used in audit log messages. By default, the system hostname is used.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "audit", + "type" : "string" + }, + "audit.max-entry-length" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0", + "v3.7.9" + ], + "longDescription" : "You can use this option to limit the maximum line\nlength for individual audit log messages that are written into audit logs by\narangod.\n\nAny audit log messages longer than the specified value are truncated and the\nsuffix `...` is appended to them.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of audit log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "audit", + "type" : "uint32" + }, + "audit.output" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Specifies the target(s) of the audit log.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "To write to a file, use `file://` with a\nrelative or absolute file path.\n\nTo write to a syslog server, use `syslog://` or\n`syslog:///`.\n\nYou can specify this option multiple times to configure the output for multiple\ntargets.\n\nAny occurrence of `$PID` inside a filename is replaced with the actual process\nID at runtime. This allows you to log to process-specific files, e.g.\n`--audit.output file:///var/log/arangod.log.$PID`. Note that your terminal may\nrequire the dollar sign to be escaped.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "audit", + "type" : "string..." + }, + "audit.queue" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Queue audit log messages before writing them out (can reduce latency).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can control whether audit log messages are\nsubmitted to a queue and written to disk in batches or if they should be written\nto disk directly without being queued with this option.\n\nQueueing audit log entries may be beneficial for latency, but can lead to\nunqueued messages being lost in case of a crash or power loss. Setting this\noption to `false` mimics the behavior of version 3.7 and before, where audit log\nmessages were not queued but written in a blocking fashion.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "audit", + "type" : "boolean" + }, + "audit.write-log-level" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Add the log level of the audit event (TRACE, INFO, DEBUG, WARNING, ERROR) to audit log messages.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "You can control whether the log level is shown in\nthe audit log messages with this option. If you omit it or set it to `false`,\nthe log level is not shown in messages:\n\n`2016-10-03 15:47:26 | server1 | audit-authentication | n/a | database1 |\n127.0.0.1:61528 | http basic | credentials wrong | /_api/version`\n\nIf you set the option to `true`, the log level is included in the messages:\n\n`2016-10-03 15:47:26 | INFO | server1 | audit-authentication | n/a |\ndatabase1 | 127.0.0.1:61528 | http basic | credentials wrong |\n/_api/version`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "audit", + "type" : "boolean" + }, + "backup.api-enabled" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "true", + "deprecatedIn" : null, + "description" : "Whether the Hot Backup API is enabled (true) or not (false), or only enabled for superuser JWT (jwt).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "backup", + "type" : "string" + }, + "backup.files-per-batch" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 100, + "deprecatedIn" : null, + "description" : "Define how many files rclone should process in one call when uploading or downloading Hot Backups.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.8", + "v3.9.4" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "backup", + "type" : "uint64" + }, + "backup.local-path-prefix" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "/", + "deprecatedIn" : null, + "description" : "Restrict any backup target to the given path prefix.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "backup", + "type" : "string" + }, + "cache.rebalancing-interval" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 2000000, + "deprecatedIn" : null, + "description" : "The time between cache rebalancing attempts (in microseconds). The minimum value is 500000 (0.5 seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The server uses a cache system which pools memory\nacross many different cache tables. In order to provide intelligent internal\nmemory management, the system periodically reclaims memory from caches which are\nused less often and reallocates it to caches which get more activity.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 500000, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cache", + "type" : "uint64" + }, + "cache.size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 16338163712, + "deprecatedIn" : null, + "description" : "The global size limit for all caches (in bytes).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The global caching system, all caches, and all the\ndata contained therein are constrained to this limit.\n\nIf there is less than 4 GiB of RAM in the system, default value is 256 MiB.\nIf there is more, the default is `(system RAM size - 2 GiB) * 0.25`.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cache", + "type" : "uint64" + }, + "check-configuration" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "cluster.agency-endpoint" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Agency endpoint(s) to connect to.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can specify this option multiple times to let\nthe server use a cluster of Agency servers.\n\nEndpoints have the following pattern:\n\n- `tcp://ipv4-address:port` - TCP/IP endpoint, using IPv4\n- `tcp://[ipv6-address]:port` - TCP/IP endpoint, using IPv6\n- `ssl://ipv4-address:port` - TCP/IP endpoint, using IPv4, SSL encryption\n- `ssl://[ipv6-address]:port` - TCP/IP endpoint, using IPv6, SSL encryption\n\nYou must specify at least one endpoint or ArangoDB refuses to start. It is\nrecommended to specify at least two endpoints, so that ArangoDB has an\nalternative endpoint if one of them becomes unavailable:\n\n`--cluster.agency-endpoint tcp://192.168.1.1:4001\n--cluster.agency-endpoint tcp://192.168.1.2:4002 ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "string..." + }, + "cluster.api-jwt-policy" : { + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : "jwt-compat", + "deprecatedIn" : null, + "description" : "Controls the access permissions required for accessing /_admin/cluster REST APIs (jwt-all = JWT required to access all operations, jwt-write = JWT required for POST/PUT/DELETE operations, jwt-compat = 3.7 compatibility mode)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "The possible values for the option are:\n\n- `jwt-all`: requires a valid JWT for all accesses to `/_admin/cluster` and its\n sub-routes. If you use this configuration, the **CLUSTER** and **NODES**\n sections of the web interface are disabled, as they rely on the ability to\n read data from several cluster APIs.\n\n- `jwt-write`: requires a valid JWT for write accesses (all HTTP methods except\n GET) to `/_admin/cluster`. You can use this setting to allow privileged users\n to read data from the cluster APIs, but not to do any modifications.\n Modifications (carried out by write accesses) are then only possible by\n requests with a valid JWT.\n\n All existing permission checks for the cluster API routes are still in effect\n with this setting, meaning that read operations without a valid JWT may still\n require dedicated other permissions (as in v3.7).\n\n- `jwt-compat`: no **additional** access checks are in place for the cluster\n APIs. However, all existing permissions checks for the cluster API routes are\n still in effect with this setting, meaning that all operations may still\n require dedicated other permissions (as in v3.7).\n\nThe default value is `jwt-compat`, which means that this option does not cause\nany extra JWT checks compared to v3.7.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "string", + "values" : "Possible values: \"jwt-all\", \"jwt-compat\", \"jwt-write\"" + }, + "cluster.create-waits-for-sync-replication" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Let the active Coordinator wait for all replicas to create collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "cluster", + "type" : "boolean" + }, + "cluster.default-replication-factor" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The default replication factor for non-system collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "longDescription" : "If you don't set this option, it defaults to the\nvalue of the `--cluster.min-replication-factor` option. If set, the value must\nbe between the values of `--cluster.min-replication-factor` and\n`--cluster.max-replication-factor`.\n\nNote that you can still adjust the replication factor per collection. This value\nis only the default value used for new collections if no replication factor is\nspecified when creating a collection.\n\n**Warning**: If you use multiple Coordinators, use the same value on all\nCoordinators.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "uint32" + }, + "cluster.force-one-shard" : { + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Force the OneShard mode for all new collections.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "longDescription" : "If set to `true`, forces the cluster into creating\nall future collections with only a single shard and using the same DB-Server as\nas these collections' shards leader. All collections created this way are\neligible for specific AQL query optimizations that can improve query performance\nand provide advanced transactional guarantees.\n\n**Warning**: If you use multiple Coordinators, use the same value on all\nCoordinators.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "cluster", + "type" : "boolean" + }, + "cluster.index-create-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 259200, + "deprecatedIn" : null, + "description" : "The amount of time (in seconds) the Coordinator waits for an index to be created before giving up.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "double" + }, + "cluster.max-number-of-move-shards" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The number of shards to be moved per rebalance operation. If set to 0, no shards are moved.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option limits the maximum number of move\nshards operations that can be made when the **Rebalance Shards** button is\nclicked in the web interface. For backwards compatibility, the default value is\n`10`. A value of `0` disables the button.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "uint32" + }, + "cluster.max-number-of-shards" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 1000, + "deprecatedIn" : null, + "description" : "The maximum number of shards that can be configured when creating new collections (0 = unrestricted).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.1" + ], + "longDescription" : "If you change the value of this setting and\nrestart the servers, no changes are applied to existing collections that would\nviolate the new setting.\n\n**Warning**: If you use multiple Coordinators, use the same value on all\nCoordinators.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "uint32" + }, + "cluster.max-replication-factor" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The maximum replication factor for new collections (0 = unrestricted).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "longDescription" : "If you change the value of this setting and\nrestart the servers, no changes are applied to existing collections that would\nviolate the new setting.\n\n**Warning**: If you use multiple Coordinators, use the same value on all\nCoordinators.", + "maxInclusive" : true, + "maxValue" : 10, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "uint32" + }, + "cluster.min-replication-factor" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The minimum replication factor for new collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "longDescription" : "If you change the value of this setting and\nrestart the servers, no changes are applied to existing collections that would\nviolate the new setting.\n\n**Warning**: If you use multiple Coordinators, use the same value on all\nCoordinators.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "uint32" + }, + "cluster.my-address" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "This server's endpoint for cluster-internal communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If specified, the endpoint needs to be in one of\nthe following formats:\n\n- `tcp://ipv4-address:port` - TCP/IP endpoint, using IPv4\n- `tcp://[ipv6-address]:port` - TCP/IP endpoint, using IPv6\n- `ssl://ipv4-address:port` - TCP/IP endpoint, using IPv4, SSL encryption\n- `ssl://[ipv6-address]:port` - TCP/IP endpoint, using IPv6, SSL encryption\n\nIf you don't specify an endpoint, the server looks up its internal endpoint\naddress in the Agency. If no endpoint can be found in the Agency for the\nserver's ID, ArangoDB refuses to start.\n\n**Examples**\n\nListen only on the interface with the address `192.168.1.1`:\n\n`--cluster.my-address tcp://192.168.1.1:8530`\n\nListen on all IPv4 and IPv6 addresses which are configured on port `8530`:\n\n`--cluster.my-address ssl://[::]:8530`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "string" + }, + "cluster.my-advertised-endpoint" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "This server's advertised endpoint for external communication (optional, e.g. aan external IP address or load balancer).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If specified, the endpoint needs to be in one of\nthe following formats:\n\n- `tcp://ipv4-address:port` - TCP/IP endpoint, using IPv4\n- `tcp://[ipv6-address]:port` - TCP/IP endpoint, using IPv6\n- `ssl://ipv4-address:port` - TCP/IP endpoint, using IPv4, SSL encryption\n- `ssl://[ipv6-address]:port` - TCP/IP endpoint, using IPv6, SSL encryption\n\nIf you don't specify an advertised endpoint, no external endpoint is\nadvertised.\n\n**Examples**\n\nIf an external interface is available to this server, you can specify it to\ncommunicate with external software / drivers:\n\n`--cluster.my-advertised-endpoint tcp://some.public.place:8530`\n\nAll specifications of endpoints apply.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "string" + }, + "cluster.my-role" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "This server's role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "For a cluster, the possible values are `DBSERVER`\n(backend data server) and `COORDINATOR` (frontend server for external and \napplication access).\n\nFor Active Failover deployments, the role needs to be `SINGLE`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "string" + }, + "cluster.require-persisted-id" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "If set to `true`, then the instance only starts if a UUID file is found in the database directory on startup. This ensures that the instance is started using an already existing database directory and not a new one. For the first start, you must either create the UUID file manually or set the option to `false` for the initial startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "cluster", + "type" : "boolean" + }, + "cluster.resign-leadership-on-shutdown" : { + "category" : "option", + "component" : [ + "dbserver" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Create a resign leader ship job for this DB-Server on shutdown.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "cluster", + "type" : "boolean" + }, + "cluster.shard-synchronization-attempt-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1200, + "deprecatedIn" : null, + "description" : "The timeout (in seconds) for every shard synchronization attempt. Running into the timeout does not lead to a synchronization failure, but continues the synchronization shortly after. Setting a timeout can help to split the replication of large shards into smaller chunks and release snapshots on the leader earlier.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.9.2" + ], + "longDescription" : "**Warning**: If you use multiple DB-Servers, use\nthe same value on all DB-Servers.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "double" + }, + "cluster.synchronous-replication-timeout-factor" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "All synchronous replication timeouts are multiplied by this factor.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "**Warning**: If you use multiple DB-Servers, use\nthe same value on all DB-Servers.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "double" + }, + "cluster.synchronous-replication-timeout-maximum" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 3600, + "deprecatedIn" : null, + "description" : "All synchronous replication timeouts are at most this value (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "**Warning**: This option should generally remain\nuntouched and only be changed with great care!\n\nExtend or shorten the timeouts for the internal synchronous replication\nmechanism between DB-Servers. All such timeouts are affected by this change.\n\n**Warning**: If you use multiple DB-Servers, use the same value on all\nDB-Servers.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "double" + }, + "cluster.synchronous-replication-timeout-minimum" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 900, + "deprecatedIn" : null, + "description" : "All synchronous replication timeouts are at least this value (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.1" + ], + "longDescription" : "**Warning**: This option should generally remain\nuntouched and only be changed with great care!\n\nThe minimum timeout in seconds for the internal synchronous replication\nmechanism between DB-Servers. If replication requests are slow, but the servers\nare otherwise healthy, timeouts can cause followers to be dropped unnecessarily,\nresulting in costly resync operations. Increasing this value may help avoid such\nresyncs. Conversely, decreasing it may cause more resyncs, while lowering the\nlatency of individual write operations.\n\n**Warning**: If you use multiple DB-Servers, use the same value on all\nDB-Servers.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "double" + }, + "cluster.synchronous-replication-timeout-per-4k" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0.1, + "deprecatedIn" : null, + "description" : "All synchronous replication timeouts are increased by this amount per 4096 bytes (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "**Warning**: If you use multiple DB-Servers, use\nthe same value on all DB-Servers.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "double" + }, + "cluster.system-replication-factor" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 2, + "deprecatedIn" : null, + "description" : "The default replication factor for system collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "**Warning**: If you use multiple Coordinators, use\nthe same value on all Coordinators.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "uint32" + }, + "cluster.upgrade" : { + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : "auto", + "deprecatedIn" : null, + "description" : "Perform a cluster upgrade if necessary (auto = perform an upgrade and shut down only if `--database.auto-upgrade true` is set, disable = ignore `--database.auto-upgrade` and never perform an upgrade, force = ignore `--database.auto-upgrade` and always perform an upgrade and shut down, online = always perform an upgrade but don't shut down).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "string", + "values" : "Possible values: \"auto\", \"disable\", \"force\", \"online\"" + }, + "cluster.write-concern" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The global default write concern used for writes to new collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "longDescription" : "This value is used as the default write concern\nfor databases, which in turn is used as the default for collections.\n\n**Warning**: If you use multiple Coordinators, use the same value on all\nCoordinators.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "cluster", + "type" : "uint32" + }, + "config" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "console" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Start the server with a JavaScript emergency console.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "In this exclusive emergency mode, all networking\nand HTTP interfaces of the server are disabled. No requests can be made to the\nserver in this mode, and the only way to work with the server in this mode is by\nusing the emergency console.\n\nThe server cannot be started in this mode if it is already running in this or\nanother mode.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "daemon" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Start the server as a daemon (background process). Requires --pid-file to be set.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "database.auto-upgrade" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Perform a database upgrade if necessary.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you specify this option, then the server\nperforms a database upgrade instead of starting normally.\n\nA database upgrade first compares the version number stored in the `VERSION`\nfile in the database directory with the current server version.\n\nIf the version number found in the database directory is higher than that of the\nserver, the server considers this is an unintentional downgrade and warns about\nthis. Using the server in these conditions is neither recommended nor supported.\n\nIf the version number found in the database directory is lower than that of the\nserver, the server checks whether there are any upgrade tasks to perform.\nIt then executes all required upgrade tasks and prints the status. If one of the\nupgrade tasks fails, the server exits with an error. Re-starting the server with\nthe upgrade option again triggers the upgrade check and execution until the\nproblem is fixed.\n\nWhether or not you specify this option, the server always perform a version\ncheck on startup. If you running the server with a non-matching version number\nin the `VERSION` file, the server refuses to start.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.check-version" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Check the version of the database and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.directory" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "/var/lib/arangodb3", + "deprecatedIn" : null, + "description" : "The path to the database directory.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This defines the location where all data of a\nserver is stored.\n\nMake sure the directory is writable by the arangod process. You should further\nnot use a database directory which is provided by a network filesystem such as\nNFS. The reason is that networked filesystems might cause inconsistencies when\nthere are multiple parallel readers or writers or they lack features required by\narangod, e.g. `flock()`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "database", + "type" : "string" + }, + "database.extended-names-databases" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allow most UTF-8 characters in database names. Once in use, this option cannot be turned off again.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.force-sync-properties" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Force syncing of collection properties to disk after creating a collection or updating its properties. Otherwise, let the waitForSync property of each collection determine it.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "If turned off, no fsync happens for the collection\nand database properties stored in `parameter.json` files in the file system. If\nyou turn this option off, it speeds up workloads that create and drop a lot of\ncollections (e.g. test suites).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.ignore-datafile-errors" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Load collections even if datafiles may contain errors.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.init-database" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Initialize an empty database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.io-heartbeat" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Perform I/O heartbeat to test the underlying volume.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.7", + "v3.9.2" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.max-databases" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 18446744073709551615, + "deprecatedIn" : null, + "description" : "The maximum number of databases that can exist in parallel.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.10" + ], + "longDescription" : "If the maximum number of databases is reached, no\nadditional databases can be created in the deployment. In order to create additional\ndatabases, other databases need to be removed first.\"", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "database", + "type" : "uint64" + }, + "database.password" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The initial password of the root user.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "database", + "type" : "string" + }, + "database.required-directory-state" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "any", + "deprecatedIn" : null, + "description" : "The required state of the database directory at startup (non-existing: the database directory must not exist, existing: thedatabase directory must exist, empty: the database directory must exist but be empty, populated: the database directory must exist and contain specific files already, any: any state is allowed)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "database", + "type" : "string", + "values" : "Possible values: \"any\", \"empty\", \"existing\", \"non-existing\", \"populated\"" + }, + "database.restore-admin" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Reset the admin users and set a new password.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.upgrade-check" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Skip the database upgrade if set to false.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "database.wait-for-sync" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "The default waitForSync behavior. Can be overwritten when creating a collection.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "database", + "type" : "boolean" + }, + "default-language" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : [ + "v3.10.0" + ], + "description" : "An ISO-639 language code. You can only set this option once, when initializing the database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "The default language is used for sorting and\ncomparing strings. The language value is a two-letter language code (ISO-639) or\nit is composed by a two-letter language code followed by a two letter country\ncode (ISO-3166). For example: `de`, `en`, `en_US`, `en_UK`.\n\nThe default is the system locale of the platform.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "default-language-check" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Check if `--icu-language` / `--default-language` matches the stored language.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "define" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "dump-dependencies" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "encryption.key-generator" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The program must output 32 bytes of data on the\nstandard output and exit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "encryption.keyfile" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You must secure the encryption key file so that\nonly `arangodump`, `arangorestore`, and `arangod` can access it. You should also\nensure that the file is not readable if someone steals your hardware, for\nexample, by encrypting `/mytmpfs` or creating an in-memory file-system under\n`/mytmpfs`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "fortune" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Show a fortune cookie on startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "foxx.allow-install-from-remote" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allow installing Foxx apps from remote URLs other than GitHub.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "foxx", + "type" : "boolean" + }, + "foxx.api" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable the Foxx management REST APIs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "foxx", + "type" : "boolean" + }, + "foxx.enable" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable Foxx.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.5" + ], + "longDescription" : "If set to `false`, access to any custom Foxx \nservices in the deployment will be forbidden. Access to ArangoDB's built-in\nweb interface will still be possible though.\n\n**Note**: when setting this option to `false`, the management API for Foxx\nservices will automatically be disabled as well. This is the same as manually\nsetting the startup option `--foxx.api false`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "foxx", + "type" : "boolean" + }, + "foxx.force-update-on-startup" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Ensure that all Foxx services are synchronized before completing the startup sequence.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.10", + "v3.7.6" + ], + "longDescription" : "If set to `true`, all Foxx services in all\ndatabases are synchronized between multiple Coordinators during the startup\nsequence. This ensures that all Foxx services are up-to-date when a Coordinator\nreports itself as ready.\n\nIn case the option is set to `false` (i.e. no waiting), the Coordinator\ncompletes the startup sequence faster, and the Foxx services are propagated\nlazily. Until the initialization procedure has completed for the local Foxx\napps, any request to a Foxx app is responded to with an HTTP 500 error and a\nmessage `waiting for initialization of Foxx services in this database`. This can\ncause an unavailability window for Foxx services on Coordinator startup for the\ninitial requests to Foxx apps until the app propagation has completed.\n\nIf you don't use Foxx, you should set this option to `false` to benefit from a\nfaster Coordinator startup. Deployments relying on Foxx apps being available as\nsoon as a Coordinator is integrated or responding should set this option to\n`true`.\n\nThe option only has an effect for cluster setups. On single servers and in\nActive Failover mode, all Foxx apps are available from the very beginning.\n\n**Note**: ArangoDB 3.8 changes the default value to `false` for this option.\nIn previous versions, this option had a default value of `true`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "foxx", + "type" : "boolean" + }, + "foxx.queues" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable or disable Foxx queues.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If set to `true`, the Foxx queues are available\nand jobs in the queues are executed asynchronously.\n\nIf set to `false`, the queue manager is disabled and any jobs are prevented from\nbeing processed, which may reduce CPU load a bit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "foxx", + "type" : "boolean" + }, + "foxx.queues-poll-interval" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The poll interval for the Foxx queue manager (in seconds)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Lower values lead to more immediate and more\nfrequent Foxx queue job execution, but make the queue thread wake up and query\nthe queues more often. If set to a low value, the queue thread might cause\nCPU load.\n\nIf you don't use Foxx queues much, then you may increase this value to make the\nqueues thread wake up less.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "foxx", + "type" : "double" + }, + "foxx.store" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable the Foxx store in the web interface.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "foxx", + "type" : "boolean" + }, + "gid" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Switch to this group ID after reading configuration files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "The name (identity) of the group to run the\nserver as.\n\nIf you don't specify this option, the server does not attempt to change its GID,\nso that the GID the server runs as is the primary group of the user who started\nthe server.\n\nIf you specify this option, the server changes its GID after opening ports and\nreading configuration files, but before accepting connections or opening other\nfiles (such as recovery files).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "http.allow-method-override" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : [ + "v3.8.0" + ], + "description" : "Allow HTTP method override using special headers.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, the HTTP request\nmethod is optionally fetched from one of the following HTTP request headers if\npresent in the request:\n\n- `x-http-method`\n- `x-http-method-override`\n- `x-method-override`\n\nIf the option is enabled and any of these headers is set, the request method is\noverridden by the value of the header. For example, this allows you to issue an\nHTTP DELETE request which, to the outside world, looks like an HTTP GET request.\nThis allows you to bypass proxies and tools that only let certain request types\npass.\n\nEnabling this option may impose a security risk. You should only use it in\ncontrolled environments.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "http", + "type" : "boolean" + }, + "http.hide-product-header" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : [ + "v3.8.0" + ], + "description" : "Whether to omit the `Server: ArangoDB` header in HTTP responses.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "http", + "type" : "boolean" + }, + "http.keep-alive-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 300, + "deprecatedIn" : null, + "description" : "The keep-alive timeout for HTTP connections (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Idle keep-alive connections are closed by the\nserver automatically when the timeout is reached. A keep-alive-timeout value of\n`0` disables the keep-alive feature entirely.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "http", + "type" : "double" + }, + "http.permanently-redirect-root" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to use a permanent or temporary redirect.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.12" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "http", + "type" : "boolean" + }, + "http.redirect-root-to" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "/_admin/aardvark/index.html", + "deprecatedIn" : null, + "description" : "Redirect of the root URL.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.12" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "http", + "type" : "string" + }, + "http.return-queue-time-header" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to return the `x-arango-queue-time-seconds` header in all responses.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "The value contained in this header indicates the\ncurrent queueing/dequeuing time for requests in the scheduler (in seconds).\nClient applications and drivers can use this value to control the server load\nand also react on overload.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "http", + "type" : "boolean" + }, + "http.trusted-origin" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "The trusted origin URLs for CORS requests with credentials.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "http", + "type" : "string..." + }, + "hund" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Make ArangoDB bark on startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "icu-language" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "An ICU locale ID to set a language and optionally additional properties that affect string comparisons and sorting. You can only set this option once, when initializing the database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.9.1" + ], + "longDescription" : "With this option, you can get the sorting and\ncomparing order exactly as it is defined in the ICU standard. The language value\ncan be a two-letter language code (ISO-639), a two-letter language code followed\nby a two letter country code (ISO-3166), or any other valid ICU locale\ndefinition. For example: `de`, `en`, `en_US`, `en_UK`,\n`de_AT@collation=phonebook`.\n\nFor the Swedish language (`sv`), for instance, the correct ICU-based sorting\norder for letters is `'a','A','b','B','z','Z','å','Ä','ö','Ö'`. To get this\norder, use `--icu-language sv`. If you use `--default-language sv` instead, the\nsorting order will be `\"A\", \"a\", \"B\", \"b\", \"Z\", \"z\", \"å\", \"Ä\", \"Ö\", \"ö\"`.\n\n**Note**: You can use only one of the language options, either `--icu-language`\nor `--default-language`. Setting both of them results in an error.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "javascript.allow-admin-execute" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "For testing purposes, allow `/_admin/execute`. Never enable this option in production!", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to control whether\nuser-defined JavaScript code is allowed to be executed on the server by sending\nHTTP requests to the `/_admin/execute` API endpoint with an authenticated user\naccount.\n\nThe default value is `false`, which disables the execution of user-defined\ncode. This is also the recommended setting for production. In test environments,\nit may be convenient to turn the option on in order to send arbitrary setup\nor teardown commands for execution on the server.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.allow-external-process-control" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allow the execution and control of external processes from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.allow-port-testing" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allow the testing of ports from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.app-path" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : "/var/lib/arangodb3-apps", + "deprecatedIn" : null, + "description" : "The directory for Foxx applications.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.copy-installation" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Copy the contents of `javascript.startup-directory` on first start.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option is intended to be useful for rolling\nupgrades. If you set it to `true`, you can upgrade the underlying ArangoDB\npackages without influencing the running _arangod_ instance.\n\nSetting this value does only make sense if you use ArangoDB outside of a\ncontainer solution, like Docker or Kubernetes.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.enabled" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable the V8 JavaScript engine.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "For certain types of ArangoDB instances, you can\ncompletely disable the V8 JavaScript engine. Be aware that this is an\n**highly experimental** feature and it is to be expected that certain\nfunctionality (e.g. API endpoints, the web interface, AQL functions, etc.) may\nbe unavailable or dysfunctional. Nevertheless, you may wish to reduce the\nfootprint of ArangoDB by disabling V8.\n\nThis option is expected to **only** work reliably on single servers, DB-Servers,\nand Agents. Do not try to use this feature on Coordinators or in Active Failover\nsetups.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.endpoints-allowlist" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Endpoints that can be connected to via the `@arangodb/request` module in JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.endpoints-denylist" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Endpoints that cannot be connected to via the `@arangodb/request` module in JavaScript actions (if not in the allowlist).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.environment-variables-allowlist" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Environment variables that are accessible in JavaScript.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.environment-variables-denylist" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Environment variables that are inaccessible in JavaScript (if not in the allowlist).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.files-allowlist" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Filesystem paths that are accessible from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.gc-frequency" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 60, + "deprecatedIn" : null, + "description" : "Time-based garbage collection frequency for JavaScript objects (each x seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is useful to have the garbage\ncollection still work in periods with no or little numbers of requests.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "double" + }, + "javascript.gc-interval" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 2000, + "deprecatedIn" : null, + "description" : "Request-based garbage collection interval for JavaScript objects (each x requests).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.harden" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Disable access to JavaScript functions in the internal module: getPid() and logLevel().", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.module-directory" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Additional paths containing JavaScript modules.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.script" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Run the script and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.script-parameter" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Script parameter.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.startup-directory" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : "/usr/share/arangodb3/js", + "deprecatedIn" : null, + "description" : "A path to the directory containing the JavaScript startup scripts.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.startup-options-allowlist" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Startup options whose names match this regular expression are allowed and exposed to JavaScript.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.startup-options-denylist" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Startup options whose names match this regular expression are not exposed (if not in the allowlist) to JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.tasks" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable JavaScript tasks.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.transactions" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable JavaScript transactions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.user-defined-functions" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable JavaScript user-defined functions (UDFs) in AQL queries.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.4" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.v8-contexts" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum number of V8 contexts that are created for executing JavaScript actions.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "More contexts allow executing more JavaScript\nactions in parallel, provided that there are also enough threads available.\nNote that each V8 context uses a substantial amount of memory and requires\nperiodic CPU processing time for garbage collection.\n\nThis option configures the maximum number of V8 contexts that can be used in\nparallel. On server start, only as many V8 contexts are created as are\nconfigured by the `--javascript.v8-contexts-minimum` option. The actual number\nof available V8 contexts may vary between `--javascript.v8-contexts-minimum`\nand `--javascript.v8-contexts` at runtime. When there are unused V8 contexts\nthat linger around, the server's garbage collector thread automatically deletes\nthem.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.v8-contexts-max-age" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 60, + "deprecatedIn" : null, + "description" : "The maximum age for each V8 context (in seconds) before it is disposed.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "If both `--javascript.v8-contexts-max-invocations`\nand `--javascript.v8-contexts-max-age` are set, then the context is destroyed\nwhen either of the specified threshold values is reached.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "double" + }, + "javascript.v8-contexts-max-invocations" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum number of invocations for each V8 context before it is disposed (0 = unlimited).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.v8-contexts-minimum" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The minimum number of V8 contexts to keep available for executing JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The actual number of V8 contexts never drops below\nthis value, but it may go up as high as specified by the\n`--javascript.v8-contexts` option.\n\nWhen there are unused V8 contexts that linger around and the number of V8\ncontexts is greater than `--javascript.v8-contexts-minimum`, the server's\ngarbage collector thread automatically deletes them.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.v8-max-heap" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 3072, + "deprecatedIn" : null, + "description" : "The maximal heap size (in MiB).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.v8-options" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Options to pass to V8.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can optionally pass arguments to the V8\nJavaScript engine. The V8 engine runs with the default settings unless you\nexplicitly specify them. The options are forwarded to the V8 engine, which\nparses them on its own. Passing invalid options may result in an error being\nprinted on stderr and the option being ignored.\n\nYou need to pass the options as one string, with V8 option names being prefixed\nwith two hyphens. Multiple options need to be separated by whitespace. To get\na list of all available V8 options, you can use the value `\"--help\"` as follows:\n\n```\n--javascript.v8-options=\"--help\"\n```\n\nAnother example of specific V8 options being set at startup:\n\n```\n--javascript.v8-options=\"--log --no-logfile-per-isolate --logfile=v8.log\"\n```\n\nNames and features or usable options depend on the version of V8 being used, and\nmight change in the future if a different version of V8 is being used in\nArangoDB. Not all options offered by V8 might be sensible to use in the context\nof ArangoDB. Use the specific options only if you are sure that they are not\nharmful for the regular database operation.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "ldap.allow-offline" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "If a refresh attempt fails to connect to the LDAP server, continue with the cached authentication data.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.async-connect" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether the connection to the LDAP library is done asynchronously.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.basedn" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP basedn. Example: \"dc=example,dc=com\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.binddn" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP binddn. Example: \"cn=admin,dc=example,dc=com\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.bindpasswd" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP bindpassword. Example: \"admin\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.debug" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Turn on the internal OpenLDAP library output (warning: prints to stdout).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.enabled" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable LDAP.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.network-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "Timeout value (in seconds) after which network operations following the initial connection return in case of no activity (0 = default timeout).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "double" + }, + "ldap.port" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 389, + "deprecatedIn" : null, + "description" : "The port to use.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 65535, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "uint16" + }, + "ldap.prefix" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP prefix. Example: \"uid= xor dn= xor cn=\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.referrals" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether the LDAP library should implicitly chase referrals.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.refresh-rate" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 300, + "deprecatedIn" : null, + "description" : "Refresh user settings after this time (in seconds).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "double" + }, + "ldap.responsible-for" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A file of usernames this provider is responsible for. If empty, it is responsible for all users.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.11" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.restart" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether the LDAP library should implicitly restart connections.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.retries" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The number of tries to attempt connecting to the LDAP server. Setting it to values greater than 1 retries connecting in case the LDAP server is unavailable or denies the connection.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "uint32" + }, + "ldap.roles-attribute-name" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP attributename where the roles are located.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.roles-exclude" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Regular expression to exclude groups. Leave empty to exclude none.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.roles-include" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Regular expression to include groups. Leave empty to include all.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.roles-search" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP search for roles; '{USER}' is replaced by the 'dn' of the user.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.roles-transformation" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Regular expression to normalizer role name. Example: '/^ *(.*[^ ]])*/$2/'", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string..." + }, + "ldap.search-attribute" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "uid", + "deprecatedIn" : null, + "description" : "LDAP search attribute: Example: \"uid\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.search-filter" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "objectClass=*", + "deprecatedIn" : null, + "description" : "LDAP search filter. Example: \"(objectClass=simpleSecurityObject)\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.search-scope" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "sub", + "deprecatedIn" : null, + "description" : "LDAP search scope, one of: base, one, sub", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.serialize-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 5, + "deprecatedIn" : null, + "description" : "Maximum amount of time (in seconds) to wait for the serialization mutex.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "double" + }, + "ldap.serialized" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether calls into the LDAP library should be serialized. You can use this option to work around thread-unsafe LDAP library functionality.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.server" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The server to use.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.suffix" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP suffix. Example: \",dc=example,dc=com\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.superuser-role" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Role mapping to the super-users.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "Timeout value (in seconds) for synchronous LDAP API calls (0 = default timeout).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "double" + }, + "ldap.tls" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable TLS.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap", + "type" : "boolean" + }, + "ldap.tls-cacert-dir" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP TLS CA certificate directory.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.tls-cacert-file" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP TLS CA certificate file.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.tls-cert-check-strategy" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "hard", + "deprecatedIn" : null, + "description" : "LDAP TLS certificate check strategy, one of: never, hard, demand, allow, try", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.tls-version" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "1.2", + "deprecatedIn" : null, + "description" : "LDAP TLS version, one of: 1.0, 1.1, 1.2", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap.url" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The LDAP URL. Example: ldap://example.com:389/dc=example,dc=com?uid?sub", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap", + "type" : "string" + }, + "ldap2.allow-offline" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "If a refresh attempt fails to connect to the LDAP server, continue with the cached authentication data.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.async-connect" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether the connection to the LDAP library is done asynchronously.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.basedn" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP basedn. Example: \"dc=example,dc=com\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.binddn" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP binddn. Example: \"cn=admin,dc=example,dc=com\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.bindpasswd" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP bindpassword. Example: \"admin\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.debug" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Turn on the internal OpenLDAP library output (warning: prints to stdout).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.enabled" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable LDAP.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.network-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "Timeout value (in seconds) after which network operations following the initial connection return in case of no activity (0 = default timeout).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "double" + }, + "ldap2.port" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 389, + "deprecatedIn" : null, + "description" : "The port to use.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 65535, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "uint16" + }, + "ldap2.prefix" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP prefix. Example: \"uid= xor dn= xor cn=\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.referrals" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether the LDAP library should implicitly chase referrals.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.refresh-rate" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 300, + "deprecatedIn" : null, + "description" : "Refresh user settings after this time (in seconds).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "double" + }, + "ldap2.responsible-for" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A file of usernames this provider is responsible for. If empty, it is responsible for all users.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.11" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.restart" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether the LDAP library should implicitly restart connections.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.retries" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The number of tries to attempt connecting to the LDAP server. Setting it to values greater than 1 retries connecting in case the LDAP server is unavailable or denies the connection.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "uint32" + }, + "ldap2.roles-attribute-name" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP attributename where the roles are located.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.roles-exclude" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Regular expression to exclude groups. Leave empty to exclude none.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.roles-include" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Regular expression to include groups. Leave empty to include all.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.roles-search" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP search for roles; '{USER}' is replaced by the 'dn' of the user.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.roles-transformation" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Regular expression to normalizer role name. Example: '/^ *(.*[^ ]])*/$2/'", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string..." + }, + "ldap2.search-attribute" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "uid", + "deprecatedIn" : null, + "description" : "LDAP search attribute: Example: \"uid\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.search-filter" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "objectClass=*", + "deprecatedIn" : null, + "description" : "LDAP search filter. Example: \"(objectClass=simpleSecurityObject)\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.search-scope" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "sub", + "deprecatedIn" : null, + "description" : "LDAP search scope, one of: base, one, sub", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.serialize-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 5, + "deprecatedIn" : null, + "description" : "Maximum amount of time (in seconds) to wait for the serialization mutex.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "double" + }, + "ldap2.serialized" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether calls into the LDAP library should be serialized. You can use this option to work around thread-unsafe LDAP library functionality.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.server" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The server to use.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.suffix" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP suffix. Example: \",dc=example,dc=com\"", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.superuser-role" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Role mapping to the super-users.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "Timeout value (in seconds) for synchronous LDAP API calls (0 = default timeout).", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "double" + }, + "ldap2.tls" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable TLS.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ldap2", + "type" : "boolean" + }, + "ldap2.tls-cacert-dir" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP TLS CA certificate directory.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.tls-cacert-file" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "LDAP TLS CA certificate file.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.tls-cert-check-strategy" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "hard", + "deprecatedIn" : null, + "description" : "LDAP TLS certificate check strategy, one of: never, hard, demand, allow, try", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.tls-version" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "1.2", + "deprecatedIn" : null, + "description" : "LDAP TLS version, one of: 1.0, 1.1, 1.2", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "ldap2.url" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The LDAP URL. Example: ldap://example.com:389/dc=example,dc=com?uid?sub", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ldap2", + "type" : "string" + }, + "log" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + "info", + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.api-enabled" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "true", + "deprecatedIn" : null, + "description" : "Whether the log API is enabled (true) or not (false), or only enabled for superuser JWT (jwt).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.11", + "v3.5.6", + "v3.6.5" + ], + "longDescription" : "Credentials are not written to log files.\nNevertheless, some logged data might be sensitive depending on the context of\nthe deployment. For example, if request logging is switched on, user requests\nand corresponding data might end up in log files. Therefore, a certain care\nwith log files is recommended.\n\nSince the database server offers an API to control logging and query logging\ndata, this API has to be secured properly. By default, the API is accessible\nfor admin users (administrative access to the `_system` database). However,\nyou can lock this down further.\n\nThe possible values for this option are:\n\n - `true`: The `/_admin/log` API is accessible for admin users.\n - `jwt`: The `/_admin/log` API is accessible for the superuser only\n (authentication with JWT token and empty username).\n - `false`: The `/_admin/log` API is not accessible at all.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.color" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.in-memory" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Use an in-memory log appender which can be queried via the API and web interface.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to toggle storing log\nmessages in memory, from which they can be consumed via the `/_admin/log`\nHTTP API and via the web interface.\n\nBy default, this option is turned on, so log messages are consumable via the API\nand web interface. Turning this option off disables that functionality, saves a\nbit of memory for the in-memory log buffers, and prevents potential log\ninformation leakage via these means.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.in-memory-level" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "info", + "deprecatedIn" : null, + "description" : "Use an in-memory log appender only for this log level and higher.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "You can use this option to control which log\nmessages are preserved in memory (in case `--log.in-memory` is enabled).\n\nThe default value is `info`, meaning all log messages of types `info`,\n`warning`, `error`, and `fatal` are stored in-memory by an instance. By setting\nthis option to `warning`, only `warning`, `error` and `fatal` log messages are \npreserved in memory, and by setting the option to `error`, only `error` and\n`fatal` messages are kept.\n\nThis option is useful because the number of in-memory log messages is limited \nto the latest 2048 messages, and these slots are shared between informational,\nwarning, and error messages by default.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"debug\", \"err\", \"error\", \"fatal\", \"info\", \"trace\", \"warn\", \"warning\"" + }, + "log.keep-logrotate" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Keep the old log file after receiving a SIGHUP.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + "info", + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, arangosearch, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, libiresearch, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "network.idle-connection-ttl" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 120000, + "deprecatedIn" : null, + "description" : "The default time-to-live of idle connections for cluster-internal communication (in milliseconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "network", + "type" : "uint64" + }, + "network.io-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 2, + "deprecatedIn" : null, + "description" : "The number of network I/O threads for cluster-internal communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "network", + "type" : "uint32" + }, + "network.max-open-connections" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1024, + "deprecatedIn" : null, + "description" : "The maximum number of open TCP connections for cluster-internal communication per endpoint", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "network", + "type" : "uint64" + }, + "network.max-requests-in-flight" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 65536, + "deprecatedIn" : null, + "description" : "The number of internal requests that can be in flight at a given point in time.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "network", + "type" : "uint64" + }, + "network.protocol" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : [ + "v3.9.0" + ], + "description" : "The network protocol to use for cluster-internal communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "network", + "type" : "string", + "values" : "Possible values: \"\", \"h2\", \"http\", \"http2\", \"vst\"" + }, + "network.verify-hosts" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Verify peer certificates when using TLS in cluster-internal communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "network", + "type" : "boolean" + }, + "pid-file" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The name of the process ID file to use if the server runs as a daemon.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "pregel.max-parallelism" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 32, + "deprecatedIn" : null, + "description" : "The maximum parallelism usable in a Pregel job.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "This option effectively limits the parallelism of\neach Pregel job to the specified value. In a cluster deployment, the limit\napplies per DB-Server.\n\nDefaults to the number of available cores.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "pregel", + "type" : "uint64" + }, + "pregel.memory-mapped-files" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to use memory mapped files for storing Pregel temporary data (as opposed to storing it in RAM) by default.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "If set to `true`, Pregel jobs store their\ntemporary data in disk-backed memory-mapped files. If set to `false`, the\ntemporary data of Pregel jobs is buffered in main memory.\n\nMemory-mapped files are used by default. This has the advantage of a lower RAM\nutilization, which reduces the likelihood of out-of-memory situations. However,\nstoring the files on disk requires a certain disk capacity, so that instead of\nrunning out of RAM, it is possible to run out of a disk space. Make sure to use\na suitable storage location.\n\nYou can override this option for each Pregel job by setting the `useMemoryMaps`\nattribute of the job.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "pregel", + "type" : "boolean" + }, + "pregel.memory-mapped-files-custom-path" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Custom path for Pregel's temporary files. Only used if `--pregel.memory-mapped-files-location` is \"custom\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "If you use this option, you need to specify the\nstorage directory location as an absolute path.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "pregel", + "type" : "string" + }, + "pregel.memory-mapped-files-location-type" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : "temp-directory", + "deprecatedIn" : null, + "description" : "The location for Pregel's temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "You can configure the location for the\nmemory-mapped files written by Pregel with this option. This option is only\nmeaningful if you use memory-mapped files.\n\nThe option can have one of the following values:\n\n- `temp-directory`: store memory-mapped files in the temporary directory, as\n configured via `--temp.path`. If `--temp.path` is not set, the system's\n temporary directory is used.\n- `database-directory`: store memory-mapped files in a separate directory\n underneath the database directory.\n- `custom`: use a custom directory location for memory-mapped files. You can set\n the location via the `--pregel.memory-mapped-files-custom-path` option.\n\nThe default location for Pregel's memory-mapped files is the temporary directory \n(`--temp.path`), which may not provide enough capacity for larger Pregel jobs.\nIt may be more sensible to configure a custom directory for memory-mapped files\nand provide the necessary disk space there (`custom`). \nSuch custom directory can be mounted on ephemeral storage, as the files are only \nneeded temporarily. If a custom directory location is used, you need to specify \nthe actual location via the `--pregel.memory-mapped-files-custom-path`\nparameter.\n\nYou can also use a subdirectory of the database directory as the storage\nlocation for the memory-mapped files (`--database.directory`). The database\ndirectory often provides a lot of disk space capacity, but when Pregel's\ntemporary files are stored in there too, it has to provide enough capacity to\nstore both the regular database data and the Pregel files.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "pregel", + "type" : "string", + "values" : "Possible values: \"custom\", \"database-directory\", \"temp-directory\"" + }, + "pregel.min-parallelism" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The minimum parallelism usable in a Pregel job.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Increasing the value of this option forces each\nPregel job to run with at least this level of parallelism. In a cluster\ndeployment, the limit applies per DB-Server.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "pregel", + "type" : "uint64" + }, + "pregel.parallelism" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 8, + "deprecatedIn" : null, + "description" : "The default parallelism to use in a Pregel job if none is specified.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "The default parallelism for a Pregel job is only\nused if you start a job without setting the `parallelism` attribute.\n\nDefaults to the number of available cores divided by 4. The result is limited to\na value between 1 and 16.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "pregel", + "type" : "uint64" + }, + "query.allow-collections-in-expressions" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : [ + "v3.9.0" + ], + "description" : "Allow full collections to be used in AQL expressions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "If set to `true`, using collection names in\narbitrary places in AQL expressions is allowed, although using collection names\nlike this is very likely unintended.\n\nFor example, consider the following query:\n\n```aql\nFOR doc IN collection RETURN collection\n```\n\nHere, the collection name is `collection`, and its usage in the `FOR` loop is\nintended and valid. However, `collection` is also used in the `RETURN`\nstatement, which is legal but potentially unintended. It should likely be\n`RETURN doc` or `RETURN doc.someAttribute` instead. Otherwise, the entire\ncollection is materialized and returned as many times as there are documents in\nthe collection. This can take a long time and even lead to out-of-memory crashes\nin the worst case.\n\nIf you set the option to `false`, such unintentional usage of collection names\nin queries is prohibited, and instead makes the query fail with error 1568\n(\"collection used as expression operand\").\n\nThe default value of the option was `true` in v3.8, meaning that potentially\nunintended usage of collection names in queries were still allowed. In v3.9,\nthe default value changes to `false`. The option is also deprecated from\n3.9.0 on and will be removed in future versions. From then on, unintended\nusage of collection names will always be disallowed.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.cache-entries" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 128, + "deprecatedIn" : null, + "description" : "The maximum number of results in query result cache per database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If a query is eligible for caching and the number\nof items in the database's query cache is equal to this threshold value, another\ncached query result is removed from the cache.\n\nThis option only has an effect if the query cache mode is set to either `on` or\n`demand`.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.cache-entries-max-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 268435456, + "deprecatedIn" : null, + "description" : "The maximum cumulated size of results in the query result cache per database (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "When a query result is inserted into the query\nresults cache, it is checked if the total size of cached results would exceed\nthis value, and if so, another cached query result is removed from the cache\nbefore a new one is inserted.\n\nThis option only has an effect if the query cache mode is set to either `on` or\n`demand`.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.cache-entry-max-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 16777216, + "deprecatedIn" : null, + "description" : "The maximum size of an individual result entry in query result cache (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Query results are only eligible for caching if\ntheir size does not exceed this setting's value.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.cache-include-system-collections" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to include system collection queries in the query result cache.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Not storing these results is normally beneficial\nif you use the query results cache, as queries on system collections are\ninternal to ArangoDB and use space in the query results cache unnecessarily.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.cache-mode" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "off", + "deprecatedIn" : null, + "description" : "The mode for the AQL query result cache. Can be \"on\", \"off\", or \"demand\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Toggles the AQL query results cache behavior.\nThe possible values are:\n\n- `off`: do not use query results cache\n- `on`: always use query results cache, except for queries that have their\n `cache` attribute set to `false`\n- `demand`: use query results cache only for queries that have their `cache`\n attribute set to `true`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "string" + }, + "query.fail-on-warning" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether AQL queries should fail with errors even for recoverable warnings.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If set to `true`, AQL queries that produce\nwarnings are instantly aborted and throw an exception. This option can be set\nto catch obvious issues with AQL queries early.\n\nIf set to `false`, AQL queries that produce warnings are not aborted and return\nthe warnings along with the query results.\n\nYou can override the option for each individual AQL query via the\n`failOnWarning` attribute.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.global-memory-limit" : { + "base" : 67500138496, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 54675112182, + "deprecatedIn" : null, + "description" : "The memory threshold for all AQL queries combined (in bytes, 0 = no limit).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to set a limit on the\ncombined estimated memory usage of all AQL queries (in bytes). If this option\nhas a value of `0`, then no global memory limit is in place. This is also the\ndefault value and the same behavior as in version 3.7 and older.\n\nIf you set this option to a value greater than zero, then the total memory usage\nof all AQL queries is limited approximately to the configured value. The limit\nis enforced by each server node in a cluster independently, i.e. it can be set\nseparately for Coordinators, DB-Servers etc. The memory usage of a query that\nruns on multiple servers in parallel is not summed up, but tracked separately on\neach server.\n\nIf a memory allocation in a query would lead to the violation of the configured\nglobal memory limit, then the query is aborted with error code 32\n(\"resource limit exceeded\").\n\nThe global memory limit is approximate, in the same fashion as the per-query\nmemory limit exposed by the option `--query.memory-limit` is. The global memory\ntracking has a granularity of 32 KiB chunks.\n\nIf both, `--query.global-memory-limit` and `--query.memory-limit`, are set, you\nmust set the former at least as high as the latter.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.log-failed" : { + "category" : "option", + "component" : [ + "coordinator", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to log failed AQL queries.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.5", + "v3.10.2" + ], + "longDescription" : "If set to `true`, all failed AQL queries are\nlogged to the server log. You can use this option during development, or to\ncatch unexpected failed queries in production.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.log-memory-usage-threshold" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "agent", + "single" + ], + "default" : 4294967296, + "deprecatedIn" : null, + "description" : "Log queries that have a peak memory usage larger than this threshold.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.5", + "v3.10.2" + ], + "longDescription" : "A warning is logged if queries exceed the\nspecified threshold. This is useful for finding queries that use a large\namount of memory.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.max-artifact-log-length" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "agent", + "single" + ], + "default" : 4096, + "deprecatedIn" : null, + "description" : "The maximum length of query strings and bind parameter values in logs before they get truncated.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.5", + "v3.10.2" + ], + "longDescription" : "This option allows you to truncate overly long\nquery strings and bind parameter values to a reasonable length in log files.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.max-collections-per-query" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 2048, + "deprecatedIn" : null, + "description" : "The maximum number of collections/shards that can be used in one AQL query.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.7" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.max-nodes-per-callstack" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 250, + "deprecatedIn" : null, + "description" : "The maximum number of execution nodes on the callstack before splitting the remaining nodes into a separate thread", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.9.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.max-parallelism" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 4, + "deprecatedIn" : null, + "description" : "The maximum number of threads to use for a single query; the actual query execution may use less depending on various factors.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.max-runtime" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The runtime threshold for AQL queries (in seconds, 0 = no limit).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.7", + "v3.7.3" + ], + "longDescription" : "Sets a default maximum runtime for AQL queries.\n\nThe default value is `0`, meaning that the runtime of AQL queries is not\nlimited. If you set it to any positive value, it restricts the runtime of all\nAQL queries, unless you override it with the `maxRuntime` query option on a\nper-query basis.\n\nIf a query exceeds the configured runtime, it is killed on the next occasion\nwhen the query checks its own status. Killing is best effort-based, so it is not\nguaranteed that a query will no longer than exactly the configured amount of\ntime.\n\n**Warning**: This option affects all queries in all databases, including queries\nissued for administration and database-internal purposes.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "double" + }, + "query.memory-limit" : { + "base" : 67500138496, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 40500083097, + "deprecatedIn" : null, + "description" : "The memory threshold per AQL query (in bytes, 0 = no limit).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The default maximum amount of memory (in bytes)\nthat a single AQL query can use. When a single AQL query reaches the specified\nlimit value, the query is aborted with a *resource limit exceeded* exception.\nIn a cluster, the memory accounting is done per server, so the limit value is\neffectively a memory limit per query per server node.\n\nSome operations, namely calls to AQL functions and their intermediate results, \nare not properly tracked.\n\nYou can override the limit by setting the `memoryLimit` option for individual\nqueries when running them. Overriding the per-query limit value is only possible\nif the `--query.memory-limit-override` option is set to `true`.\n\nThe default per-query memory limit value in version 3.8 and later depends on\nthe amount of available RAM. In version 3.7 and older, the default value was\n`0`, meaning \"unlimited\".\n\nThe default values are:\n\n```\nAvailable memory: 0 (0MiB) Limit: 0 unlimited, %mem: n/a\nAvailable memory: 134217728 (128MiB) Limit: 33554432 (32MiB), %mem: 25.0\nAvailable memory: 268435456 (256MiB) Limit: 67108864 (64MiB), %mem: 25.0\nAvailable memory: 536870912 (512MiB) Limit: 201326592 (192MiB), %mem: 37.5\nAvailable memory: 805306368 (768MiB) Limit: 402653184 (384MiB), %mem: 50.0\nAvailable memory: 1073741824 (1024MiB) Limit: 603979776 (576MiB), %mem: 56.2\nAvailable memory: 2147483648 (2048MiB) Limit: 1288490189 (1228MiB), %mem: 60.0\nAvailable memory: 4294967296 (4096MiB) Limit: 2576980377 (2457MiB), %mem: 60.0\nAvailable memory: 8589934592 (8192MiB) Limit: 5153960755 (4915MiB), %mem: 60.0\nAvailable memory: 17179869184 (16384MiB) Limit: 10307921511 (9830MiB), %mem: 60.0\nAvailable memory: 25769803776 (24576MiB) Limit: 15461882265 (14745MiB), %mem: 60.0\nAvailable memory: 34359738368 (32768MiB) Limit: 20615843021 (19660MiB), %mem: 60.0\nAvailable memory: 42949672960 (40960MiB) Limit: 25769803776 (24576MiB), %mem: 60.0\nAvailable memory: 68719476736 (65536MiB) Limit: 41231686041 (39321MiB), %mem: 60.0\nAvailable memory: 103079215104 (98304MiB) Limit: 61847529063 (58982MiB), %mem: 60.0\nAvailable memory: 137438953472 (131072MiB) Limit: 82463372083 (78643MiB), %mem: 60.0\nAvailable memory: 274877906944 (262144MiB) Limit: 164926744167 (157286MiB), %mem: 60.0\nAvailable memory: 549755813888 (524288MiB) Limit: 329853488333 (314572MiB), %mem: 60.0\n```\n\nYou can set a global memory limit for the total memory used by all AQL queries\nthat currently execute via the `--query.global-memory-limit` option.\n\nFrom ArangoDB 3.8 on, the per-query memory tracking has a granularity of 32 KB \nchunks. That means checking for memory limits such as \"1\" (e.g. for testing) \nmay not make a query fail if the total memory allocations in the query don't \nexceed 32 KiB. The effective lowest memory limit value that can be enforced is\nthus 32 KiB. Memory limit values higher than 32 KiB will be checked whenever the\ntotal memory allocations cross a 32 KiB boundary.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.memory-limit-override" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Allow increasing the per-query memory limits for individual queries.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to control whether\nindividual AQL queries can increase their memory limit via the `memoryLimit`\nquery option. This is the default, so a query that increases its memory limit is\nallowed to use more memory than set via the `--query.memory-limit` startup\noption value.\n\nIf the option is set to `false`, individual queries can only lower their maximum\nallowed memory usage but not increase it.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.optimizer-max-plans" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 128, + "deprecatedIn" : null, + "description" : "The maximum number of query plans to create for a query.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can control how many different query execution\nplans the AQL query optimizer generates at most for any given AQL query with\nthis option. Normally, the AQL query optimizer generates a single execution plan\nper AQL query, but there are some cases in which it creates multiple competing\nplans.\n\nMore plans can lead to better optimized queries. However, plan creation has its\ncosts. The more plans are created and shipped through the optimization pipeline,\nthe more time is spent in the optimizer. You can lower the number to make the\noptimizer stop creating additional plans when it has already created enough\nplans.\n\nNote that this setting controls the default maximum number of plans to create.\nThe value can still be adjusted on a per-query basis by setting the\n`maxNumberOfPlans` attribute for individual queries.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "uint64" + }, + "query.optimizer-rules" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Enable or disable specific optimizer rules by default. Specify the rule name prefixed with `-` for disabling, or `+` for enabling.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.6.0" + ], + "longDescription" : "You can use this option to selectively enable or\ndisable AQL query optimizer rules by default. You can specify the option\nmultiple times.\n\nFor example, to turn off the rules `use-indexes-for-sort` and\n`reduce-extraction-to-projection` by default, use the following:\n\n```\n--query.optimizer-rules \"-use-indexes-for-sort\" --query.optimizer-rules \"-reduce-extraction-to-projection\"\n```\n\nThe purpose of this startup option is to be able to enable potential future\nexperimental optimizer rules, which may be shipped in a disabled-by-default\nstate.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "string..." + }, + "query.parallelize-gather-writes" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable write parallelization for gather nodes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.parallelize-traversals" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable traversal parallelization.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.registry-ttl" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The default time-to-live of cursors and query snippets (in seconds). If set to 0 or lower, the value defaults to 30 for single server instances and 600 for Coordinator instances.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "double" + }, + "query.require-with" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether AQL queries should require the `WITH collection-name` clause even on single servers (enable this to remove this behavior difference between single server and cluster).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.11", + "v3.8.0" + ], + "longDescription" : "If set to `true`, AQL queries in single server\nmode also require `WITH` clauses in AQL queries where a cluster installation\nwould require them.\n\nThe option is set to `false` by default, but you can turn it on in single\nservers to remove this behavior difference between single servers and clusters,\nmaking a later transition from single server to cluster easier.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.slow-streaming-threshold" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The threshold for slow streaming AQL queries (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can control after what execution time\nstreaming AQL queries are considered \"slow\" with this option. It exists to give\nstreaming queries a separate, potentially higher timeout value than for regular\nqueries. Streaming queries are often executed in lockstep with application data\nprocessing logic, which then also accounts for the queries' runtime. It is thus\nexpected that the lifetime of streaming queries is longer than for regular\nqueries.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "double" + }, + "query.slow-threshold" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The threshold for slow AQL queries (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can control after what execution time an AQL\nquery is considered \"slow\" with this option. Any slow queries that exceed the\nspecified execution time are logged when they are finished.\n\nYou can turn off the tracking of slow queries entirely by setting the option\n`--query.tracking` to `false`.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "query", + "type" : "double" + }, + "query.smart-joins" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable the SmartJoins query optimization.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.tracking" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to track queries.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.tracking-slow-queries" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to track slow queries.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.4" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.tracking-with-bindvars" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to track bind variable of AQL queries.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If set to `true`, then the bind variables are\ntracked and shown for all running and slow AQL queries. This also enables the\ndisplay of bind variable values in the list of cached AQL query results. This\noption only has an effect if `--query.tracking` is set to `true` or if the query\nresults cache is used.\n\nYou can disable tracking and displaying bind variable values by setting the\noption to `false`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.tracking-with-datasources" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to track data sources of AQL queries.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.4" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "query.tracking-with-querystring" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to track the query string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.4" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "query", + "type" : "boolean" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "rclone.argument" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Prepend custom arguments to rclone.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.11", + "v3.10.7" + ], + "longDescription" : "You can add custom arguments to rclone to i.e.\nenable debug logging into a separato logfile. This would be achieved by\nspecifying:\n --rclone.argument --log-level=DEBUG --rclone.argument --log-file=rclone.log\nin conjunction with the starter the ARANGODB_SERVER_DIR environment variable\ncan be utilized with the @VAR@-suplementing facility to generate individual\nlogfile names for clusters.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rclone", + "type" : "string..." + }, + "rclone.executable" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Path to the rclone executable used for uploading and downloading of Hot Backups.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rclone", + "type" : "string" + }, + "replication.active-failover" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable active-failover during asynchronous replication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "replication", + "type" : "boolean" + }, + "replication.active-failover-leader-grace-period" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 120, + "deprecatedIn" : null, + "description" : "The amount of time (in seconds) for which the current leader will continue to assume its leadership even if it lost connection to the agency (0 = unlimited)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.8" + ], + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "replication", + "type" : "double" + }, + "replication.auto-repair-revision-trees" : { + "category" : "option", + "component" : [ + "dbserver" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to automatically repair revision trees of shards after too many shard synchronization failures.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.6" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "replication", + "type" : "boolean" + }, + "replication.auto-start" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable or disable the automatic start of replication appliers.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "replication", + "type" : "boolean" + }, + "replication.connect-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The default timeout value for replication connection attempts (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.9", + "v3.5.4" + ], + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "replication", + "type" : "double" + }, + "replication.max-parallel-tailing-invocations" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum number of concurrently allowed WAL tailing invocations (0 = unlimited).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "replication", + "type" : "uint64" + }, + "replication.quick-keys-limit" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1000000, + "deprecatedIn" : null, + "description" : "Limit at which 'quick' calls to the replication keys API return only the document count for the second run.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.9" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "replication", + "type" : "uint64" + }, + "replication.request-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 600, + "deprecatedIn" : null, + "description" : "The default timeout value for replication requests (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.9", + "v3.5.4" + ], + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "replication", + "type" : "double" + }, + "replication.sync-by-revision" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to use the newer revision-based replication protocol.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "replication", + "type" : "boolean" + }, + "rocksdb.allow-fallocate" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to allow RocksDB to use fallocate calls. If disabled, fallocate calls are bypassed and no pre-allocation is done.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.4.5" + ], + "longDescription" : "Preallocation is turned on by default, but you can\nturn it off for operating system versions that are known to have issues with it.\nThis option only has an effect on operating systems that support\n`fallocate`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.auto-fill-index-caches-on-startup" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to automatically fill the in-memory edge cache with entries on server startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.9.6", + "v3.10.2" + ], + "longDescription" : "Enabling this option may cause additional CPU and\nI/O load. You can limit how many index filling operations can execute\nconcurrently with the `--rocksdb.max-concurrent-index-fill-tasks` startup\noption.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.auto-flush-check-interval" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 1800, + "deprecatedIn" : null, + "description" : "The interval (in seconds) in which auto-flushes of WAL and column family data is executed.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.5" + ], + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "double" + }, + "rocksdb.auto-flush-min-live-wal-files" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 20, + "deprecatedIn" : null, + "description" : "The minimum number of live WAL files that triggers an auto-flush of WAL and column family data.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.5" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.auto-refill-index-caches-on-followers" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether or not to automatically (re-)fill the in-memory index caches on followers as well.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.5" + ], + "longDescription" : "Set this to `false` to only (re-)fill in-memory\nindex caches on leaders and save memory on followers. \nNote that the value of this option should be identical for all DBServers.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.auto-refill-index-caches-on-modify" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to automatically (re-)fill the in-memory edge cache with entries on insert/update/replace/remove operations by default.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.9.6", + "v3.10.2" + ], + "longDescription" : "When documents are added, modified, or removed,\nthese changes are tracked and a background thread tries to update the edge\ncache accordingly if the feature is enabled, by adding new, updating existing,\nor deleting and refilling cache entries.\n\nYou can enable the feature for individual `INSERT`, `UPDATE`, `REPLACE`, and\n`REMOVE` operations in AQL queries, for individual document API requests that\ninsert, update, replace, or remove single or multiple edge documents, as well\nas enable it by default using this startup option.\n\nThe background refilling is done on a best-effort basis and not guaranteed to\nsucceed, for example, if there is no memory available for the cache subsystem,\nor during cache grow/shrink operations. A background thread is used so that\nforeground write operations are not slowed down by a lot. It may still cause\nadditional I/O activity to look up data from the storage engine to repopulate\nthe cache.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.auto-refill-index-caches-queue-capacity" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 131072, + "deprecatedIn" : null, + "description" : "How many changes can be queued at most for automatically refilling the edge cache.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.9.6", + "v3.10.2" + ], + "longDescription" : "This option restricts how many cache entries\nthe background thread for (re-)filling the in-memory edge cache can queue at\nmost. This limits the memory usage for the case of the background thread being\nslower than other operations that invalidate cache entries of edge indexes.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.block-align-data-blocks" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "If enabled, data blocks are aligned on the lesser of page size and block size.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This may waste some memory but may reduce the\nnumber of cross-page I/O operations.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.block-cache-shard-bits" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : -1, + "deprecatedIn" : null, + "description" : "The number of shard bits to use for the block cache (-1 = default value).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The number of bits used to shard the block cache\nto allow concurrent operations. To keep individual shards at a reasonable size\n(i.e. at least 512 KiB), keep this value to at most\n`block-cache-shard-bits / 512 KiB`. Default: `block-cache-size / 2^19`.", + "maxInclusive" : false, + "maxValue" : 20, + "minInclusive" : true, + "minValue" : -1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "int64" + }, + "rocksdb.block-cache-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 19605796454, + "deprecatedIn" : null, + "description" : "The size of block cache (in bytes).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This is the maximum size of the block cache in\nbytes. Increasing this value may improve performance. If there is more than\n4 GiB of RAM in the system, the default value is\n`(system RAM size - 2GiB) * 0.3`.\n\nFor systems with less RAM, the default values are:\n\n- 512 MiB for systems with between 2 and 4 GiB of RAM.\n- 256 MiB for systems with between 1 and 2 GiB of RAM.\n- 128 MiB for systems with less than 1 GiB of RAM.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.bloom-filter-bits-per-key" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The average number of bits to use per key in a Bloom filter.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.3" + ], + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "double" + }, + "rocksdb.cache-index-and-filter-blocks" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "If enabled, the RocksDB block cache quota also includes RocksDB memtable sizes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "longDescription" : "If you set this option to `true`, RocksDB tracks\nall loaded index and filter blocks in the block cache, so that they count\ntowards RocksDB's block cache memory limit.\n\nIf you set this option to `false`, the memory usage for index and filter blocks\nis not accounted for.\n\nThe default value of `--rocksdb.cache-index-and-filter-blocks` was `false` in \nversions before 3.10, and was changed to `true` from version 3.10 onwards.\n\nTo improve stability of memory usage and avoid untracked memory allocations by\nRocksDB, it is recommended to set this option to `true`. Note that tracking\nindex and filter blocks leaves less room for other data in the block cache, so\nin case servers have unused RAM capacity available, it may be useful to increase\nthe overall size of the block cache.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.cache-index-and-filter-blocks-with-high-priority" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "If enabled and `--rocksdb.cache-index-and-filter-blocks` is also enabled, cache index and filter blocks with high priority, making index and filter blocks be less likely to be evicted than data blocks.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.checksum-type" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : "xxHash64", + "deprecatedIn" : null, + "description" : "The checksum type to use for table files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string", + "values" : "Possible values: \"XXH3\", \"crc32c\", \"xxHash\", \"xxHash64\"" + }, + "rocksdb.compaction-read-ahead-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 2097152, + "deprecatedIn" : null, + "description" : "If non-zero, bigger reads are performed when doing compaction. If you run RocksDB on spinning disks, you should set this to at least 2 MB. That way, RocksDB's compaction does sequential instead of random reads.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.compaction-style" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : "level", + "deprecatedIn" : null, + "description" : "The compaction style which is used to pick the next file(s) to be compacted", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string", + "values" : "Possible values: \"fifo\", \"level\", \"none\", \"universal\"" + }, + "rocksdb.compression-type" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "lz4", + "deprecatedIn" : null, + "description" : "The compression algorithm to use within RocksDB.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string", + "values" : "Possible values: \"lz4\", \"lz4hc\", \"none\", \"snappy\"" + }, + "rocksdb.create-sha-files" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable the generation of sha256 files for each .sst file.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.debug-logging" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to enable RocksDB debug logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "If set to `true`, enables verbose logging of\nRocksDB's actions into the logfile written by ArangoDB (if the\n`--rocksdb.use-file-logging` option is off), or RocksDB's own log (if the\n`--rocksdb.use-file-logging` option is on).\n\nThis option is turned off by default, but you can enable it for debugging\nRocksDB internals and performance.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.delayed-write-rate" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "Limit the write rate to the database (in bytes per second) when writing to the last mem-table allowed and if more than 3 mem-tables are allowed, or if a certain number of level-0 files are surpassed and writes need to be slowed down.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.dynamic-level-bytes" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to determine the number of bytes for each level dynamically to minimize space amplification.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If set to `true`, the amount of data in each level\nof the LSM tree is determined dynamically to minimize the space amplification.\nOtherwise, the level sizes are fixed. The dynamic sizing allows RocksDB to\nmaintain a well-structured LSM tree regardless of total data size.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.edge-cache" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : true, + "deprecatedIn" : [ + "v3.10.0" + ], + "description" : "Whether to use the in-memory cache for edges", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.6.4" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.enable-index-compression" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable index compression.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.enable-pipelined-write" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "If enabled, use a two stage write queue for WAL writes and memtable writes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.enable-statistics" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether RocksDB statistics should be enabled.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.encryption-gen-internal-key" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Generate an internal encryption-at-rest key.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.encryption-hardware-acceleration" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Use Intel intrinsics-based encryption, requiring a CPU with the AES-NI instruction set. If turned off, then OpenSSL is used, which may use hardware-accelerated encryption, too.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.encryption-key-generator" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string" + }, + "rocksdb.encryption-key-rotation" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allow encryption key rotation.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.encryption-keyfile" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A file containing an encryption key. If set, encryption is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string" + }, + "rocksdb.encryption-keyfolder" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A folder containing all possible user encryption keys. All keys are used to decrypt the internal keystore.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string" + }, + "rocksdb.enforce-block-cache-size-limit" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "If enabled, strictly enforces the block cache size limit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Whether the maximum size of the RocksDB block\ncache is strictly enforced. You can set this option to limit the memory usage of\nthe block cache to at most the specified size. If inserting a data block into\nthe cache would exceed the cache's capacity, the data block is not inserted.\nIf disabled, a data block may still get inserted into the cache. It is evicted\nlater, but the cache may temporarily grow beyond its capacity limit. \n\nThe default value for `--rocksdb.enforce-block-cache-size-limit` was `false`\nbefore version 3.10, but was changed to `true` from version 3.10 onwards.\n\nTo improve stability of memory usage and prevent exceeding the block cache\ncapacity limit (as configurable via `--rocksdb.block-cache-size`), it is\nrecommended to set this option to `true`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.exclusive-writes" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : [ + "v3.8.0" + ], + "description" : "If enabled, writes are exclusive. This allows the RocksDB engine to mimic the collection locking behavior of the now-removed MMFiles storage engine, but inhibits concurrent write operations.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.4" + ], + "longDescription" : "This option allows you to make all writes to the\nRocksDB storage exclusive and therefore avoid write-write conflicts.\n\nThis option was introduced to open a way to upgrade from the legacy MMFiles to\nthe RocksDB storage engine without modifying client application code.\nYou should avoid enabling this option as the use of exclusive locks on\ncollections introduce a noticeable throughput penalty.\n\n**Note**: The MMFiles engine was removed and this option is a stopgap measure\nonly. This option is thus deprecated, and will be removed in a future\nversion.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.format-version" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 5, + "deprecatedIn" : null, + "description" : "The table format version to use inside RocksDB.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.0" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint32", + "values" : "Possible values: 3, 4, 5" + }, + "rocksdb.intermediate-commit-count" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1000000, + "deprecatedIn" : null, + "description" : "An intermediate commit is performed automatically when this number of operations is reached in a transaction, and a new transaction is started.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.intermediate-commit-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 536870912, + "deprecatedIn" : null, + "description" : "An intermediate commit is performed automatically when a transaction has accumulated operations of this size (in bytes), and a new transaction is started.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.level0-compaction-trigger" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 2, + "deprecatedIn" : null, + "description" : "The number of level-0 files that triggers a compaction.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Compaction of level-0 to level-1 is triggered when\nthis many files exist in level-0. If you set this option to a higher number, it\nmay help bulk writes at the expense of slowing down reads.", + "maxInclusive" : true, + "maxValue" : 9223372036854775807, + "minInclusive" : true, + "minValue" : -9223372036854775808, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "int64" + }, + "rocksdb.level0-slowdown-trigger" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 16, + "deprecatedIn" : null, + "description" : "The number of level-0 files that triggers a write slowdown", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "When this many files accumulate in level-0, writes\nare slowed down to `--rocksdb.delayed-write-rate` to allow compaction to\ncatch up.", + "maxInclusive" : true, + "maxValue" : 9223372036854775807, + "minInclusive" : true, + "minValue" : -9223372036854775808, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "int64" + }, + "rocksdb.level0-stop-trigger" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 256, + "deprecatedIn" : null, + "description" : "The number of level-0 files that triggers a full write stop", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "When this many files accumulate in level-0, writes\nare stopped to allow compaction to catch up.", + "maxInclusive" : true, + "maxValue" : 9223372036854775807, + "minInclusive" : true, + "minValue" : -9223372036854775808, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "int64" + }, + "rocksdb.limit-open-files-at-startup" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Limit the amount of .sst files RocksDB inspects at startup, in order to reduce the startup I/O operations.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.max-background-jobs" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 32, + "deprecatedIn" : null, + "description" : "The maximum number of concurrent background jobs (compactions and flushes).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "The jobs are submitted to the low priority thread\npool. The default value is the number of processors in the system.", + "maxInclusive" : true, + "maxValue" : 2147483647, + "minInclusive" : true, + "minValue" : -2147483648, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "int32" + }, + "rocksdb.max-bytes-for-level-base" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 268435456, + "deprecatedIn" : null, + "description" : "If not using dynamic level sizes, this controls the maximum total data size for level-1 of the LSM tree.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-bytes-for-level-multiplier" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "If not using dynamic level sizes, the maximum number of bytes for level L of the LSM tree can be calculated as max-bytes-for-level-base * (max-bytes-for-level-multiplier ^ (L-1))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : false, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "double" + }, + "rocksdb.max-concurrent-index-fill-tasks" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 4, + "deprecatedIn" : null, + "description" : "The maximum number of index fill tasks that can run concurrently on server startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.9.6", + "v3.10.2" + ], + "longDescription" : "The lower this number, the lower the impact of the\nedge cache filling, but the longer it takes to complete.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-parallel-compactions" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 2, + "deprecatedIn" : null, + "description" : "The maximum number of parallel compactions jobs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.11" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-subcompactions" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 2, + "deprecatedIn" : null, + "description" : "The maximum number of concurrent sub-jobs for a background compaction.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint32" + }, + "rocksdb.max-total-wal-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 83886080, + "deprecatedIn" : null, + "description" : "The maximum total size of WAL files that force a flush of stale column families.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "When reached, force a flush of all column families\nwhose data is backed by the oldest WAL files. If you set this option to a low\nvalue, regular flushing of column family data from memtables is triggered, so\nthat WAL files can be moved to the archive.\n\nIf you set this option to a high value, regular flushing is avoided but may\nprevent WAL files from being moved to the archive and being removed.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-transaction-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 18446744073709551615, + "deprecatedIn" : null, + "description" : "The transaction size limit (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Transactions store all keys and values in RAM, so\nlarge transactions run the risk of causing out-of-memory situations. This\nsetting allows you to ensure that it does not happen by limiting the size of\nany individual transaction. Transactions whose operations would consume more\nRAM than this threshold value are aborted automatically with error 32\n(\"resource limit exceeded\").", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The maximum number of write buffers that build up in memory (default: number of column families + 2 = 9 write buffers). You can only increase the number.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If this number is reached before the buffers can\nbe flushed, writes are slowed or stalled.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-definitions" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the definitions column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-documents" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the documents column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-edge" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the edge column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-fulltext" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the fulltext column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-geo" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the geo column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-primary" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the primary column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-replicated-logs" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the replicated-logs column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-number-vpack" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "If non-zero, overrides the value of `--rocksdb.max-write-buffer-number` for the vpack column family", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.max-write-buffer-size-to-maintain" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum size of immutable write buffers that build up in memory per column family. Larger values mean that more in-memory data can be used for transaction conflict checking (-1 = use automatic default value, 0 = do not keep immutable flushed write buffers, which is the default and usually correct).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.3" + ], + "longDescription" : "The default value `0` restores the memory usage\npattern of version 3.6. This makes RocksDB not keep any flushed immutable\nwrite-buffers in memory.", + "maxInclusive" : true, + "maxValue" : 9223372036854775807, + "minInclusive" : true, + "minValue" : -9223372036854775808, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "int64" + }, + "rocksdb.min-write-buffer-number-to-merge" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The minimum number of write buffers that are merged together before writing to storage.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.minimum-disk-free-bytes" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 16777216, + "deprecatedIn" : null, + "description" : "The minimum number of free disk bytes for considering the server healthy in health checks (0 = disable the check).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.minimum-disk-free-percent" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 0.01, + "deprecatedIn" : null, + "description" : "The minimum percentage of free disk space for considering the server healthy in health checks (0 = disable the check).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 1, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "double" + }, + "rocksdb.num-levels" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 7, + "deprecatedIn" : null, + "description" : "The number of levels for the database in the LSM tree.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 20, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.num-threads-priority-high" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The number of threads for high priority operations (e.g. flush).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The recommended value is to set this equal to\n`max-background-flushes`. The default value is `number of processors / 2`.", + "maxInclusive" : true, + "maxValue" : 64, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint32" + }, + "rocksdb.num-threads-priority-low" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The number of threads for low priority operations (e.g. compaction).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The default value is\n`number of processors / 2`.", + "maxInclusive" : true, + "maxValue" : 256, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint32" + }, + "rocksdb.num-uncompressed-levels" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 2, + "deprecatedIn" : null, + "description" : "The number of levels that do not use compression in the LSM tree.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Levels above the default of `2` use Snappy\ncompression to reduce the disk space requirements for storing data in these\nlevels.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.optimize-filters-for-hits" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether the implementation should optimize the filters mainly for cases where keys are found rather than also optimize for keys missed. You can enable the option if you know that there are very few misses or the performance in the case of misses is not important for your application.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.pending-compactions-slowdown-trigger" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 131072, + "deprecatedIn" : null, + "description" : "The number of pending compaction bytes that triggers a write slowdown.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.5" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.pending-compactions-stop-trigger" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 17179869184, + "deprecatedIn" : null, + "description" : "The number of pending compaction bytes that triggers a full write stop.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.5" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.periodic-compaction-ttl" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 2592000, + "deprecatedIn" : null, + "description" : "Time-to-live (in seconds) for periodic compaction of .sst files, based on the file age (0 = no periodic compaction).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.3" + ], + "longDescription" : "The default value from RocksDB is ~30 days. To\navoid periodic auto-compaction and the I/O caused by it, you can set this\noption to `0`.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.pin-l0-filter-and-index-blocks-in-cache" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "If enabled and `--rocksdb.cache-index-and-filter-blocks` is also enabled, filter and index blocks are pinned and only evicted from cache when the table reader is freed.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.pin-top-level-index-and-filter" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "If enabled and `--rocksdb.cache-index-and-filter-blocks` is also enabled, the top-level index of partitioned filter and index blocks are pinned and only evicted from cache when the table reader is freed", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.prepopulate-block-cache" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Pre-populate block cache on flushes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.recycle-log-file-num" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "If enabled, keep a pool of log files around for recycling.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.reserve-table-builder-memory" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Account for table building memory in block cache.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.reserve-table-reader-memory" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Account for table reader memory in block cache.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.sync-delay-threshold" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 5000, + "deprecatedIn" : null, + "description" : "The threshold for self-observation of WAL disk syncs (in milliseconds, 0 = no warnings). Any WAL disk sync longer ago than this threshold triggers a warning ", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.6.8", + "v3.7.5" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.sync-interval" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 100, + "deprecatedIn" : null, + "description" : "The interval for automatic, non-requested disk syncs (in milliseconds, 0 = turn automatic syncing off)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Automatic synchronization of data from RocksDB's\nwrite-ahead logs to disk is only performed for not-yet synchronized data, and\nonly for operations that have been executed without the `waitForSync`\nattribute.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.table-block-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 16384, + "deprecatedIn" : null, + "description" : "The approximate size (in bytes) of the user data packed per block for uncompressed data.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.target-file-size-base" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 67108864, + "deprecatedIn" : null, + "description" : "Per-file target file size for compaction (in bytes). The actual target file size for each level is `--rocksdb.target-file-size-base` multiplied by `--rocksdb.target-file-size-multiplier` ^ (level - 1)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.1" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.target-file-size-multiplier" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 1, + "deprecatedIn" : null, + "description" : "The multiplier for `--rocksdb.target-file-size`. A value of 1 means that files in different levels will have the same size.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.1" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.throttle" : { + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable write-throttling.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If enabled, dynamically throttles the ingest rate\nof writes if necessary to reduce chances of compactions getting too far behind\nand blocking incoming writes.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.throttle-frequency" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 1000, + "deprecatedIn" : null, + "description" : "The frequency for write-throttle calculations (in milliseconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.5" + ], + "longDescription" : "If the throttling is enabled, it recalculates a new\nmaximum ingestion rate with this frequency.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.throttle-lower-bound-bps" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 10485760, + "deprecatedIn" : null, + "description" : "The lower bound for throttle's write bandwidth (in bytes per second).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.5" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.throttle-max-write-rate" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum write rate enforced by throttle (in bytes per second, 0 = unlimited).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.5" + ], + "longDescription" : "The actual write rate established by the\nthrottling is the minimum of this value and the value that the regular throttle\ncalculation produces, i.e. this option can be used to set a fixed upper bound\non the write rate.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.throttle-scaling-factor" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 17, + "deprecatedIn" : null, + "description" : "The adaptiveness scaling factor for write-throttle calculations.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.5" + ], + "longDescription" : "There is normally no need to change this value.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.throttle-slots" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 120, + "deprecatedIn" : null, + "description" : "The number of historic metrics to use for throttle value calculation.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.5" + ], + "longDescription" : "If throttling is enabled, this parameter controls\nthe number of previous intervals to use for throttle value calculation.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.throttle-slow-down-writes-trigger" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 8, + "deprecatedIn" : null, + "description" : "The number of level 0 files whose payload is not considered in throttle calculations when penalizing the presence of L0 files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.5" + ], + "longDescription" : "There is normally no need to change this value.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.total-write-buffer-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 26141061939, + "deprecatedIn" : null, + "description" : "The maximum total size of in-memory write buffers (0 = unbounded).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The total amount of data to build up in all\nin-memory buffers (backed by log files). You can use this option together with\nthe block cache size configuration option to limit memory usage.\n\nIf set to `0`, the memory usage is not limited.\n\nIf set to a value larger than `0`, this caps memory usage for write buffers but\nmay have an effect on performance. If there is more than 4 GiB of RAM in the\nsystem, the default value is `(system RAM size - 2 GiB) * 0.5`.\n\nFor systems with less RAM, the default values are:\n\n- 512 MiB for systems with between 1 and 4 GiB of RAM.\n- 256 MiB for systems with less than 1 GiB of RAM.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.transaction-lock-stripes" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 32, + "deprecatedIn" : null, + "description" : "The number of lock stripes to use for transaction locks.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.2" + ], + "longDescription" : "You can control the number of lock stripes to use\nfor RocksDB's transaction lock manager with this option. You can use higher\nvalues to reduce a potential contention in the lock manager.\n\nThe option defaults to the number of available cores, but is increased to a\nvalue of `16` if the number of cores is lower.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.transaction-lock-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 1000, + "deprecatedIn" : null, + "description" : "If positive, specifies the wait timeout in milliseconds when a transaction attempts to lock a document. A negative value is not recommended as it can lead to deadlocks (0 = no waiting, < 0 no timeout)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 9223372036854775807, + "minInclusive" : true, + "minValue" : -9223372036854775808, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "int64" + }, + "rocksdb.use-direct-io-for-flush-and-compaction" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Use O_DIRECT for writing files for flush and compaction.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.use-direct-reads" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Use O_DIRECT for reading files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.use-file-logging" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Use a file-base logger for RocksDB's own logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "If set to `true`, enables writing of RocksDB's own\ninformational log files into RocksDB's database directory.\n\nThis option is turned off by default, but you can enable it for debugging\nRocksDB internals and performance.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.use-fsync" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to use fsync calls when writing to disk (set to false for issuing fdatasync calls only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.use-range-delete-in-wal" : { + "category" : "option", + "component" : [ + "dbserver" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable range delete markers in the write-ahead log (WAL). Potentially incompatible with older arangosync versions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.9.3" + ], + "longDescription" : "Controls whether the collection truncate operation\nin the cluster can use RangeDelete operations in RocksDB. Using RangeDeletes is\nfast and reduces the algorithmic complexity of the truncate operation to O(1),\ncompared to O(n) for when this option is turned off (with n being the number of\ndocuments in the collection/shard).\n\nPrevious versions of ArangoDB used RangeDeletes only on a single server, but\nnever in a cluster. \n\nThe default value for this option is `true`, and you should only change this\nvalue in case of emergency. This option is only honored in the cluster.\nSingle server and Active Failover deployments do not use RangeDeletes regardless\nof the value of this option.\n\nNote that it is not guaranteed that all truncate operations use a RangeDelete\noperation. For collections containing a low number of documents, the O(n)\ntruncate method may still be used.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.wal-archive-size-limit" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum total size (in bytes) of archived WAL files to keep on the leader (0 = unlimited).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "A value of `0` does not restrict the size of the\narchive, so the leader removes archived WAL files when there are no replication\nclients needing them. Any non-zero value restricts the size of the WAL files\narchive to about the specified value and trigger WAL archive file deletion once\nthe threshold is reached. You can use this to get rid of archived WAL files in\na disk size-constrained environment.\n\n**Note**: The value is only a threshold, so the archive may get bigger than \nthe configured value until the background thread actually deletes files from\nthe archive. Also note that deletion from the archive only kicks in after\n`--rocksdb.wal-file-timeout-initial` seconds have elapsed after server start.\n\nArchived WAL files are normally deleted automatically after a short while when\nthere is no follower attached that may read from the archive. However, in case\nwhen there are followers attached that may read from the archive, WAL files\nnormally remain in the archive until their contents have been streamed to the\nfollowers. In case there are slow followers that cannot catch up, this causes a\ngrowth of the WAL files archive over time.\n\nYou can use the option to force a deletion of WAL files from the archive even if\nthere are followers attached that may want to read the archive. In case the\noption is set and a leader deletes files from the archive that followers want to\nread, this aborts the replication on the followers. Followers can restart the\nreplication doing a resync, however.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "rocksdb.wal-directory" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Absolute path for RocksDB WAL files. If not set, a subdirectory `journals` inside the database directory is used.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "string" + }, + "rocksdb.wal-file-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "The timeout after which unused WAL files are deleted (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Data of ongoing transactions is stored in RAM.\nTransactions that get too big (in terms of number of operations involved or the\ntotal size of data created or modified by the transaction) are committed\nautomatically. Effectively, this means that big user transactions are split into\nmultiple smaller RocksDB transactions that are committed individually.\nThe entire user transaction does not necessarily have ACID properties in this\ncase.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "double" + }, + "rocksdb.wal-file-timeout-initial" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "single" + ], + "default" : 60, + "deprecatedIn" : null, + "description" : "The initial timeout (in seconds) after which unused WAL files deletion kicks in after server start.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "If you decrease the value, the server starts the\nremoval of obsolete WAL files earlier after server start. This is useful in\ntesting environments that are space-restricted and do not require keeping much\nWAL file data at all.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "double" + }, + "rocksdb.wal-recovery-skip-corrupted" : { + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Skip corrupted records in WAL recovery.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "rocksdb", + "type" : "boolean" + }, + "rocksdb.write-buffer-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver", + "agent", + "single" + ], + "default" : 67108864, + "deprecatedIn" : null, + "description" : "The amount of data to build up in memory before converting to a sorted on-disk file (0 = disabled).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The amount of data to build up in each in-memory\nbuffer (backed by a log file) before closing the buffer and queuing it to be\nflushed to standard storage. Larger values than the default may improve\nperformance, especially for bulk loads.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "rocksdb", + "type" : "uint64" + }, + "server.allow-use-database" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allow to change the database in REST actions. Only needed internally for unit tests.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.authentication" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to use authentication for all client requests.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can set this option to `false` to turn off\nauthentication on the server-side, so that all clients can execute any action\nwithout authorization and privilege checks. You should only do this if you bind\nthe server to `localhost` to not expose it to the public internet", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.authentication-system-only" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Use HTTP authentication only for requests to /_api and /_admin endpoints.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, then HTTP\nauthentication is only required for requests going to URLs starting with `/_`,\nbut not for other endpoints. You can thus use this option to expose custom APIs\nof Foxx microservices without HTTP authentication to the outside world, but\nprevent unauthorized access of ArangoDB APIs and the admin interface.\n\nNote that checking the URL is performed after any database name prefix has been\nremoved. That means, if the request URL is `/_db/_system/myapp/myaction`, the\nURL `/myapp/myaction` is checked for the `/_` prefix.\n\nAuthentication still needs to be enabled for the server via\n`--server.authentication` in order for HTTP authentication to be forced for the\nArangoDB APIs and the web interface. Only setting\n`--server.authentication-system-only` is not enough.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.authentication-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The timeout for the authentication cache (in seconds, 0 = indefinitely).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option is only necessary if you use an\nexternal authentication system like LDAP.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.authentication-unix-sockets" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to use authentication for requests via UNIX domain sockets.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `false`, authentication\nfor requests coming in via UNIX domain sockets is turned off on the server-side.\nClients located on the same host as the ArangoDB server can use UNIX domain\nsockets to connect to the server without authentication. Requests coming in by\nother means (e.g. TCP/IP) are not affected by this option.", + "obsolete" : false, + "os" : [ + "linux", + "macos" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.cluster-metrics-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 10, + "deprecatedIn" : null, + "description" : "Cluster metrics polling timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.0" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint32" + }, + "server.count-descriptors-interval" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 60000, + "deprecatedIn" : null, + "description" : "Controls the interval (in milliseconds) in which open files for the process are determined. Requires `--server.count-descriptors`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.7" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.descriptors-minimum" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 8192, + "deprecatedIn" : null, + "description" : "The minimum number of file descriptors needed to start (0 = no minimum)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.early-connections" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allow requests to a limited set of APIs early during the server startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.endpoint" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + "tcp://0.0.0.0:8529" + ], + "deprecatedIn" : null, + "description" : "Endpoint for client requests (e.g. `http+tcp://127.0.0.1:8529`, or `vst+ssl://192.168.1.1:8529`)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can specify this option multiple times to let\nthe ArangoDB server listen for incoming requests on multiple endpoints.\n\nThe endpoints are normally specified either in ArangoDB's configuration file or\non the command-line with `--server.endpoint`. ArangoDB supports different types\nof endpoints:\n\n- `tcp://ipv4-address:port` - TCP/IP endpoint, using IPv4\n- `tcp://[ipv6-address]:port` - TCP/IP endpoint, using IPv6\n- `ssl://ipv4-address:port` - TCP/IP endpoint, using IPv4, SSL encryption\n- `ssl://[ipv6-address]:port` - TCP/IP endpoint, using IPv6, SSL encryption\n- `unix:///path/to/socket` - Unix domain socket endpoint\n\nIf a TCP/IP endpoint is specified without a port number, then the default port\n(8529) is used.\n\nIf you use SSL-encrypted endpoints, you must also supply the path to a server\ncertificate using the `--ssl.keyfile` option.\n\n```bash\narangod --server.endpoint tcp://127.0.0.1:8529 \\\n --server.endpoint ssl://127.0.0.1:8530 \\\n --ssl.keyfile server.pem /tmp/data-dir\n\n2022-11-07T10:39:29Z [1] INFO [e52b0] {general} ArangoDB 3.10.0 [linux] 64bit, using jemalloc, build tags/v3.10.0-0-g207ec6937e4, VPack 0.1.36, RocksDB 7.2.0, ICU 64.2, V8 7.9.317, OpenSSL 1.1.1q 5 Jul 2022\n2022-11-07T10:39:29Z [1] INFO [75ddc] {general} detected operating system: Linux version 4.15.0-140-generic (buildd@lgw01-amd64-054) (gcc version 7.5.0 (Ubuntu 7.5.0-3ubuntu1~18.04)) #144-Ubuntu SMP Fri Mar 19 14:12:35 UTC 2021\n2022-11-07T10:39:29Z [1] INFO [25362] {memory} Available physical memory: 67513589760 bytes, available cores: 32\n2022-11-07T10:39:29Z [1] INFO [a1c60] {syscall} file-descriptors (nofiles) hard limit is 1048576, soft limit is 1048576\n2022-11-07T10:39:29Z [1] INFO [3bb7d] {cluster} Starting up with role SINGLE\n2022-11-07T10:39:29Z [1] INFO [f6e0e] {aql} memory limit per AQL query automatically set to 40508153856 bytes. to modify this value, please adjust the startup option `--query.memory-limit`\n2022-11-07T10:39:30Z [1] INFO [fe333] {engines} RocksDB recovery starting, scanning WAL starting from sequence number 91, latest sequence number: 202, files in archive: 0\n2022-11-07T10:39:30Z [1] INFO [a4ec8] {engines} RocksDB recovery finished, WAL entries scanned: 116, recovery start sequence number: 91, latest WAL sequence number: 202, max tick value found in WAL: 24, last HLC value found in WAL: 1748833470939922432\n2022-11-07T10:39:30Z [1] INFO [c1b63] {arangosearch} ArangoSearch maintenance: [5..5] commit thread(s), [5..5] consolidation thread(s)\n2022-11-07T10:39:30Z [1] INFO [6ea38] {general} using endpoint 'http+ssl://0.0.0.0:8530' for ssl-encrypted requests\n2022-11-07T10:39:30Z [1] INFO [6ea38] {general} using endpoint 'http+tcp://0.0.0.0:8529' for non-encrypted requests\n2022-11-07T10:39:31Z [1] INFO [cf3f4] {general} ArangoDB (version 3.10.0 [linux]) is ready for business. Have fun!\n```\n\nOn one specific ethernet interface, each port can only be bound\n**exactly once**. You can look up your available interfaces using the `ifconfig`\ncommand on Linux / macOS, and `ipconfig` on Windows. The general names of the\ninterfaces differ between operating systems and the hardware they run on.\nHowever, every host has typically a so called loopback interface, which is a\nvirtual interface. By convention, it always has the address `127.0.0.1` (IPv4)\nor `::1` (IPv6), and can only be reached from the very same host. Ethernet\ninterfaces usually have names like `eth0`, `wlan0`, `eth1:17`, `le0`, or a\nplain text name in Windows.\n\nTo find out which services already use ports (so ArangoDB can't bind them\nanymore), you can use the `netstat` command. It behaves a little different on\neach platform; run it with `-lnpt` on Linux, `-p tcp` on macOS, or with `-an`\non Windows for valuable information.\n\nArangoDB can also do a so called *broadcast bind* using `tcp://0.0.0.0:8529`.\nThis way, it is reachable on all interfaces of the host. This may be useful on\ndevelopment systems that frequently change their network setup, like laptops.\n\nArangoDB can also listen to IPv6 link-local addresses via adding the zone ID\nto the IPv6 address in the form `[ipv6-link-local-address%zone-id]`. However,\nwhat you probably want instead is to bind to a local IPv6 address. Local IPv6\naddresses start with `fd`. If you only see a `fe80:` IPv6 address in your\ninterface configuration but no IPv6 address starting with `fd`, your interface\nhas no local IPv6 address assigned. You can read more about IPv6 link-local\naddresses here: https://en.wikipedia.org/wiki/Link-local_address#IPv6.\n\nTo bind to a link-local and local IPv6 address, run `ifconfig` or equivalent\ncommand. The command lists all interfaces and assigned IP addresses. The\nlink-local address may be `fe80::6257:18ff:fe82:3ec6%eth0` (IPv6 address plus\ninterface name). A local IPv6 address may be `fd12:3456::789a`.\nTo bind ArangoDB to it, start `arangod` with\n`--server.endpoint tcp://[fe80::6257:18ff:fe82:3ec6%eth0]:8529`.\nYou can use `telnet` to test the connection.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.ensure-whitespace-metrics-format" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Set to `true` to ensure whitespace between the exported metric value and the preceeding token (metric name or labels) in the metrics output.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.10.6" + ], + "longDescription" : "Using the whitespace characters in the output may be\nrequired to make the metrics output compatible with some processing tools, although \"\nPrometheus itself doesn't need it.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.export-metrics-api" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable the metrics API.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.6.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.export-read-write-metrics" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to enable metrics for document reads and writes.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.7" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.gid" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Switch to this group ID after reading configuration files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.harden" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Lock down REST APIs that reveal version information or server internals for non-admin users.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.io-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 8, + "deprecatedIn" : null, + "description" : "The number of threads used to handle I/O.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.jwt-secret" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : [ + "v3.3.22", + "v3.4.2" + ], + "description" : "The secret to use when doing JWT authentication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.jwt-secret-folder" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A folder containing one or more JWT secret files to use for JWT authentication.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.0" + ], + "longDescription" : "Files are sorted alphabetically, the first secret\nis used for signing + verifying JWT tokens (_active_ secret), and all other\nsecrets are only used to validate incoming JWT tokens (_passive_ secrets).\nOnly one secret needs to verify a JWT token for it to be accepted.\n\nYou can reload JWT secrets from disk without restarting the server or the nodes\nof a cluster deployment via the `POST /_admin/server/jwt` HTTP API endpoint.\nYou can use this feature to roll out new JWT secrets throughout a cluster.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.jwt-secret-keyfile" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "A file containing the JWT secret to use when doing JWT authentication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses JSON Web Tokens to authenticate\nrequests. Using this option lets you specify a JWT secret stored in a file.\nThe secret must be at most 64 bytes long.\n\n**Warning**: Avoid whitespace characters in the secret because they may get\ntrimmed, leading to authentication problems:\n- Character Tabulation (`\\t`, U+0009)\n- End of Line (`\\n`, U+000A)\n- Line Tabulation (`\\v`, U+000B)\n- Form Feed (`\\f`, U+000C)\n- Carriage Return (`\\r`, U+000D)\n- Space (U+0020)\n- Next Line (U+0085)\n- No-Nreak Space (U+00A0)\n\nIn single server setups, ArangoDB generates a secret if none is specified.\n\nIn cluster deployments which have authentication enabled, a secret must\nbe set consistently across all cluster nodes so they can talk to each other.\n\nArangoDB also supports an `--server.jwt-secret` option to pass the secret\ndirectly (without a file). However, this is discouraged for security\nreasons.\n\nYou can reload JWT secrets from disk without restarting the server or the nodes\nof a cluster deployment via the `POST /_admin/server/jwt` HTTP API endpoint.\nYou can use this feature to roll out new JWT secrets throughout a cluster.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.local-authentication" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to use ArangoDB's built-in authentication system.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `false`, only an\nexternal authentication system like LDAP is used. If set to `true`, also use\nthe built-in system which uses the `_users` system collection.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.maintenance-actions-block" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver" + ], + "default" : 2, + "deprecatedIn" : null, + "description" : "The minimum number of seconds finished actions block duplicates.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 2147483647, + "minInclusive" : true, + "minValue" : -2147483648, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "int32" + }, + "server.maintenance-actions-linger" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver" + ], + "default" : 3600, + "deprecatedIn" : null, + "description" : "The minimum number of seconds finished actions remain in the deque.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 2147483647, + "minInclusive" : true, + "minValue" : -2147483648, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "int32" + }, + "server.maintenance-slow-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver" + ], + "default" : 4, + "deprecatedIn" : null, + "description" : "The maximum number of threads available for slow maintenance actions (long SynchronizeShard and long EnsureIndex).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.3" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint32" + }, + "server.maintenance-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "dbserver" + ], + "default" : 9, + "deprecatedIn" : null, + "description" : "The maximum number of threads available for maintenance actions.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint32" + }, + "server.maximal-queue-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 4096, + "deprecatedIn" : null, + "description" : "The size of the priority 3 FIFO.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can specify the maximum size of the queue for\nasynchronous task execution. If the queue already contains this many tasks, new\ntasks are rejected until other tasks are popped from the queue. Setting this\nvalue may help preventing an instance from being overloaded or from running out\nof memory if the queue is filled up faster than the server can process\nrequests.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.maximal-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum number of request handling threads to run (0 = use system-specific default of 64)", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option determines the maximum number of\nrequest processing threads the server is allowed to start for request handling.\nIf this number of threads is already running, arangod does not start further\nthreads for request handling. The default value is\n`max(32, 2 * available cores)`, so twice the number of CPU cores, but at least\n32 threads.\n\nThe actual number of request processing threads is adjusted dynamically at\nruntime and is between `--server.minimal-threads` and\n`--server.maximal-threads`.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.minimal-threads" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 4, + "deprecatedIn" : null, + "description" : "The minimum number of request handling threads to run.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option determines the minimum number of\nrequest processing threads the server starts and always keeps around.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.ongoing-low-priority-multiplier" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 4, + "deprecatedIn" : null, + "description" : "Controls the number of low priority requests that can be ongoing at a given point in time, relative to the maximum number of request handling threads.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "There are some countermeasures built into\nCoordinators to prevent a cluster from being overwhelmed by too many\nconcurrently executing requests.\n\nIf a request is executed on a Coordinator but needs to wait for some operation\non a DB-Server, the operating system thread executing the request can often\npostpone execution on the Coordinator, put the request to one side and do\nsomething else in the meantime. When the response from the DB-Server arrives,\nanother worker thread continues the work. This is a form of asynchronous\nimplementation, which is great to achieve better thread utilization and enhance\nthroughput.\n\nOn the other hand, this runs the risk that work is started on new requests\nfaster than old ones can be finished off. Before version 3.8, this could\noverwhelm the cluster over time, and lead to out-of-memory situations and other\nunwanted side effects. For example, it could lead to excessive latency for\nindividual requests.\n\nThere is a limit as to how many requests coming from the low priority queue\n(most client requests are of this type), can be executed concurrently.\nThe default value for this is 4 times as many as there are scheduler threads\n(see `--server.minimal-threads` and --server.maximal-threads), which is good\nfor most workloads. Requests in excess of this are not started but remain on\nthe scheduler's input queue (see `--server.maximal-queue-size`).\n\nVery occasionally, 4 is already too much. You would notice this if the latency\nfor individual requests is already too high because the system tries to execute\ntoo many of them at the same time (for example, if they fight for resources).\n\nOn the other hand, in rare cases it is possible that throughput can be improved\nby increasing the value, if latency is not a big issue and all requests\nessentially spend their time waiting, so that a high concurrency is acceptable.\nThis increases memory usage, though.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.prio1-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 4096, + "deprecatedIn" : null, + "description" : "The size of the priority 1 FIFO.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.prio2-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 4096, + "deprecatedIn" : null, + "description" : "The size of the priority 2 FIFO.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.rest-server" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Start a REST server.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.scheduler-queue-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 4096, + "deprecatedIn" : null, + "description" : "The number of simultaneously queued requests inside the scheduler.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.session-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 3600, + "deprecatedIn" : null, + "description" : "The lifetime for tokens (in seconds) that can be obtained from the `POST /_open/auth` endpoint. Used by the web interface for JWT-based sessions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "The web interface uses JWT for authentication.\nHowever, the session are renewed automatically as long as you regularly interact\nwith the web interface in your browser. You are not logged out while actively\nusing it.", + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : false, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.statistics" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to enable statistics gathering and statistics APIs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `false`, then ArangoDB's\nstatistics gathering is turned off. Statistics gathering causes regular\nbackground CPU activity, memory usage, and writes to the storage engine, so\nusing this option to turn statistics off might relieve heavily-loaded instances\na bit.\n\nA side effect of setting this option to `false` is that no statistics are\nshown in the dashboard of ArangoDB's web interface, and that the REST API for\nserver statistics at `/_admin/statistics` returns HTTP 404.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.statistics-all-databases" : { + "category" : "option", + "component" : [ + "coordinator" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Provide cluster statistics in the web interface for all databases.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.statistics-history" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to store statistics in the database.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.9", + "v3.5.1" + ], + "longDescription" : "If you set this option to `false`, then ArangoDB's\nstatistics gathering is turned off. Statistics gathering causes regular\nbackground CPU activity, memory usage, and writes to the storage engine, so\nusing this option to turn statistics off might relieve heavily-loaded instances\na bit.\n\nIf set to `false`, no statistics are shown in the dashboard of ArangoDB's\nweb interface, but the current statistics are available and can be queried\nusing the REST API for server statistics at `/_admin/statistics`.\nThis is less intrusive than setting the `--server.statistics` option to\n`false`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.storage-engine" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "auto", + "deprecatedIn" : null, + "description" : "The storage engine type (note that the MMFiles engine is unavailable since v3.7.0 and cannot be used anymore).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's storage engine is based on RocksDB, see\nhttp://rocksdb.org. It is the only available engine from ArangoDB v3.7 onwards.\n\nThe storage engine type needs to be the same for an entire deployment.\nLive switching of storage engines on already installed systems isn't supported.\nConfiguring the wrong engine (not matching the previously used one) results\nin the server refusing to start. You may use `auto` to let ArangoDB choose the\npreviously used one.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string", + "values" : "Possible values: \"auto\", \"rocksdb\"" + }, + "server.support-info-api" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "admin", + "deprecatedIn" : null, + "description" : "The policy for exposing the support info API.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string", + "values" : "Possible values: \"admin\", \"disabled\", \"jwt\", \"public\"" + }, + "server.uid" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Switch to this user ID after reading configuration files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.unavailability-queue-fill-grade" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0.75, + "deprecatedIn" : null, + "description" : "The queue fill grade from which onwards the server is considered unavailable because of an overload (ratio, 0 = disable)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.6.10", + "v3.7.6" + ], + "longDescription" : "You can use this option to set a high-watermark\nfor the scheduler's queue fill grade, from which onwards the server starts\nreporting unavailability via its availability API.\n\nThis option has a consequence for the `/_admin/server/availability` REST API\nonly, which is often called by load-balancers and other availability probing\nsystems.\n\nThe `/_admin/server/availability` REST API returns HTTP 200 if the fill\ngrade of the scheduler's queue is below the configured value, or HTTP 503 if\nthe fill grade is equal to or above it. This can be used to flag a server as\nunavailable in case it is already highly loaded.\n\nThe default value for this option is `0.75` since version 3.8, i.e. 75%.\n\nTo prevent sending more traffic to an already overloaded server, it can be\nsensible to reduce the default value to even `0.5`. This would mean that\ninstances with a queue longer than 50% of their maximum queue capacity would\nreturn HTTP 503 instead of HTTP 200 when their availability API is probed.", + "maxInclusive" : true, + "maxValue" : 1, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.validate-utf8-strings" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Perform UTF-8 string validation for incoming JSON and VelocyPack data.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.7.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "ssl.cafile" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The CA file used for secure connections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can use this option to specify a file with\nCA certificates that are sent to the client whenever the server requests a\nclient certificate. If you specify a file, the server only accepts client\nrequests with certificates issued by these CAs. Do not specify this option if\nyou want clients to be able to connect without specific certificates.\n\nThe certificates in the file must be PEM-formatted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "string" + }, + "ssl.cipher-list" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "HIGH:!EXPORT:!aNULL@STRENGTH", + "deprecatedIn" : null, + "description" : "The SSL ciphers to use. See the OpenSSL documentation.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can use this option to restrict the server to\ncertain SSL ciphers only, and to define the relative usage preference of SSL\nciphers.\n\nThe format of the option's value is documented in the OpenSSL documentation.\n\nTo check which ciphers are available on your platform, you may use the\nfollowing shell command:\n\n```bash\n> openssl ciphers -v\n\nECDHE-RSA-AES256-SHA SSLv3 Kx=ECDH Au=RSA Enc=AES(256) Mac=SHA1\nECDHE-ECDSA-AES256-SHA SSLv3 Kx=ECDH Au=ECDSA Enc=AES(256) Mac=SHA1\nDHE-RSA-AES256-SHA SSLv3 Kx=DH Au=RSA Enc=AES(256) Mac=SHA1\nDHE-DSS-AES256-SHA SSLv3 Kx=DH Au=DSS Enc=AES(256) Mac=SHA1\nDHE-RSA-CAMELLIA256-SHA SSLv3 Kx=DH Au=RSA Enc=Camellia(256)\nMac=SHA1\n...\n```", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "string" + }, + "ssl.ecdh-curve" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "prime256v1", + "deprecatedIn" : null, + "description" : "The SSL ECDH curve, see the output of \"openssl ecparam -list_curves\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "string" + }, + "ssl.keyfile" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The keyfile used for secure connections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you use SSL-encryption by binding the server to\nan SSL endpoint (e.g. `--server.endpoint ssl://127.0.0.1:8529`), you must use\nthis option to specify the filename of the server's private key. The file must\nbe PEM-formatted and contain both, the certificate and the server's private key.\n\nYou can generate a keyfile using OpenSSL as follows:\n\n```bash\n# create private key in file \"server.key\"\nopenssl genpkey -out server.key -algorithm RSA -pkeyopt rsa_keygen_bits:2048 -aes-128-cbc\n\n# create certificate signing request (csr) in file \"server.csr\"\nopenssl req -new -key server.key -out server.csr\n\n# copy away original private key to \"server.key.org\"\ncp server.key server.key.org\n\n# remove passphrase from the private key\nopenssl rsa -in server.key.org -out server.key\n\n# sign the csr with the key, creates certificate PEM file \"server.crt\"\nopenssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt\n\n# combine certificate and key into single PEM file \"server.pem\"\ncat server.crt server.key > server.pem\n```\n\nYou may use certificates issued by a Certificate Authority or self-signed\ncertificates. Self-signed certificates can be created by a tool of your\nchoice. When using OpenSSL for creating the self-signed certificate, the\nfollowing commands should create a valid keyfile:\n\n```\n-----BEGIN CERTIFICATE-----\n\n(base64 encoded certificate)\n\n-----END CERTIFICATE-----\n-----BEGIN RSA PRIVATE KEY-----\n\n(base64 encoded private key)\n\n-----END RSA PRIVATE KEY-----\n```\n\nFor further information please check the manuals of the tools you use to create\nthe certificate.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "string" + }, + "ssl.options" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 2147485776, + "deprecatedIn" : null, + "description" : "The SSL connection options. See the OpenSSL documentation.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to set various SSL-related\noptions. Individual option values must be combined using bitwise OR.\n\nWhich options are available on your platform is determined by the OpenSSL\nversion you use. The list of options available on your platform might be\nretrieved by the following shell command:\n\n```bash\n > grep \"#define SSL_OP_.*\" /usr/include/openssl/ssl.h\n\n #define SSL_OP_MICROSOFT_SESS_ID_BUG 0x00000001L\n #define SSL_OP_NETSCAPE_CHALLENGE_BUG 0x00000002L\n #define SSL_OP_LEGACY_SERVER_CONNECT 0x00000004L\n #define SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG 0x00000008L\n #define SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG 0x00000010L\n #define SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER 0x00000020L\n ...\n```\n\nA description of the options can be found online in the OpenSSL documentation:\nhttp://www.openssl.org/docs/ssl/SSL_CTX_set_options.html)", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64" + }, + "ssl.prefer-http1-in-alpn" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Allows to let the server prefer HTTP/1.1 over HTTP/2 in ALPN protocol negotiations", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ssl", + "type" : "boolean" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 9, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "Use this option to specify the default encryption\nprotocol to be used. The default value is 9 (generic TLS), which allows the\nnegotiation of the TLS version between the client and the server, dynamically\nchoosing the highest mutually supported version of TLS.\n\nNote that SSLv2 is unsupported as of version 3.4, because of the inherent\nsecurity vulnerabilities in this protocol. Selecting SSLv2 as protocol aborts\nthe startup.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "ssl.require-peer-certificate" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Require a peer certificate from the client before connecting.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ssl", + "type" : "boolean" + }, + "ssl.server-name-indication" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Use a different server keyfile and certificate if the client indicates a specific server name. Format: SERVERNAME=KEYFILENAME", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.0" + ], + "longDescription" : "Sometimes, it is desirable to have the same server\nuse different server keys and certificates when it is contacted under different\nnames. This is what the TLS \"server name\" extension is for. See\nhttps://en.wikipedia.org/wiki/Server_Name_Indication) for details.\nfor details). With this extension, the client can choose a server name, and the\nserver can, using this information during the TLS handshake, use different\nserver keys and certificate chains.\n\nYou can specify the option multiple times. Each value must be a string in the\nformat `SERVERNAME=KEYFILENAME`. Replace `SERVERNAME` by a server name and\n`KEYFILENAME` by the file name of the key file to be used for that server name.\n\nThe format of the keyfile is identical to the one used for the `--ssl.keyfile`\noption. The keyfile used by default is the one in the `--ssl.keyfile` option,\nand only if there is an exact match between one server name given with\n`--ssl.server-name-indication` and the one in the handshake, the server switches\nto the alternative keyfile.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "string..." + }, + "ssl.session-cache" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Enable the session cache for connections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "ssl", + "type" : "boolean" + }, + "supervisor" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Start the server in supervisor mode. Requires --pid-file to be set.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Runs an arangod process as supervisor with another\narangod process as child, which acts as the server. In the event that the server\nunexpectedly terminates due to an internal error, the supervisor automatically\nrestarts the server. Enabling this option implies that the server runs as a\ndaemon.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "tcp.backlog-size" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 64, + "deprecatedIn" : null, + "description" : "Specify the size of the backlog for the `listen` system call.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "The maximum value is platform-dependent.\nIf you specify a value higher than defined in the system header's `SOMAXCONN`\nmay result in a warning on server start. The actual value used by `listen`\nmay also be silently truncated on some platforms (this happens inside the\n`listen` system call).", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "tcp", + "type" : "uint64" + }, + "tcp.reuse-address" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Try to reuse TCP port(s).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, the socket\noption `SO_REUSEADDR` is set on all server endpoints, which is the default.\nIf you set this option to `false`, it is possible that it takes up to a minute\nafter a server has terminated until it is possible for a new server to use the\nsame endpoint again.\n\n**Note**: Under some operating systems, this can be a security risk because it\nmight be possible for another process to bind to the same address and port,\npossibly hijacking network traffic. Under Windows, ArangoDB additionally sets\nthe `SO_EXCLUSIVEADDRUSE` flag as a measure to alleviate this problem.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "tcp", + "type" : "boolean" + }, + "temp.intermediate-results-capacity" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 0, + "deprecatedIn" : null, + "description" : "The maximum capacity (in bytes) to use for ephemeral, intermediate results on disk (0 = unlimited).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "uint64" + }, + "temp.intermediate-results-encryption" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : false, + "deprecatedIn" : null, + "description" : "Encrypt ephemeral, intermediate results on disk.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "temp", + "type" : "boolean" + }, + "temp.intermediate-results-encryption-hardware-acceleration" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Use Intel intrinsics-based encryption, requiring a CPU with the AES-NI instruction set. If turned off, then OpenSSL is used, which may use hardware-accelerated encryption, too.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "temp", + "type" : "boolean" + }, + "temp.intermediate-results-path" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The path for storing ephemeral, intermediate results on disk (empty = not used).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Queries can store intermediate and final results\ntemporarily on disk if a specified threshold is exceeded, to decrease the memory\nusage. Specify a path to a directory for the temporary data to activate the\nspillover feature. The directory must not be located underneath the instance's \ndatabase directory.\n\nThe threshold value to start spilling data onto disk is either a number of rows\nproduced by a query or an amount of memory used in bytes, which you can set as\nquery options (`spillOverThresholdNumRows` and `spillOverThresholdMemoryUsage`).\n\n**Note**: This feature is experimental and is turned off by default.\nAlso, the query results are still built up entirely in memory on Coordinators\nand single servers for non-streaming queries. To avoid the buildup of the entire\nquery result in RAM, use a streaming query.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "temp.intermediate-results-spillover-threshold-memory-usage" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The memory usage threshold (in bytes) after which a spillover from RAM to disk happens for intermediate results (threshold per query executor).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "uint64" + }, + "temp.intermediate-results-spillover-threshold-num-rows" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 5000000, + "deprecatedIn" : null, + "description" : "The number of result rows after which a spillover from RAM to disk happens for intermediate results (threshold per query executor).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "uint64" + }, + "temp.path" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "The path for temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses the path for storing temporary\nfiles, for extracting data from uploaded zip files (e.g. for Foxx services),\nand other things.\n\nIdeally, the temporary path is set to an instance-specific subdirectory of the\noperating system's temporary directory. To avoid data loss, the temporary path\nshould not overlap with any directories that contain important data, for\nexample, the instance's database directory.\n\nIf you set the temporary path to the same directory as the instance's database\ndirectory, a startup error is logged and the startup is aborted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "transaction.streaming-idle-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : 60, + "deprecatedIn" : null, + "description" : "The idle timeout (in seconds) for Stream Transactions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "Stream Transactions automatically expire after\nthis period when no further operations are posted into them. Posting an\noperation into a non-expired Stream Transaction resets the transaction's\ntimeout to the configured idle timeout.", + "maxInclusive" : true, + "maxValue" : 120, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "transaction", + "type" : "double" + }, + "transaction.streaming-lock-timeout" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 8, + "deprecatedIn" : null, + "description" : "The lock timeout (in seconds) in case of parallel access to the same Stream Transaction.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.6.5", + "v3.7.1" + ], + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "transaction", + "type" : "double" + }, + "ttl.frequency" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 30000, + "deprecatedIn" : null, + "description" : "The frequency (in milliseconds) for the TTL background thread invocation (0 = turn the TTL background thread off entirely).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The lower this value, the more frequently the TTL\nbackground thread kicks in and scans all available TTL indexes for expired\ndocuments, and the earlier the expired documents are actually removed.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ttl", + "type" : "uint64" + }, + "ttl.max-collection-removes" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1000000, + "deprecatedIn" : null, + "description" : "The maximum number of documents to remove per collection in each invocation of the TTL thread.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You can configure this value separately from the\ntotal removal amount so that the per-collection time window for locking and\npotential write-write conflicts can be reduced.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ttl", + "type" : "uint64" + }, + "ttl.max-total-removes" : { + "base" : 1, + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : 1000000, + "deprecatedIn" : null, + "description" : "The maximum number of documents to remove per invocation of the TTL thread.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "In order to avoid \"random\" load spikes by the\nbackground thread suddenly kicking in and removing a lot of documents at once,\nyou can cap the number of to-be-removed documents per thread invocation.\n\nThe TTL background thread goes back to sleep once it has removed the configured\nnumber of documents in one iteration. If more candidate documents are left for\nremoval, they are removed in subsequent runs of the background thread.", + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 1, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ttl", + "type" : "uint64" + }, + "uid" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "", + "deprecatedIn" : null, + "description" : "Switch to this user ID after reading the configuration files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "The name (identity) of the user to run the\nserver as.\n\nIf you don't specify this option, the server does not attempt to change its UID,\nso that the UID used by the server is the same as the UID of the user who\nstarted the server.\n\nIf you specify this option, the server changes its UID after opening ports and\nreading configuration files, but before accepting connections or opening other\nfiles (such as recovery files). This is useful if the server must be started\nwith raised privileges (in certain environments) but security considerations\nrequire that these privileges are dropped once the server has started work.\n\n**Note**: You cannot use this option to bypass operating system security.\nIn general, this option (and the related `--gid`) can lower privileges but not\nraise them.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "use-splice-syscall" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "web-interface.proxy-request-check" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Enable proxy request checking.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "web-interface", + "type" : "boolean" + }, + "web-interface.trusted-proxy" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : [ + ], + "deprecatedIn" : null, + "description" : "The list of proxies to trust (can be IP or network). Make sure `--web-interface.proxy-request-check` is enabled.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "web-interface", + "type" : "string..." + }, + "web-interface.version-check" : { + "category" : "option", + "component" : [ + "coordinator", + "single" + ], + "default" : true, + "deprecatedIn" : null, + "description" : "Alert the user if new versions are available.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "web-interface", + "type" : "boolean" + }, + "working-directory" : { + "category" : "option", + "component" : [ + "coordinator", + "dbserver", + "agent", + "single" + ], + "default" : "/var/tmp", + "deprecatedIn" : null, + "description" : "The working directory in daemon mode.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + } +} diff --git a/site/data/3.10/arangodump.json b/site/data/3.10/arangodump.json new file mode 100644 index 0000000000..ef6d674596 --- /dev/null +++ b/site/data/3.10/arangodump.json @@ -0,0 +1,1694 @@ +{ + "all-databases" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Whether to dump all databases.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "batch-size" : { + "base" : 1, + "category" : "option", + "default" : 67108864, + "deprecatedIn" : null, + "description" : "The maximum size for individual data batches (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "check-configuration" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "collection" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Restrict the dump to this collection name (can be specified multiple times).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "compress-output" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Compress files containing collection contents using the gzip format (not compatible with encryption).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.6" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "config" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "dbserver-prefetch-batches" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "Number of batches to prefetch on each dbserver.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.12.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "dbserver-worker-threads" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "Number of worker threads on each dbserver.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.12.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "define" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "dump-data" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to dump collection data.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-dependencies" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "encryption.key-generator" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The program must output 32 bytes of data on the\nstandard output and exit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "encryption.keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You must secure the encryption key file so that\nonly `arangodump`, `arangorestore`, and `arangod` can access it. You should also\nensure that the file is not readable if someone steals your hardware, for\nexample, by encrypting `/mytmpfs` or creating an in-memory file-system under\n`/mytmpfs`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "envelope" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Wrap each document into a {type, data} envelope (this is required for compatibility with v3.7 and before).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "force" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Continue dumping even in the face of some server-side errors.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "ignore-distribute-shards-like-errors" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Continue dumping even if a sharding prototype collection is not backed up, too.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "include-system-collections" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include system collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "initial-batch-size" : { + "base" : 1, + "category" : "option", + "default" : 8388608, + "deprecatedIn" : null, + "description" : "The initial size for individual data batches (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "local-network-threads" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "Number of local network threads, i.e. how many requests are sent in parallel.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.12.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "local-writer-threads" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "Number of local writer threads.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.12.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "log" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.color" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "maskings" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A path to a file with masking definitions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.3.22", + "v3.4.2" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "output-directory" : { + "category" : "option", + "default" : "/dump", + "deprecatedIn" : null, + "description" : "The output directory.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "overwrite" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Overwrite data in the output directory.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "progress" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the progress.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "server.ask-jwt-secret" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "If enabled, you are prompted for a JWT secret. This option is not compatible with --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.authentication" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.connection-timeout" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The connection timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.database" : { + "category" : "option", + "default" : "_system", + "deprecatedIn" : null, + "description" : "The database name to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.endpoint" : { + "category" : "option", + "default" : [ + "tcp://127.0.0.1:8529" + ], + "deprecatedIn" : null, + "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.jwt-secret-keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "If enabled, the JWT secret is loaded from the given file. This option is not compatible with --server.ask-jwt-secret, --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.max-packet-size" : { + "base" : 1, + "category" : "option", + "default" : 1073741824, + "deprecatedIn" : null, + "description" : "The maximum packet size (in bytes) for client/server communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.password" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The password to use when connecting. If not specified and authentication is required, the user is prompted for a password", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.request-timeout" : { + "base" : 1, + "category" : "option", + "default" : 1200, + "deprecatedIn" : null, + "description" : "The request timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.username" : { + "category" : "option", + "default" : "root", + "deprecatedIn" : null, + "description" : "The username to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "shard" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Restrict the dump to this shard (can be specified multiple times).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "split-files" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Split a collection in multiple files to increase throughput.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.12.0" + ], + "longDescription" : "This option only has effect when the option\n`--use-experimental-dump` is set to `true`. Restoring split files also\nrequires an arangorestore version that is capable of restoring data of a\nsingle collection/shard from multiple files.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "threads" : { + "base" : 1, + "category" : "option", + "default" : 32, + "deprecatedIn" : null, + "description" : "The maximum number of collections/shards to process in parallel.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.0" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint32" + }, + "tick-end" : { + "base" : 1, + "category" : "option", + "default" : 0, + "deprecatedIn" : null, + "description" : "Last tick to be included in data dump.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "tick-start" : { + "base" : 1, + "category" : "option", + "default" : 0, + "deprecatedIn" : null, + "description" : "Only include data after this tick.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "use-experimental-dump" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Enable experimental dump behavior.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : true, + "hidden" : true, + "introducedIn" : [ + "v3.12.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "use-splice-syscall" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + } +} diff --git a/site/data/3.10/arangoexport.json b/site/data/3.10/arangoexport.json new file mode 100644 index 0000000000..78cafd21ed --- /dev/null +++ b/site/data/3.10/arangoexport.json @@ -0,0 +1,1460 @@ +{ + "check-configuration" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "collection" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Restrict the export to this collection name (can be specified multiple times).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "compress-output" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Compress files containing collection contents using the gzip format.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.8", + "v3.5.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "config" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "custom-query" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "An AQL query to run.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "custom-query-bindvars" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The bind parameters to be used with the `--custom-query` or `--custom-query-file` option.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "custom-query-file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A path to a file with the custom query to be used.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "custom-query-max-runtime" : { + "base" : 1, + "category" : "option", + "default" : 0, + "deprecatedIn" : null, + "description" : "The runtime threshold for AQL queries (in seconds, 0 = no limit).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "double" + }, + "define" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "documents-per-batch" : { + "base" : 1, + "category" : "option", + "default" : 1000, + "deprecatedIn" : null, + "description" : "The number of documents to return in each batch.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "dump-dependencies" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "encryption.key-generator" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The program must output 32 bytes of data on the\nstandard output and exit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "encryption.keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You must secure the encryption key file so that\nonly `arangodump`, `arangorestore`, and `arangod` can access it. You should also\nensure that the file is not readable if someone steals your hardware, for\nexample, by encrypting `/mytmpfs` or creating an in-memory file-system under\n`/mytmpfs`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "escape-csv-formulae" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Prefix string cells in CSV output with extra single quote to prevent formula injection.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "fields" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A comma-separated list of fields to export to a CSV file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "graph-name" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The name of a graph to export.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "log" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.color" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "output-directory" : { + "category" : "option", + "default" : "/export", + "deprecatedIn" : null, + "description" : "The output directory.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "overwrite" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Overwrite the data in the output directory.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "progress" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the progress.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "server.authentication" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.connection-timeout" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The connection timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.database" : { + "category" : "option", + "default" : "_system", + "deprecatedIn" : null, + "description" : "The database name to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.endpoint" : { + "category" : "option", + "default" : [ + "tcp://127.0.0.1:8529" + ], + "deprecatedIn" : null, + "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.max-packet-size" : { + "base" : 1, + "category" : "option", + "default" : 1073741824, + "deprecatedIn" : null, + "description" : "The maximum packet size (in bytes) for client/server communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.password" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The password to use when connecting. If not specified and authentication is required, the user is prompted for a password", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.request-timeout" : { + "base" : 1, + "category" : "option", + "default" : 1200, + "deprecatedIn" : null, + "description" : "The request timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.username" : { + "category" : "option", + "default" : "root", + "deprecatedIn" : null, + "description" : "The username to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "temp.path" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path for temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses the path for storing temporary\nfiles, for extracting data from uploaded zip files (e.g. for Foxx services),\nand other things.\n\nIdeally, the temporary path is set to an instance-specific subdirectory of the\noperating system's temporary directory. To avoid data loss, the temporary path\nshould not overlap with any directories that contain important data, for\nexample, the instance's database directory.\n\nIf you set the temporary path to the same directory as the instance's database\ndirectory, a startup error is logged and the startup is aborted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "type" : { + "category" : "option", + "default" : "json", + "deprecatedIn" : null, + "description" : "type of export", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string", + "values" : "Possible values: \"csv\", \"json\", \"jsonl\", \"xgmml\", \"xml\"" + }, + "use-splice-syscall" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "xgmml-label-attribute" : { + "category" : "option", + "default" : "label", + "deprecatedIn" : null, + "description" : "Specify the document attribute to use as the XGMML label.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "xgmml-label-only" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Export XGMML label only.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + } +} diff --git a/site/data/3.10/arangoimport.json b/site/data/3.10/arangoimport.json new file mode 100644 index 0000000000..eb23dfa95d --- /dev/null +++ b/site/data/3.10/arangoimport.json @@ -0,0 +1,1713 @@ +{ + "auto-rate-limit" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Adjust the data loading rate automatically, starting at `--batch-size` bytes per thread per second.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.11" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "backslash-escape" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use backslash as the escape character for quotes. Used for CSV and TSV imports.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "batch-size" : { + "base" : 1, + "category" : "option", + "default" : 8388608, + "deprecatedIn" : null, + "description" : "The size for individual data batches (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "check-configuration" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "collection" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The name of the collection to import into.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "config" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "convert" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Convert the strings `null`, `false`, `true` and strings containing numbers into non-string types. For CSV and TSV only.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "create-collection" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "create collection if it does not yet exist", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "create-collection-type" : { + "category" : "option", + "default" : "document", + "deprecatedIn" : null, + "description" : "The type of the collection if it needs to be created (edge or document).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string", + "values" : "Possible values: \"document\", \"edge\"" + }, + "create-database" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Create the target database if it does not exist.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "datatype" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Force a specific datatype for an attribute (null/boolean/number/string) using the syntax \"attribute=type\". For CSV and TSV only. Takes precedence over `--convert`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "define" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "dump-dependencies" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "encryption.key-generator" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The program must output 32 bytes of data on the\nstandard output and exit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "encryption.keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You must secure the encryption key file so that\nonly `arangodump`, `arangorestore`, and `arangod` can access it. You should also\nensure that the file is not readable if someone steals your hardware, for\nexample, by encrypting `/mytmpfs` or creating an in-memory file-system under\n`/mytmpfs`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The file to import (\"-\" for stdin).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "from-collection-prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The collection name prefix to prepend to all values in the `_from` attribute.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "headers-file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The file to read the CSV or TSV header from. If specified, no header is expected in the regular input file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "ignore-missing" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Ignore missing columns in CSV and TSV input.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "latency" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show 10 second latency statistics (values in microseconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "log" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.color" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "merge-attributes" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Merge attributes into new document attribute (e.g. \"mergedAttribute=[someAttribute]-[otherAttribute]\") (CSV and TSV only)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.1" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "on-duplicate" : { + "category" : "option", + "default" : "error", + "deprecatedIn" : null, + "description" : "The action to perform when a unique key constraint violation occurs. Possible values: ignore, replace, update, error", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string", + "values" : "Possible values: \"error\", \"ignore\", \"replace\", \"update\"" + }, + "overwrite" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Overwrite the collection if it exists. WARNING: This removes any data from the collection!", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "overwrite-collection-prefix" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "If the collection name is already prefixed, overwrite the prefix. Only useful in combination with `--from-collection-prefix` / `--to-collection-prefix`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "progress" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the progress.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "quote" : { + "category" : "option", + "default" : "\"", + "deprecatedIn" : null, + "description" : "Quote character(s). Used for CSV and TSV.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "remove-attribute" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "remove an attribute before inserting documents into collection (for CSV, TSV and JSON only)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "separator" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The field separator. Used for CSV and TSV imports. Defaults to a comma (CSV) or a tabulation character (TSV).", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "server.authentication" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.connection-timeout" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The connection timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.database" : { + "category" : "option", + "default" : "_system", + "deprecatedIn" : null, + "description" : "The database name to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.endpoint" : { + "category" : "option", + "default" : [ + "tcp://127.0.0.1:8529" + ], + "deprecatedIn" : null, + "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.max-packet-size" : { + "base" : 1, + "category" : "option", + "default" : 1073741824, + "deprecatedIn" : null, + "description" : "The maximum packet size (in bytes) for client/server communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.password" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The password to use when connecting. If not specified and authentication is required, the user is prompted for a password", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.request-timeout" : { + "base" : 1, + "category" : "option", + "default" : 1200, + "deprecatedIn" : null, + "description" : "The request timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.username" : { + "category" : "option", + "default" : "root", + "deprecatedIn" : null, + "description" : "The username to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "skip-lines" : { + "base" : 1, + "category" : "option", + "default" : 0, + "deprecatedIn" : null, + "description" : "The number of lines to skip of the input file (CSV and TSV only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "skip-validation" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Skip document schema validation during import.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "temp.path" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path for temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses the path for storing temporary\nfiles, for extracting data from uploaded zip files (e.g. for Foxx services),\nand other things.\n\nIdeally, the temporary path is set to an instance-specific subdirectory of the\noperating system's temporary directory. To avoid data loss, the temporary path\nshould not overlap with any directories that contain important data, for\nexample, the instance's database directory.\n\nIf you set the temporary path to the same directory as the instance's database\ndirectory, a startup error is logged and the startup is aborted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "threads" : { + "base" : 1, + "category" : "option", + "default" : 32, + "deprecatedIn" : null, + "description" : "Number of parallel import threads.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint32" + }, + "to-collection-prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The collection name prefix to prepend to all values in the `_to` attribute.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "translate" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Translate an attribute name using the syntax \"from=to\". For CSV and TSV only.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "type" : { + "category" : "option", + "default" : "json", + "deprecatedIn" : null, + "description" : "The format of import file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string", + "values" : "Possible values: \"auto\", \"csv\", \"json\", \"jsonl\", \"tsv\"" + }, + "use-splice-syscall" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + } +} diff --git a/site/data/3.10/arangoinspect.json b/site/data/3.10/arangoinspect.json new file mode 100644 index 0000000000..52821d0eef --- /dev/null +++ b/site/data/3.10/arangoinspect.json @@ -0,0 +1,2000 @@ +{ + "check-configuration" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "config" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "console.audit-file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The audit log file to save commands and results to.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "console", + "type" : "string" + }, + "console.auto-complete" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Enable auto-completion.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.colors" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Enable color support.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.history" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to load and persist command-line history.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.pager" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Enable paging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.pager-command" : { + "category" : "option", + "default" : "less -X -R -F -L", + "deprecatedIn" : null, + "description" : "The pager command.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "console", + "type" : "string" + }, + "console.pretty-print" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Enable pretty-printing.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.prompt" : { + "category" : "option", + "default" : "%E@%d> ", + "deprecatedIn" : null, + "description" : "The prompt used in REPL (placeholders: %t = the current time as timestamp, %p = the duration of last command in seconds, %d = the name of the current database, %e = the current endpoint, %E = the current endpoint without the protocol, %u = the current user", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "console", + "type" : "string" + }, + "default-language" : { + "category" : "option", + "default" : "", + "deprecatedIn" : [ + "v3.10.0" + ], + "description" : "An ISO-639 language code. You can only set this option once, when initializing the database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "The default language is used for sorting and\ncomparing strings. The language value is a two-letter language code (ISO-639) or\nit is composed by a two-letter language code followed by a two letter country\ncode (ISO-3166). For example: `de`, `en`, `en_US`, `en_UK`.\n\nThe default is the system locale of the platform.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "default-language-check" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Check if `--icu-language` / `--default-language` matches the stored language.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "define" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "dump-dependencies" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "encryption.key-generator" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The program must output 32 bytes of data on the\nstandard output and exit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "encryption.keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You must secure the encryption key file so that\nonly `arangodump`, `arangorestore`, and `arangod` can access it. You should also\nensure that the file is not readable if someone steals your hardware, for\nexample, by encrypting `/mytmpfs` or creating an in-memory file-system under\n`/mytmpfs`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "icu-language" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "An ICU locale ID to set a language and optionally additional properties that affect string comparisons and sorting. You can only set this option once, when initializing the database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.9.1" + ], + "longDescription" : "With this option, you can get the sorting and\ncomparing order exactly as it is defined in the ICU standard. The language value\ncan be a two-letter language code (ISO-639), a two-letter language code followed\nby a two letter country code (ISO-3166), or any other valid ICU locale\ndefinition. For example: `de`, `en`, `en_US`, `en_UK`,\n`de_AT@collation=phonebook`.\n\nFor the Swedish language (`sv`), for instance, the correct ICU-based sorting\norder for letters is `'a','A','b','B','z','Z','å','Ä','ö','Ö'`. To get this\norder, use `--icu-language sv`. If you use `--default-language sv` instead, the\nsorting order will be `\"A\", \"a\", \"B\", \"b\", \"Z\", \"z\", \"å\", \"Ä\", \"Ö\", \"ö\"`.\n\n**Note**: You can use only one of the language options, either `--icu-language`\nor `--default-language`. Setting both of them results in an error.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "javascript.allow-external-process-control" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Allow the execution and control of external processes from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.allow-port-testing" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Allow the testing of ports from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.check-syntax" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Check the syntax of the JavaScript code from the specified file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.client-module" : { + "category" : "option", + "default" : "inspector.js", + "deprecatedIn" : null, + "description" : "The client module to use at startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.copy-directory" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The target directory to copy files from `--javascript.startup-directory` to (only used if `--javascript.copy-installation` is enabled).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.copy-installation" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Copy the contents of `--javascript.startup-directory`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.current-module-directory" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Add the current directory to the module path.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.endpoints-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Endpoints that can be connected to via the `@arangodb/request` module in JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.endpoints-denylist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Endpoints that cannot be connected to via the `@arangodb/request` module in JavaScript actions (if not in the allowlist).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.environment-variables-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Environment variables that are accessible in JavaScript.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.environment-variables-denylist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Environment variables that are inaccessible in JavaScript (if not in the allowlist).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.execute" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Execute the JavaScript code from the specified file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.execute-string" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Execute the JavaScript code from the specified string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.files-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Filesystem paths that are accessible from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.gc-interval" : { + "base" : 1, + "category" : "option", + "default" : 50, + "deprecatedIn" : null, + "description" : "Request-based garbage collection interval (each n-th command).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.harden" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Disable access to JavaScript functions in the internal module: getPid() and logLevel().", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.module-directory" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Additional paths containing JavaScript modules.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.run-main" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Execute main function.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.script-parameter" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Script parameter.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.startup-directory" : { + "category" : "option", + "default" : "/usr/share/arangodb3/js", + "deprecatedIn" : null, + "description" : "The startup paths containing the JavaScript files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.startup-options-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Startup options whose names match this regular expression are allowed and exposed to JavaScript.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.startup-options-denylist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Startup options whose names match this regular expression are not exposed (if not in the allowlist) to JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.unit-test-filter" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Filter the test cases in the test suite.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.unit-tests" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Do not start as a shell, run unit tests instead.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.v8-max-heap" : { + "base" : 1, + "category" : "option", + "default" : 3072, + "deprecatedIn" : null, + "description" : "The maximal heap size (in MiB).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.v8-options" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Options to pass to V8.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can optionally pass arguments to the V8\nJavaScript engine. The V8 engine runs with the default settings unless you\nexplicitly specify them. The options are forwarded to the V8 engine, which\nparses them on its own. Passing invalid options may result in an error being\nprinted on stderr and the option being ignored.\n\nYou need to pass the options as one string, with V8 option names being prefixed\nwith two hyphens. Multiple options need to be separated by whitespace. To get\na list of all available V8 options, you can use the value `\"--help\"` as follows:\n\n```\n--javascript.v8-options=\"--help\"\n```\n\nAnother example of specific V8 options being set at startup:\n\n```\n--javascript.v8-options=\"--log --no-logfile-per-isolate --logfile=v8.log\"\n```\n\nNames and features or usable options depend on the version of V8 being used, and\nmight change in the future if a different version of V8 is being used in\nArangoDB. Not all options offered by V8 might be sensible to use in the context\nof ArangoDB. Use the specific options only if you are sure that they are not\nharmful for the regular database operation.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "jslint" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Do not start as a shell, run jslint instead.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.color" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "quiet" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Silent startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "server.ask-jwt-secret" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "If enabled, you are prompted for a JWT secret. This option is not compatible with --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.authentication" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.connection-timeout" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The connection timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.database" : { + "category" : "option", + "default" : "_system", + "deprecatedIn" : null, + "description" : "The database name to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.endpoint" : { + "category" : "option", + "default" : [ + "tcp://127.0.0.1:8529" + ], + "deprecatedIn" : null, + "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.jwt-secret-keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "If enabled, the JWT secret is loaded from the given file. This option is not compatible with --server.ask-jwt-secret, --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.max-packet-size" : { + "base" : 1, + "category" : "option", + "default" : 1073741824, + "deprecatedIn" : null, + "description" : "The maximum packet size (in bytes) for client/server communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.password" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The password to use when connecting. If not specified and authentication is required, the user is prompted for a password", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.request-timeout" : { + "base" : 1, + "category" : "option", + "default" : 1200, + "deprecatedIn" : null, + "description" : "The request timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.username" : { + "category" : "option", + "default" : "root", + "deprecatedIn" : null, + "description" : "The username to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "temp.path" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path for temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses the path for storing temporary\nfiles, for extracting data from uploaded zip files (e.g. for Foxx services),\nand other things.\n\nIdeally, the temporary path is set to an instance-specific subdirectory of the\noperating system's temporary directory. To avoid data loss, the temporary path\nshould not overlap with any directories that contain important data, for\nexample, the instance's database directory.\n\nIf you set the temporary path to the same directory as the instance's database\ndirectory, a startup error is logged and the startup is aborted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "use-splice-syscall" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + } +} diff --git a/site/data/3.10/arangorestore.json b/site/data/3.10/arangorestore.json new file mode 100644 index 0000000000..f636feba0b --- /dev/null +++ b/site/data/3.10/arangorestore.json @@ -0,0 +1,1700 @@ +{ + "all-databases" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Restore the data of all databases.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "batch-size" : { + "base" : 1, + "category" : "option", + "default" : 8388608, + "deprecatedIn" : null, + "description" : "The maximum size for individual data batches (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "check-configuration" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "cleanup-duplicate-attributes" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Clean up duplicate attributes (use first specified value) in input documents instead of making the restore operation fail.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.3.22", + "v3.4.2" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "collection" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Restrict the restore to this collection name (can be specified multiple times).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "config" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "continue" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Continue the restore operation.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "create-collection" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Create collection structure.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "create-database" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Create the target database if it does not exist.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "default-number-of-shards" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : [ + "v3.3.22", + "v3.4.2" + ], + "description" : "The default `numberOfShards` value if not specified in the dump.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "default-replication-factor" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : [ + "v3.3.22", + "v3.4.2" + ], + "description" : "The default `replicationFactor` value if not specified in the dump.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint64" + }, + "define" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "dump-dependencies" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "enable-revision-trees" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Enable revision trees for new collections if the collection attributes `syncByRevision` and `usesRevisionsAsDocumentIds` are missing.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.7" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "encryption.key-generator" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The program must output 32 bytes of data on the\nstandard output and exit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "encryption.keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You must secure the encryption key file so that\nonly `arangodump`, `arangorestore`, and `arangod` can access it. You should also\nensure that the file is not readable if someone steals your hardware, for\nexample, by encrypting `/mytmpfs` or creating an in-memory file-system under\n`/mytmpfs`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "envelope" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "wrap each document into a {type, data} envelope (this is required for compatibility with v3.7 and before).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "force" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Continue the restore even in the face of some server-side errors.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "force-same-database" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Force the same database name as in the source `dump.json` file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "ignore-distribute-shards-like-errors" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Continue the restore even if the sharding prototype collection is missing.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "import-data" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Import data into collection.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "include-system-collections" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include system collections.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "initial-connect-retries" : { + "base" : 1, + "category" : "option", + "default" : 3, + "deprecatedIn" : null, + "description" : "The number of connect retries for the initial connection.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.13", + "v3.8.1" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint32" + }, + "input-directory" : { + "category" : "option", + "default" : "/dump", + "deprecatedIn" : null, + "description" : "The input directory.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "log" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.color" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "number-of-shards" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Override the `numberOfShards` value (can be specified multiple times, e.g. --number-of-shards 2 --number-of-shards myCollection=3).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.3.22", + "v3.4.2" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "overwrite" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Overwrite collections if they exist.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "progress" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the progress.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "replication-factor" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Override the `replicationFactor` value (can be specified multiple times, e.g. --replication-factor 2 --replication-factor myCollection=3).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.3.22", + "v3.4.2" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "server.ask-jwt-secret" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "If enabled, you are prompted for a JWT secret. This option is not compatible with --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.authentication" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.connection-timeout" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The connection timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.database" : { + "category" : "option", + "default" : "_system", + "deprecatedIn" : null, + "description" : "The database name to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.endpoint" : { + "category" : "option", + "default" : [ + "tcp://127.0.0.1:8529" + ], + "deprecatedIn" : null, + "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp:// or unix://", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.jwt-secret-keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "If enabled, the JWT secret is loaded from the given file. This option is not compatible with --server.ask-jwt-secret, --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.max-packet-size" : { + "base" : 1, + "category" : "option", + "default" : 1073741824, + "deprecatedIn" : null, + "description" : "The maximum packet size (in bytes) for client/server communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.password" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The password to use when connecting. If not specified and authentication is required, the user is prompted for a password", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.request-timeout" : { + "base" : 1, + "category" : "option", + "default" : 1200, + "deprecatedIn" : null, + "description" : "The request timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.username" : { + "category" : "option", + "default" : "root", + "deprecatedIn" : null, + "description" : "The username to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "temp.path" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path for temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses the path for storing temporary\nfiles, for extracting data from uploaded zip files (e.g. for Foxx services),\nand other things.\n\nIdeally, the temporary path is set to an instance-specific subdirectory of the\noperating system's temporary directory. To avoid data loss, the temporary path\nshould not overlap with any directories that contain important data, for\nexample, the instance's database directory.\n\nIf you set the temporary path to the same directory as the instance's database\ndirectory, a startup error is logged and the startup is aborted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "threads" : { + "base" : 1, + "category" : "option", + "default" : 32, + "deprecatedIn" : null, + "description" : "The maximum number of collections to process in parallel.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.0" + ], + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "uint32" + }, + "use-splice-syscall" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "view" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Restrict the restore to this view name (can be specified multiple times).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + } +} diff --git a/site/data/3.10/arangosh.json b/site/data/3.10/arangosh.json new file mode 100644 index 0000000000..e8cd651500 --- /dev/null +++ b/site/data/3.10/arangosh.json @@ -0,0 +1,2023 @@ +{ + "check-configuration" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Check the configuration and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "config" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "configuration" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The configuration file or \"none\".", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "console.audit-file" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The audit log file to save commands and results to.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "console", + "type" : "string" + }, + "console.auto-complete" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Enable auto-completion.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.colors" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Enable color support.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.history" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Whether to load and persist command-line history.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.pager" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Enable paging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.pager-command" : { + "category" : "option", + "default" : "less -X -R -F -L", + "deprecatedIn" : null, + "description" : "The pager command.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "console", + "type" : "string" + }, + "console.pretty-print" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Enable pretty-printing.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "console", + "type" : "boolean" + }, + "console.prompt" : { + "category" : "option", + "default" : "%E@%d> ", + "deprecatedIn" : null, + "description" : "The prompt used in REPL (placeholders: %t = the current time as timestamp, %p = the duration of last command in seconds, %d = the name of the current database, %e = the current endpoint, %E = the current endpoint without the protocol, %u = the current user", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "console", + "type" : "string" + }, + "default-language" : { + "category" : "option", + "default" : "", + "deprecatedIn" : [ + "v3.10.0" + ], + "description" : "An ISO-639 language code. You can only set this option once, when initializing the database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "The default language is used for sorting and\ncomparing strings. The language value is a two-letter language code (ISO-639) or\nit is composed by a two-letter language code followed by a two letter country\ncode (ISO-3166). For example: `de`, `en`, `en_US`, `en_UK`.\n\nThe default is the system locale of the platform.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "default-language-check" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Check if `--icu-language` / `--default-language` matches the stored language.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "define" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Define a value for a `@key@` entry in the configuration file using the syntax `\"key=value\"`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "dump-dependencies" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump the dependency graph of the feature phases (internal) and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "dump-options" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Dump all available startup options in JSON format and exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "encryption.key-generator" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "A program providing the encryption key on stdout. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "The program must output 32 bytes of data on the\nstandard output and exit.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "encryption.keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path to the file that contains the encryption key. Must contain 32 bytes of data. If set, encryption at rest is enabled.", + "dynamic" : false, + "enterpriseOnly" : true, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "You must secure the encryption key file so that\nonly `arangodump`, `arangorestore`, and `arangod` can access it. You should also\nensure that the file is not readable if someone steals your hardware, for\nexample, by encrypting `/mytmpfs` or creating an in-memory file-system under\n`/mytmpfs`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "encryption", + "type" : "string" + }, + "icu-language" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "An ICU locale ID to set a language and optionally additional properties that affect string comparisons and sorting. You can only set this option once, when initializing the database.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.9.1" + ], + "longDescription" : "With this option, you can get the sorting and\ncomparing order exactly as it is defined in the ICU standard. The language value\ncan be a two-letter language code (ISO-639), a two-letter language code followed\nby a two letter country code (ISO-3166), or any other valid ICU locale\ndefinition. For example: `de`, `en`, `en_US`, `en_UK`,\n`de_AT@collation=phonebook`.\n\nFor the Swedish language (`sv`), for instance, the correct ICU-based sorting\norder for letters is `'a','A','b','B','z','Z','å','Ä','ö','Ö'`. To get this\norder, use `--icu-language sv`. If you use `--default-language sv` instead, the\nsorting order will be `\"A\", \"a\", \"B\", \"b\", \"Z\", \"z\", \"å\", \"Ä\", \"Ö\", \"ö\"`.\n\n**Note**: You can use only one of the language options, either `--icu-language`\nor `--default-language`. Setting both of them results in an error.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string" + }, + "javascript.allow-external-process-control" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Allow the execution and control of external processes from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.allow-port-testing" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Allow the testing of ports from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.check-syntax" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Check the syntax of the JavaScript code from the specified file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.client-module" : { + "category" : "option", + "default" : "client.js", + "deprecatedIn" : null, + "description" : "The client module to use at startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.copy-directory" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The target directory to copy files from `--javascript.startup-directory` to (only used if `--javascript.copy-installation` is enabled).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.copy-installation" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Copy the contents of `--javascript.startup-directory`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.current-module-directory" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Add the current directory to the module path.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.endpoints-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Endpoints that can be connected to via the `@arangodb/request` module in JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.endpoints-denylist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Endpoints that cannot be connected to via the `@arangodb/request` module in JavaScript actions (if not in the allowlist).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.environment-variables-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Environment variables that are accessible in JavaScript.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.environment-variables-denylist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Environment variables that are inaccessible in JavaScript (if not in the allowlist).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.execute" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Execute the JavaScript code from the specified file.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.execute-string" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Execute the JavaScript code from the specified string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.files-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Filesystem paths that are accessible from within JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.gc-interval" : { + "base" : 1, + "category" : "option", + "default" : 50, + "deprecatedIn" : null, + "description" : "Request-based garbage collection interval (each n-th command).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.harden" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Disable access to JavaScript functions in the internal module: getPid() and logLevel().", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.module-directory" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Additional paths containing JavaScript modules.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.run-main" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Execute main function.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "javascript", + "type" : "boolean" + }, + "javascript.script-parameter" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Script parameter.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.startup-directory" : { + "category" : "option", + "default" : "/usr/share/arangodb3/js", + "deprecatedIn" : null, + "description" : "The startup paths containing the JavaScript files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.startup-options-allowlist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Startup options whose names match this regular expression are allowed and exposed to JavaScript.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.startup-options-denylist" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Startup options whose names match this regular expression are not exposed (if not in the allowlist) to JavaScript actions.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.unit-test-filter" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Filter the test cases in the test suite.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string" + }, + "javascript.unit-tests" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Do not start as a shell, run unit tests instead.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "javascript.v8-max-heap" : { + "base" : 1, + "category" : "option", + "default" : 3072, + "deprecatedIn" : null, + "description" : "The maximal heap size (in MiB).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "uint64" + }, + "javascript.v8-options" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Options to pass to V8.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can optionally pass arguments to the V8\nJavaScript engine. The V8 engine runs with the default settings unless you\nexplicitly specify them. The options are forwarded to the V8 engine, which\nparses them on its own. Passing invalid options may result in an error being\nprinted on stderr and the option being ignored.\n\nYou need to pass the options as one string, with V8 option names being prefixed\nwith two hyphens. Multiple options need to be separated by whitespace. To get\na list of all available V8 options, you can use the value `\"--help\"` as follows:\n\n```\n--javascript.v8-options=\"--help\"\n```\n\nAnother example of specific V8 options being set at startup:\n\n```\n--javascript.v8-options=\"--log --no-logfile-per-isolate --logfile=v8.log\"\n```\n\nNames and features or usable options depend on the version of V8 being used, and\nmight change in the future if a different version of V8 is being used in\nArangoDB. Not all options offered by V8 might be sensible to use in the context\nof ArangoDB. Use the specific options only if you are sure that they are not\nharmful for the regular database operation.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "javascript", + "type" : "string..." + }, + "jslint" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Do not start as a shell, run jslint instead.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Set the topic-specific log level, using `--log level` for the general topic or `--log topic=level` for the specified topic (can be specified multiple times). Available log levels: fatal, error, warning, info, debug, trace.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "", + "type" : "string..." + }, + "log.color" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use colors for TTY logging.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-control-chars" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Escape control characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "This option applies to the control characters,\nthat have hex codes below `\\x20`, and also the character `DEL` with hex code\n`\\x7f`.\n\nIf you set this option to `false`, control characters are retained when they\nhave a visible representation, and replaced with a space character in case they\ndo not have a visible representation. For example, the control character `\\n`\nis visible, so a `\\n` is displayed in the log. Contrary, the control character\n`BEL` is not visible, so a space is displayed instead.\n\nIf you set this option to `true`, the hex code for the character is displayed,\nfor example, the `BEL` character is displayed as `\\x07`.\n\nThe default value for this option is `true` to ensure compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.escape-unicode-chars" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Escape Unicode characters in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "longDescription" : "If you set this option to `false`, Unicode\ncharacters are retained and written to the log as-is. For example, `犬` is\nlogged as `犬`.\n\nIf you set this options to `true`, any Unicode characters are escaped, and the\nhex codes for all Unicode characters are logged instead. For example, `犬` is\nlogged as `\\u72AC`.\n\nThe default value for this option is set to `false` for compatibility with\nprevious versions.\n\nA side effect of turning off the escaping is that it reduces the CPU overhead\nfor the logging. However, this is only noticeable if logging is set to a very\nverbose level (e.g. `debug` or `trace`).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.file" : { + "category" : "option", + "default" : "-", + "deprecatedIn" : null, + "description" : "shortcut for '--log.output file://'", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-group" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "group to use for new log file, user must be a member of this group", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.file-mode" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "mode to use for new log file, umask will be applied as well", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.4.5" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.force-direct" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Do not start a separate thread for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "You can use this option to disable logging in an\nextra logging thread. If set to `true`, any log messages are immediately\nprinted in the thread that triggered the log message. This is non-optimal for\nperformance but can aid debugging. If set to `false`, log messages are handed\noff to an extra logging thread, which asynchronously writes the log messages.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.foreground-tty" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Also log to TTY if backgrounded.", + "dynamic" : true, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.hostname" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The hostname to use in log message. Leave empty for none, use \"auto\" to automatically determine a hostname.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can specify a hostname to be logged at the\nbeginning of each log message (for regular logging) or inside the `hostname`\nattribute (for JSON-based logging).\n\nThe default value is an empty string, meaning no hostnames is logged.\nIf you set this option to `auto`, the hostname is automatically determined.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.ids" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Log unique message IDs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Each log invocation in the ArangoDB source code\ncontains a unique log ID, which can be used to quickly find the location in the\nsource code that produced a specific log message.\n\nLog IDs are printed as 5-digit hexadecimal identifiers in square brackets\nbetween the log level and the log topic:\n\n`2020-06-22T21:16:48Z [39028] INFO [144fe] {general} using storage engine\n'rocksdb'` (where `144fe` is the log ID).", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.level" : { + "category" : "option", + "default" : [ + "info" + ], + "deprecatedIn" : null, + "description" : "Set the topic-specific log level, using `--log.level level` for the general topic or `--log.level topic=level` for the specified topic (can be specified multiple times).\nAvailable log levels: fatal, error, warning, info, debug, trace.\nAvailable log topics: all, agency, agencycomm, agencystore, aql, audit-authentication, audit-authorization, audit-collection, audit-database, audit-document, audit-hotbackup, audit-service, audit-view, authentication, authorization, backup, bench, cache, cluster, clustercomm, collector, communication, config, crash, development, dump, engines, flush, general, graphs, heartbeat, httpclient, ldap, license, maintenance, memory, mmap, performance, pregel, queries, rep-state, replication, replication2, requests, restore, rocksdb, security, ssl, startup, statistics, supervision, syscall, threads, trx, ttl, v8, validation, views.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB's log output is grouped by topics.\n`--log.level` can be specified multiple times at startup, for as many topics as\nneeded. The log verbosity and output files can be adjusted per log topic.\n\n```\narangod --log.level all=warning --log.level queries=trace --log.level startup=trace\n```\n\nThis sets a global log level of `warning` and two topic-specific levels\n(`trace` for queries and `info` for startup). Note that `--log.level warning`\ndoes not set a log level globally for all existing topics, but only the\n`general` topic. Use the pseudo-topic `all` to set a global log level.\n\nThe same in a configuration file:\n\n```\n[log]\nlevel = all=warning\nlevel = queries=trace\nlevel = startup=trace\n```\n\nThe available log levels are:\n\n- `fatal`: Only log fatal errors.\n- `error`: Only log errors.\n- `warning`: Only log warnings and errors.\n- `info`: Log information messages, warnings, and errors.\n- `debug`: Log debug and information messages, warnings, and errors.\n- `trace`: Logs trace, debug, and information messages, warnings, and errors.\n\nNote that the `debug` and `trace` levels are very verbose.\n\nSome relevant log topics available in ArangoDB 3 are:\n\n- `agency`: Information about the cluster Agency.\n- `performance`: Performance-related messages.\n- `queries`: Executed AQL queries, slow queries.\n- `replication`: Replication-related information.\n- `requests`: HTTP requests.\n- `startup`: Information about server startup and shutdown.\n- `threads`: Information about threads.\n\nYou can adjust the log levels at runtime via the `PUT /_admin/log/level`\nHTTP API endpoint.\n\n**Audit logging** (Enterprise Edition): The server logs all audit events by\ndefault. Low priority events, such as statistics operations, are logged with the\n`debug` log level. To keep such events from cluttering the log, set the\nappropriate log topics to the `info` log level.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.line-number" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Include the function name, file name, and line number of the source code that issues the log message. Format: `[func@FileName.cpp:123]`", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.max-entry-length" : { + "base" : 1, + "category" : "option", + "default" : 134217728, + "deprecatedIn" : null, + "description" : "The maximum length of a log entry (in bytes).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.7.9" + ], + "longDescription" : "**Note**: This option does not include audit log\nmessages. See `--audit.max-entry-length` instead.\n\nAny log messages longer than the specified value are truncated and the suffix\n`...` is added to them.\n\nThe purpose of this option is to shorten long log messages in case there is not\na lot of space for log files, and to keep rogue log messages from overusing\nresources.\n\nThe default value is 128 MB, which is very high and should effectively mean\ndownwards-compatibility with previous arangod versions, which did not restrict\nthe maximum size of log messages.", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "uint32" + }, + "log.output" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Log destination(s), e.g. file:///path/to/file (any occurrence of $PID is replaced with the process ID).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "This option allows you to direct the global or\nper-topic log messages to different outputs. The output definition can be one\nof the following:\n\n- `-` for stdin\n- `+` for stderr\n- `syslog://`\n- `syslog:///`\n- `file://`\n\nTo set up a per-topic output configuration, use\n`--log.output =`:\n\n`--log.output queries=file://queries.log`\n\nThe above example logs query-related messages to the file `queries.log`.\n\nYou can specify the option multiple times in order to configure the output\nfor different log topics:\n\n`--log.level queries=trace --log.output queries=file:///queries.log\n--log.level requests=info --log.output requests=file:///requests.log`\n\nThe above example logs all query-related messages to the file `queries.log`\nand HTTP requests with a level of `info` or higher to the file `requests.log`.\n\nAny occurrence of `$PID` in the log output value is replaced at runtime with\nthe actual process ID. This enables logging to process-specific files:\n\n`--log.output 'file://arangod.log.$PID'`\n\nNote that dollar sign may need extra escaping when specified on a\ncommand-line such as Bash.\n\nIf you specify `--log.file-mode `, then any newly created log\nfile uses `octalvalue` as file mode. Please note that the `umask` value is\napplied as well.\n\nIf you specify `--log.file-group `, then any newly created log file tries\nto use `` as the group name. Note that you have to be a member of that\ngroup. Otherwise, the group ownership is not changed. This option is only\navailable under Linux and macOS. It is not available under Windows.\n\nThe old `--log.file` option is still available for convenience. It is a\nshortcut for the more general option `--log.output file://filename`.\n\nThe old `--log.requests-file` option is still available. It is a shortcut for\nthe more general option `--log.output requests=file://...`.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.performance" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Shortcut for `--log.level performance=trace`.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.prefix" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "Prefix log message with this string.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "Example: `arangod ... --log.prefix \"-->\"`\n\n`2020-07-23T09:46:03Z --> [17493] INFO ...`", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string" + }, + "log.process" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Show the process identifier (PID) in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.8.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.request-parameters" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "include full URLs and HTTP request parameters in trace logs", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.role" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Log the server role.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "If you set this option to `true`, log messages\ncontains a single character with the server's role. The roles are:\n\n- `U`: Undefined / unclear (used at startup)\n- `S`: Single server\n- `C`: Coordinator\n- `P`: Primary / DB-Server\n- `A`: Agent", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.shorten-filenames" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "shorten filenames in log output (use with --log.line-number)", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.structured-param" : { + "category" : "option", + "default" : [ + ], + "deprecatedIn" : null, + "description" : "Toggle the usage of the log category parameter in structured log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.10.0" + ], + "longDescription" : "Some log messages can be displayed together with\nadditional information in a structured form. The following parameters are\navailable:\n\n- `database`: The name of the database.\n- `username`: The name of the user.\n- `url`: The endpoint path.\n- `pregelID`: The ID of the Pregel job.\n\nThe format to enable or disable a parameter is `=`, or\n`` to enable it. You can specify the option multiple times to\nconfigure multiple parameters:\n\n`arangod --log.structured-param database=true --log.structured-param url\n--log.structured-param username=false`\n\nYou can adjust the parameter settings at runtime using the\n`/_admin/log/structured` HTTP API.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string..." + }, + "log.thread" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show the thread identifier in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.thread-name" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Show thread name in log messages.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.time-format" : { + "category" : "option", + "default" : "utc-datestring", + "deprecatedIn" : null, + "description" : "The time format to use in logs.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.5.0" + ], + "longDescription" : "Overview over the different options:\n\nFormat | Example | Description\n:-----------------------|:------------------------ |:-----------\n`timestamp` | 1553766923000 | Unix timestamps, in seconds\n`timestamp-millis` | 1553766923000.123 | Unix timestamps, in seconds, with millisecond precision\n`timestamp-micros` | 1553766923000.123456 | Unix timestamps, in seconds, with microsecond precision\n`uptime` | 987654 | seconds since server start\n`uptime-millis` | 987654.123 | seconds since server start, with millisecond precision\n`uptime-micros` | 987654.123456 | seconds since server start, with microsecond precision\n`utc-datestring` | 2019-03-28T09:55:23Z | UTC-based date and time in format YYYY-MM-DDTHH:MM:SSZ \n`utc-datestring-millis` | 2019-03-28T09:55:23.123Z | like `utc-datestring`, but with millisecond precision\n`local-datestring` | 2019-03-28T10:55:23 | local date and time in format YYYY-MM-DDTHH:MM:SS", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "log", + "type" : "string", + "values" : "Possible values: \"local-datestring\", \"timestamp\", \"timestamp-micros\", \"timestamp-millis\", \"uptime\", \"uptime-micros\", \"uptime-millis\", \"utc-datestring\", \"utc-datestring-micros\", \"utc-datestring-millis\"" + }, + "log.use-json-format" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Use JSON as output format for logging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.8.0" + ], + "longDescription" : "You can use this option to switch the log output\nto the JSON format. Each log message then produces a separate line with\nJSON-encoded log data, which can be consumed by other applications.\n\nThe object attributes produced for each log message are:\n\n| Key | Value |\n|:-----------|:-----------|\n| `time` | date/time of log message, in format specified by `--log.time-format`\n| `prefix` | only emitted if `--log.prefix` is set\n| `pid` | process id, only emitted if `--log.process` is set\n| `tid` | thread id, only emitted if `--log.thread` is set\n| `thread` | thread name, only emitted if `--log.thread-name` is set\n| `role` | server role (1 character), only emitted if `--log.role` is set\n| `level` | log level (e.g. `\"WARN\"`, `\"INFO\"`)\n| `file` | source file name of log message, only emitted if `--log.line-number` is set\n| `line` | source file line of log message, only emitted if `--log.line-number` is set \n| `function` | source file function name, only emitted if `--log.line-number` is set\n| `topic` | log topic name\n| `id` | log id (5 digit hexadecimal string), only emitted if `--log.ids` is set\n| `hostname` | hostname if `--log.hostname` is set\n| `message` | the actual log message payload", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-local-time" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use the local timezone instead of UTC.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format local-datestring` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "log.use-microtime" : { + "category" : "option", + "default" : false, + "deprecatedIn" : [ + "v3.5.0" + ], + "description" : "Use Unix timestamps in seconds with microsecond precision.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "This option is deprecated.\nUse `--log.time-format timestamp-micros` instead.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "log", + "type" : "boolean" + }, + "quiet" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Silent startup.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "random.generator" : { + "base" : 1, + "category" : "option", + "default" : 1, + "deprecatedIn" : null, + "description" : "The random number generator to use (1 = MERSENNE, 2 = RANDOM, 3 = URANDOM, 4 = COMBINED (not available on Windows), 5 = WinCrypt (Windows only).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "longDescription" : "- `1`: a pseudo-random number generator using an\nimplication of the Mersenne Twister MT19937 algorithm\n- `2`: use a blocking random (or pseudo-random) number generator\n- `3`: use the non-blocking random (or pseudo-random) number generator supplied\n by the operating system\n- `4`: a combination of the blocking random number generator and the Mersenne\n Twister (not available on Windows)\n- `5`: use WinCrypt (Windows only)", + "maxInclusive" : true, + "maxValue" : 4294967295, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "random", + "type" : "uint32", + "values" : "Possible values: 1, 2, 3, 4" + }, + "server.ask-jwt-secret" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "If enabled, you are prompted for a JWT secret. This option is not compatible with --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.authentication" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Require authentication credentials when connecting (does not affect the server-side authentication settings).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.connection-timeout" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The connection timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.database" : { + "category" : "option", + "default" : "_system", + "deprecatedIn" : null, + "description" : "The database name to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.endpoint" : { + "category" : "option", + "default" : [ + "tcp://127.0.0.1:8529" + ], + "deprecatedIn" : null, + "description" : "The endpoint to connect to. Use 'none' to start without a server. Use http+ssl:// or vst+ssl:// as schema to connect to an SSL-secured server endpoint, otherwise http+tcp://, vst+tcp:// or unix://.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string..." + }, + "server.force-json" : { + "category" : "option", + "default" : false, + "deprecatedIn" : null, + "description" : "Force to not use VelocyPack for easier debugging.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : [ + "v3.6.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "required" : false, + "requiresValue" : false, + "section" : "server", + "type" : "boolean" + }, + "server.jwt-secret-keyfile" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "If enabled, the JWT secret is loaded from the given file. This option is not compatible with --server.ask-jwt-secret, --server.username and --server.password. If specified, it is used for all connections - even if a new connection to another server is created.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.max-packet-size" : { + "base" : 1, + "category" : "option", + "default" : 1073741824, + "deprecatedIn" : null, + "description" : "The maximum packet size (in bytes) for client/server communication.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : true, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "uint64" + }, + "server.password" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The password to use when connecting. If not specified and authentication is required, the user is prompted for a password", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "server.request-timeout" : { + "base" : 1, + "category" : "option", + "default" : 1200, + "deprecatedIn" : null, + "description" : "The request timeout (in seconds).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 1.7976931348623157e+308, + "minInclusive" : true, + "minValue" : 2.2250738585072014e-308, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "double" + }, + "server.username" : { + "category" : "option", + "default" : "root", + "deprecatedIn" : null, + "description" : "The username to use when connecting.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "server", + "type" : "string" + }, + "ssl.protocol" : { + "base" : 1, + "category" : "option", + "default" : 5, + "deprecatedIn" : null, + "description" : "The SSL protocol (1 = SSLv2 (unsupported), 2 = SSLv2 or SSLv3 (negotiated), 3 = SSLv3, 4 = TLSv1, 5 = TLSv1.2, 6 = TLSv1.3, 9 = generic TLS (negotiated))", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "maxInclusive" : true, + "maxValue" : 18446744073709551615, + "minInclusive" : true, + "minValue" : 0, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "ssl", + "type" : "uint64", + "values" : "Possible values: 1, 2, 3, 4, 5, 6, 9" + }, + "temp.path" : { + "category" : "option", + "default" : "", + "deprecatedIn" : null, + "description" : "The path for temporary files.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "longDescription" : "ArangoDB uses the path for storing temporary\nfiles, for extracting data from uploaded zip files (e.g. for Foxx services),\nand other things.\n\nIdeally, the temporary path is set to an instance-specific subdirectory of the\noperating system's temporary directory. To avoid data loss, the temporary path\nshould not overlap with any directories that contain important data, for\nexample, the instance's database directory.\n\nIf you set the temporary path to the same directory as the instance's database\ndirectory, a startup error is logged and the startup is aborted.", + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : true, + "section" : "temp", + "type" : "string" + }, + "use-splice-syscall" : { + "category" : "option", + "default" : true, + "deprecatedIn" : null, + "description" : "Use the splice() syscall for file copying (may not be supported on all filesystems).", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.4" + ], + "longDescription" : "While the syscall is generally available since\nLinux 2.6.x, it is also required that the underlying filesystem supports the\nsplice operation. This is not true for some encrypted filesystems\n(e.g. ecryptfs), on which `splice()` calls can fail.\n\nYou can set the `--use-splice-syscall` startup option to `false` to use a less\nefficient, but more portable file copying method instead, which should work on\nall filesystems.", + "obsolete" : false, + "os" : [ + "linux" + ], + "required" : false, + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : null, + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + }, + "version-json" : { + "category" : "command", + "deprecatedIn" : null, + "description" : "Print the version and other related information in JSON format, then exit.", + "dynamic" : false, + "enterpriseOnly" : false, + "experimental" : false, + "hidden" : false, + "introducedIn" : [ + "v3.9.0" + ], + "obsolete" : false, + "os" : [ + "linux", + "macos", + "windows" + ], + "requiresValue" : false, + "section" : "", + "type" : "boolean" + } +} diff --git a/site/data/3.10/cache.json b/site/data/3.10/cache.json index 9e26dfeeb6..0967ef424b 100644 --- a/site/data/3.10/cache.json +++ b/site/data/3.10/cache.json @@ -1 +1 @@ -{} \ No newline at end of file +{} diff --git a/site/data/3.10/errors.yaml b/site/data/3.10/errors.yaml new file mode 100644 index 0000000000..73ade9de6a --- /dev/null +++ b/site/data/3.10/errors.yaml @@ -0,0 +1,1438 @@ +- group: General errors +- name: ERROR_NO_ERROR + text: "no error" + desc: "No error has occurred." + code: 0 +- name: ERROR_FAILED + text: "failed" + desc: "Will be raised when a general error occurred." + code: 1 +- name: ERROR_SYS_ERROR + text: "system error" + desc: "Will be raised when operating system error occurred." + code: 2 +- name: ERROR_OUT_OF_MEMORY + text: "out of memory" + desc: "Will be raised when there is a memory shortage." + code: 3 +- name: ERROR_INTERNAL + text: "internal error" + desc: "Will be raised when an internal error occurred." + code: 4 +- name: ERROR_ILLEGAL_NUMBER + text: "illegal number" + desc: "Will be raised when an illegal representation of a number was given." + code: 5 +- name: ERROR_NUMERIC_OVERFLOW + text: "numeric overflow" + desc: "Will be raised when a numeric overflow occurred." + code: 6 +- name: ERROR_ILLEGAL_OPTION + text: "illegal option" + desc: "Will be raised when an unknown option was supplied by the user." + code: 7 +- name: ERROR_DEAD_PID + text: "dead process identifier" + desc: "Will be raised when a PID without a living process was found." + code: 8 +- name: ERROR_NOT_IMPLEMENTED + text: "not implemented" + desc: "Will be raised when hitting an unimplemented feature." + code: 9 +- name: ERROR_BAD_PARAMETER + text: "bad parameter" + desc: "Will be raised when the parameter does not fulfill the requirements." + code: 10 +- name: ERROR_FORBIDDEN + text: "forbidden" + desc: "Will be raised when you are missing permission for the operation." + code: 11 +- name: ERROR_OUT_OF_MEMORY_MMAP + text: "out of memory in mmap" + desc: "Will be raised when there is a memory shortage." + code: 12 +- name: ERROR_CORRUPTED_CSV + text: "csv is corrupt" + desc: "Will be raised when encountering a corrupt csv line." + code: 13 +- name: ERROR_FILE_NOT_FOUND + text: "file not found" + desc: "Will be raised when a file is not found." + code: 14 +- name: ERROR_CANNOT_WRITE_FILE + text: "cannot write file" + desc: "Will be raised when a file cannot be written." + code: 15 +- name: ERROR_CANNOT_OVERWRITE_FILE + text: "cannot overwrite file" + desc: "Will be raised when an attempt is made to overwrite an existing file." + code: 16 +- name: ERROR_TYPE_ERROR + text: "type error" + desc: "Will be raised when a type error is encountered." + code: 17 +- name: ERROR_LOCK_TIMEOUT + text: "lock timeout" + desc: "Will be raised when there's a timeout waiting for a lock." + code: 18 +- name: ERROR_CANNOT_CREATE_DIRECTORY + text: "cannot create directory" + desc: "Will be raised when an attempt to create a directory fails." + code: 19 +- name: ERROR_CANNOT_CREATE_TEMP_FILE + text: "cannot create temporary file" + desc: "Will be raised when an attempt to create a temporary file fails." + code: 20 +- name: ERROR_REQUEST_CANCELED + text: "canceled request" + desc: "Will be raised when a request is canceled by the user." + code: 21 +- name: ERROR_DEBUG + text: "intentional debug error" + desc: "Will be raised intentionally during debugging." + code: 22 +- name: ERROR_IP_ADDRESS_INVALID + text: "IP address is invalid" + desc: "Will be raised when the structure of an IP address is invalid." + code: 25 +- name: ERROR_FILE_EXISTS + text: "file exists" + desc: "Will be raised when a file already exists." + code: 27 +- name: ERROR_LOCKED + text: "locked" + desc: "Will be raised when a resource or an operation is locked." + code: 28 +- name: ERROR_DEADLOCK + text: "deadlock detected" + desc: "Will be raised when a deadlock is detected when accessing collections." + code: 29 +- name: ERROR_SHUTTING_DOWN + text: "shutdown in progress" + desc: "Will be raised when a call cannot succeed because a server shutdown is already in progress." + code: 30 +- name: ERROR_ONLY_ENTERPRISE + text: "only enterprise version" + desc: "Will be raised when an Enterprise Edition feature is requested from the Community Edition." + code: 31 +- name: ERROR_RESOURCE_LIMIT + text: "resource limit exceeded" + desc: "Will be raised when the resources used by an operation exceed the configured maximum value." + code: 32 +- name: ERROR_ARANGO_ICU_ERROR + text: "icu error: %s" + desc: "will be raised if icu operations failed" + code: 33 +- name: ERROR_CANNOT_READ_FILE + text: "cannot read file" + desc: "Will be raised when a file cannot be read." + code: 34 +- name: ERROR_INCOMPATIBLE_VERSION + text: "incompatible server version" + desc: "Will be raised when a server is running an incompatible version of ArangoDB." + code: 35 +- name: ERROR_DISABLED + text: "disabled" + desc: "Will be raised when a requested resource is not enabled." + code: 36 +- name: ERROR_MALFORMED_JSON + text: "malformed json" + desc: "Will be raised when a JSON string could not be parsed." + code: 37 +- name: ERROR_STARTING_UP + text: "startup ongoing" + desc: "Will be raised when a call cannot succeed because the server startup phase is still in progress." + code: 38 +- group: HTTP error status codes +- name: ERROR_HTTP_BAD_PARAMETER + text: "bad parameter" + desc: "Will be raised when the HTTP request does not fulfill the requirements." + code: 400 +- name: ERROR_HTTP_UNAUTHORIZED + text: "unauthorized" + desc: "Will be raised when authorization is required but the user is not authorized." + code: 401 +- name: ERROR_HTTP_FORBIDDEN + text: "forbidden" + desc: "Will be raised when the operation is forbidden." + code: 403 +- name: ERROR_HTTP_NOT_FOUND + text: "not found" + desc: "Will be raised when an URI is unknown." + code: 404 +- name: ERROR_HTTP_METHOD_NOT_ALLOWED + text: "method not supported" + desc: "Will be raised when an unsupported HTTP method is used for an operation." + code: 405 +- name: ERROR_HTTP_NOT_ACCEPTABLE + text: "request not acceptable" + desc: "Will be raised when an unsupported HTTP content type is used for an operation, or if a request is not acceptable for a leader or follower." + code: 406 +- name: ERROR_HTTP_REQUEST_TIMEOUT + text: "request timeout" + desc: "Will be raised when a timeout occured." + code: 408 +- name: ERROR_HTTP_CONFLICT + text: "conflict" + desc: "Will be raised when a conflict occurs in an HTTP operation." + code: 409 +- name: ERROR_HTTP_GONE + text: "content permanently deleted" + desc: "Will be raised when the requested content has been permanently deleted." + code: 410 +- name: ERROR_HTTP_PRECONDITION_FAILED + text: "precondition failed" + desc: "Will be raised when a precondition for an HTTP request is not met." + code: 412 +- name: ERROR_HTTP_SERVER_ERROR + text: "internal server error" + desc: "Will be raised when an internal server is encountered." + code: 500 +- name: ERROR_HTTP_NOT_IMPLEMENTED + text: "not implemented" + desc: "Will be raised when an API is called this is not implemented in general, or not implemented for the current setup." + code: 501 +- name: ERROR_HTTP_SERVICE_UNAVAILABLE + text: "service unavailable" + desc: "Will be raised when a service is temporarily unavailable." + code: 503 +- name: ERROR_HTTP_GATEWAY_TIMEOUT + text: "gateway timeout" + desc: "Will be raised when a service contacted by ArangoDB does not respond in a timely manner." + code: 504 +- group: HTTP processing errors +- name: ERROR_HTTP_CORRUPTED_JSON + text: "invalid JSON object" + desc: "Will be raised when a string representation of a JSON object is corrupt." + code: 600 +- name: ERROR_HTTP_SUPERFLUOUS_SUFFICES + text: "superfluous URL suffices" + desc: "Will be raised when the URL contains superfluous suffices." + code: 601 +- group: Internal ArangoDB storage errors +- name: ERROR_ARANGO_ILLEGAL_STATE + text: "illegal state" + desc: "Internal error that will be raised when the datafile is not in the required state." + code: 1000 +- name: ERROR_ARANGO_READ_ONLY + text: "read only" + desc: "Internal error that will be raised when trying to write to a read-only datafile or collection." + code: 1004 +- name: ERROR_ARANGO_DUPLICATE_IDENTIFIER + text: "duplicate identifier" + desc: "Internal error that will be raised when a identifier duplicate is detected." + code: 1005 +- group: External ArangoDB storage errors +- name: ERROR_ARANGO_CORRUPTED_DATAFILE + text: "corrupted datafile" + desc: "Will be raised when a corruption is detected in a datafile." + code: 1100 +- name: ERROR_ARANGO_ILLEGAL_PARAMETER_FILE + text: "illegal or unreadable parameter file" + desc: "Will be raised if a parameter file is corrupted or cannot be read." + code: 1101 +- name: ERROR_ARANGO_CORRUPTED_COLLECTION + text: "corrupted collection" + desc: "Will be raised when a collection contains one or more corrupted data files." + code: 1102 +- name: ERROR_ARANGO_FILESYSTEM_FULL + text: "filesystem full" + desc: "Will be raised when the filesystem is full." + code: 1104 +- name: ERROR_ARANGO_DATADIR_LOCKED + text: "database directory is locked" + desc: "Will be raised when the database directory is locked by a different process." + code: 1107 +- group: General ArangoDB storage errors +- name: ERROR_ARANGO_CONFLICT + text: "conflict" + desc: "Will be raised when updating or deleting a document and a conflict has been detected." + code: 1200 +- name: ERROR_ARANGO_DOCUMENT_NOT_FOUND + text: "document not found" + desc: "Will be raised when a document with a given identifier is unknown." + code: 1202 +- name: ERROR_ARANGO_DATA_SOURCE_NOT_FOUND + text: "collection or view not found" + desc: "Will be raised when a collection or View with the given identifier or name is unknown." + code: 1203 +- name: ERROR_ARANGO_COLLECTION_PARAMETER_MISSING + text: "parameter 'collection' not found" + desc: "Will be raised when the collection parameter is missing." + code: 1204 +- name: ERROR_ARANGO_DOCUMENT_HANDLE_BAD + text: "illegal document identifier" + desc: "Will be raised when a document identifier is corrupt." + code: 1205 +- name: ERROR_ARANGO_DUPLICATE_NAME + text: "duplicate name" + desc: "Will be raised when a name duplicate is detected." + code: 1207 +- name: ERROR_ARANGO_ILLEGAL_NAME + text: "illegal name" + desc: "Will be raised when an illegal name is detected." + code: 1208 +- name: ERROR_ARANGO_NO_INDEX + text: "no suitable index known" + desc: "Will be raised when no suitable index for the query is known." + code: 1209 +- name: ERROR_ARANGO_UNIQUE_CONSTRAINT_VIOLATED + text: "unique constraint violated" + desc: "Will be raised when there is a unique constraint violation." + code: 1210 +- name: ERROR_ARANGO_INDEX_NOT_FOUND + text: "index not found" + desc: "Will be raised when an index with a given identifier is unknown." + code: 1212 +- name: ERROR_ARANGO_CROSS_COLLECTION_REQUEST + text: "cross collection request not allowed" + desc: "Will be raised when a cross-collection is requested." + code: 1213 +- name: ERROR_ARANGO_INDEX_HANDLE_BAD + text: "illegal index identifier" + desc: "Will be raised when a index identifier is corrupt." + code: 1214 +- name: ERROR_ARANGO_DOCUMENT_TOO_LARGE + text: "document too large" + desc: "Will be raised when the document cannot fit into any datafile because of it is too large." + code: 1216 +- name: ERROR_ARANGO_COLLECTION_NOT_UNLOADED + text: "collection must be unloaded" + desc: "Will be raised when a collection should be unloaded, but has a different status." + code: 1217 +- name: ERROR_ARANGO_COLLECTION_TYPE_INVALID + text: "collection type invalid" + desc: "Will be raised when an invalid collection type is used in a request." + code: 1218 +- name: ERROR_ARANGO_ATTRIBUTE_PARSER_FAILED + text: "parsing attribute name definition failed" + desc: "Will be raised when parsing an attribute name definition failed." + code: 1220 +- name: ERROR_ARANGO_DOCUMENT_KEY_BAD + text: "illegal document key" + desc: "Will be raised when a document key is corrupt." + code: 1221 +- name: ERROR_ARANGO_DOCUMENT_KEY_UNEXPECTED + text: "unexpected document key" + desc: "Will be raised when a user-defined document key is supplied for collections with auto key generation." + code: 1222 +- name: ERROR_ARANGO_DATADIR_NOT_WRITABLE + text: "server database directory not writable" + desc: "Will be raised when the server's database directory is not writable for the current user." + code: 1224 +- name: ERROR_ARANGO_OUT_OF_KEYS + text: "out of keys" + desc: "Will be raised when a key generator runs out of keys." + code: 1225 +- name: ERROR_ARANGO_DOCUMENT_KEY_MISSING + text: "missing document key" + desc: "Will be raised when a document key is missing." + code: 1226 +- name: ERROR_ARANGO_DOCUMENT_TYPE_INVALID + text: "invalid document type" + desc: "Will be raised when there is an attempt to create a document with an invalid type." + code: 1227 +- name: ERROR_ARANGO_DATABASE_NOT_FOUND + text: "database not found" + desc: "Will be raised when a non-existing database is accessed." + code: 1228 +- name: ERROR_ARANGO_DATABASE_NAME_INVALID + text: "database name invalid" + desc: "Will be raised when an invalid database name is used." + code: 1229 +- name: ERROR_ARANGO_USE_SYSTEM_DATABASE + text: "operation only allowed in system database" + desc: "Will be raised when an operation is requested in a database other than the system database." + code: 1230 +- name: ERROR_ARANGO_INVALID_KEY_GENERATOR + text: "invalid key generator" + desc: "Will be raised when an invalid key generator description is used." + code: 1232 +- name: ERROR_ARANGO_INVALID_EDGE_ATTRIBUTE + text: "edge attribute missing or invalid" + desc: "will be raised when the _from or _to values of an edge are undefined or contain an invalid value." + code: 1233 +- name: ERROR_ARANGO_INDEX_CREATION_FAILED + text: "index creation failed" + desc: "Will be raised when an attempt to create an index has failed." + code: 1235 +- name: ERROR_ARANGO_COLLECTION_TYPE_MISMATCH + text: "collection type mismatch" + desc: "Will be raised when a collection has a different type from what has been expected." + code: 1237 +- name: ERROR_ARANGO_COLLECTION_NOT_LOADED + text: "collection not loaded" + desc: "Will be raised when a collection is accessed that is not yet loaded." + code: 1238 +- name: ERROR_ARANGO_DOCUMENT_REV_BAD + text: "illegal document revision" + desc: "Will be raised when a document revision is corrupt or is missing where needed." + code: 1239 +- name: ERROR_ARANGO_INCOMPLETE_READ + text: "incomplete read" + desc: "Will be raised by the storage engine when a read cannot be completed." + code: 1240 +- group: Checked ArangoDB storage errors +- name: ERROR_ARANGO_EMPTY_DATADIR + text: "server database directory is empty" + desc: "Will be raised when encountering an empty server database directory." + code: 1301 +- name: ERROR_ARANGO_TRY_AGAIN + text: "operation should be tried again" + desc: "Will be raised when an operation should be retried." + code: 1302 +- name: ERROR_ARANGO_BUSY + text: "engine is busy" + desc: "Will be raised when storage engine is busy." + code: 1303 +- name: ERROR_ARANGO_MERGE_IN_PROGRESS + text: "merge in progress" + desc: "Will be raised when storage engine has a datafile merge in progress and cannot complete the operation." + code: 1304 +- name: ERROR_ARANGO_IO_ERROR + text: "storage engine I/O error" + desc: "Will be raised when storage engine encounters an I/O error." + code: 1305 +- group: ArangoDB replication errors +- name: ERROR_REPLICATION_NO_RESPONSE + text: "no response" + desc: "Will be raised when the replication applier does not receive any or an incomplete response from the leader." + code: 1400 +- name: ERROR_REPLICATION_INVALID_RESPONSE + text: "invalid response" + desc: "Will be raised when the replication applier receives an invalid response from the leader." + code: 1401 +- name: ERROR_REPLICATION_LEADER_ERROR + text: "leader error" + desc: "Will be raised when the replication applier receives a server error from the leader." + code: 1402 +- name: ERROR_REPLICATION_LEADER_INCOMPATIBLE + text: "leader incompatible" + desc: "Will be raised when the replication applier connects to a leader that has an incompatible version." + code: 1403 +- name: ERROR_REPLICATION_LEADER_CHANGE + text: "leader change" + desc: "Will be raised when the replication applier connects to a different leader than before." + code: 1404 +- name: ERROR_REPLICATION_LOOP + text: "loop detected" + desc: "Will be raised when the replication applier is asked to connect to itself for replication." + code: 1405 +- name: ERROR_REPLICATION_UNEXPECTED_MARKER + text: "unexpected marker" + desc: "Will be raised when an unexpected marker is found in the replication log stream." + code: 1406 +- name: ERROR_REPLICATION_INVALID_APPLIER_STATE + text: "invalid applier state" + desc: "Will be raised when an invalid replication applier state file is found." + code: 1407 +- name: ERROR_REPLICATION_UNEXPECTED_TRANSACTION + text: "invalid transaction" + desc: "Will be raised when an unexpected transaction id is found." + code: 1408 +- name: ERROR_REPLICATION_SHARD_SYNC_ATTEMPT_TIMEOUT_EXCEEDED + text: "shard synchronization attempt timeout exceeded" + desc: "Will be raised when the synchronization of a shard takes longer than the configured timeout." + code: 1409 +- name: ERROR_REPLICATION_INVALID_APPLIER_CONFIGURATION + text: "invalid replication applier configuration" + desc: "Will be raised when the configuration for the replication applier is invalid." + code: 1410 +- name: ERROR_REPLICATION_RUNNING + text: "cannot perform operation while applier is running" + desc: "Will be raised when there is an attempt to perform an operation while the replication applier is running." + code: 1411 +- name: ERROR_REPLICATION_APPLIER_STOPPED + text: "replication stopped" + desc: "Special error code used to indicate the replication applier was stopped by a user." + code: 1412 +- name: ERROR_REPLICATION_NO_START_TICK + text: "no start tick" + desc: "Will be raised when the replication applier is started without a known start tick value." + code: 1413 +- name: ERROR_REPLICATION_START_TICK_NOT_PRESENT + text: "start tick not present" + desc: "Will be raised when the replication applier fetches data using a start tick, but that start tick is not present on the logger server anymore." + code: 1414 +- name: ERROR_REPLICATION_WRONG_CHECKSUM + text: "wrong checksum" + desc: "Will be raised when a new born follower submits a wrong checksum" + code: 1416 +- name: ERROR_REPLICATION_SHARD_NONEMPTY + text: "shard not empty" + desc: "Will be raised when a shard is not empty and the follower tries a shortcut" + code: 1417 +- name: ERROR_REPLICATION_REPLICATED_LOG_NOT_FOUND + text: "replicated log {} not found" + desc: "Will be raised when a specific replicated log is not found" + code: 1418 +- name: ERROR_REPLICATION_REPLICATED_LOG_NOT_THE_LEADER + text: "not the log leader" + desc: "Will be raised when a participant of a replicated log is ordered to do something only the leader can do" + code: 1419 +- name: ERROR_REPLICATION_REPLICATED_LOG_NOT_A_FOLLOWER + text: "not a log follower" + desc: "Will be raised when a participant of a replicated log is ordered to do something only a follower can do" + code: 1420 +- name: ERROR_REPLICATION_REPLICATED_LOG_APPEND_ENTRIES_REJECTED + text: "follower rejected append entries request" + desc: "Will be raised when a follower of a replicated log rejects an append entries request" + code: 1421 +- name: ERROR_REPLICATION_REPLICATED_LOG_LEADER_RESIGNED + text: "a resigned leader instance rejected a request" + desc: "Will be raised when a leader instance of a replicated log rejects a request because it just resigned. This can also happen if the term changes (due to a configuration change), even if the leader stays the same." + code: 1422 +- name: ERROR_REPLICATION_REPLICATED_LOG_FOLLOWER_RESIGNED + text: "a resigned follower instance rejected a request" + desc: "Will be raised when a follower instance of a replicated log rejects a request because it just resigned. This can also happen if the term changes (due to a configuration change), even if the server stays a follower." + code: 1423 +- name: ERROR_REPLICATION_REPLICATED_LOG_PARTICIPANT_GONE + text: "the replicated log of the participant is gone" + desc: "Will be raised when a participant instance of a replicated log is no longer available." + code: 1424 +- name: ERROR_REPLICATION_REPLICATED_LOG_INVALID_TERM + text: "an invalid term was given" + desc: "Will be raised when a participant tries to change its term but found a invalid new term." + code: 1425 +- name: ERROR_REPLICATION_REPLICATED_LOG_UNCONFIGURED + text: "log participant unconfigured" + desc: "Will be raised when a participant is currently unconfigured, i.e. neither a leader nor a follower." + code: 1426 +- name: ERROR_REPLICATION_REPLICATED_STATE_NOT_FOUND + text: "replicated state {id:} of type {type:} not found" + desc: "Will be raised when a specific replicated state was not found." + code: 1427 +- group: ArangoDB cluster errors +- name: ERROR_CLUSTER_NOT_FOLLOWER + text: "not a follower" + desc: "Will be raised when an operation is sent to a non-following server." + code: 1446 +- name: ERROR_CLUSTER_FOLLOWER_TRANSACTION_COMMIT_PERFORMED + text: "follower transaction intermediate commit already performed" + desc: "Will be raised when a follower transaction has already performed an intermediate commit and must be rolled back." + code: 1447 +- name: ERROR_CLUSTER_CREATE_COLLECTION_PRECONDITION_FAILED + text: "creating collection failed due to precondition" + desc: "Will be raised when updating the plan on collection creation failed." + code: 1448 +- name: ERROR_CLUSTER_SERVER_UNKNOWN + text: "got a request from an unknown server" + desc: "Will be raised on some occasions when one server gets a request from another, which has not (yet?) been made known via the Agency." + code: 1449 +- name: ERROR_CLUSTER_TOO_MANY_SHARDS + text: "too many shards" + desc: "Will be raised when the number of shards for a collection is higher than allowed." + code: 1450 +- name: ERROR_CLUSTER_COULD_NOT_CREATE_COLLECTION_IN_PLAN + text: "could not create collection in plan" + desc: "Will be raised when a Coordinator in a cluster cannot create an entry for a new collection in the Plan hierarchy in the Agency." + code: 1454 +- name: ERROR_CLUSTER_COULD_NOT_CREATE_COLLECTION + text: "could not create collection" + desc: "Will be raised when a Coordinator in a cluster notices that some DB-Servers report problems when creating shards for a new collection." + code: 1456 +- name: ERROR_CLUSTER_TIMEOUT + text: "timeout in cluster operation" + desc: "Will be raised when a Coordinator in a cluster runs into a timeout for some cluster wide operation." + code: 1457 +- name: ERROR_CLUSTER_COULD_NOT_REMOVE_COLLECTION_IN_PLAN + text: "could not remove collection from plan" + desc: "Will be raised when a Coordinator in a cluster cannot remove an entry for a collection in the Plan hierarchy in the Agency." + code: 1458 +- name: ERROR_CLUSTER_COULD_NOT_CREATE_DATABASE_IN_PLAN + text: "could not create database in plan" + desc: "Will be raised when a Coordinator in a cluster cannot create an entry for a new database in the Plan hierarchy in the Agency." + code: 1460 +- name: ERROR_CLUSTER_COULD_NOT_CREATE_DATABASE + text: "could not create database" + desc: "Will be raised when a Coordinator in a cluster notices that some DB-Servers report problems when creating databases for a new cluster wide database." + code: 1461 +- name: ERROR_CLUSTER_COULD_NOT_REMOVE_DATABASE_IN_PLAN + text: "could not remove database from plan" + desc: "Will be raised when a Coordinator in a cluster cannot remove an entry for a database in the Plan hierarchy in the Agency." + code: 1462 +- name: ERROR_CLUSTER_COULD_NOT_REMOVE_DATABASE_IN_CURRENT + text: "could not remove database from current" + desc: "Will be raised when a Coordinator in a cluster cannot remove an entry for a database in the Current hierarchy in the Agency." + code: 1463 +- name: ERROR_CLUSTER_SHARD_GONE + text: "no responsible shard found" + desc: "Will be raised when a Coordinator in a cluster cannot determine the shard that is responsible for a given document." + code: 1464 +- name: ERROR_CLUSTER_CONNECTION_LOST + text: "cluster internal HTTP connection broken" + desc: "Will be raised when a Coordinator in a cluster loses an HTTP connection to a DB-Server in the cluster whilst transferring data." + code: 1465 +- name: ERROR_CLUSTER_MUST_NOT_SPECIFY_KEY + text: "must not specify _key for this collection" + desc: "Will be raised when a Coordinator in a cluster finds that the _key attribute was specified in a sharded collection the uses not only _key as sharding attribute." + code: 1466 +- name: ERROR_CLUSTER_GOT_CONTRADICTING_ANSWERS + text: "got contradicting answers from different shards" + desc: "Will be raised if a Coordinator in a cluster gets conflicting results from different shards, which should never happen." + code: 1467 +- name: ERROR_CLUSTER_NOT_ALL_SHARDING_ATTRIBUTES_GIVEN + text: "not all sharding attributes given" + desc: "Will be raised if a Coordinator tries to find out which shard is responsible for a partial document, but cannot do this because not all sharding attributes are specified." + code: 1468 +- name: ERROR_CLUSTER_MUST_NOT_CHANGE_SHARDING_ATTRIBUTES + text: "must not change the value of a shard key attribute" + desc: "Will be raised if there is an attempt to update the value of a shard attribute." + code: 1469 +- name: ERROR_CLUSTER_UNSUPPORTED + text: "unsupported operation or parameter for clusters" + desc: "Will be raised when there is an attempt to carry out an operation that is not supported in the context of a sharded collection." + code: 1470 +- name: ERROR_CLUSTER_ONLY_ON_COORDINATOR + text: "this operation is only valid on a coordinator in a cluster" + desc: "Will be raised if there is an attempt to run a Coordinator-only operation on a different type of node." + code: 1471 +- name: ERROR_CLUSTER_READING_PLAN_AGENCY + text: "error reading Plan in agency" + desc: "Will be raised if a Coordinator or DB-Server cannot read the Plan in the Agency." + code: 1472 +- name: ERROR_CLUSTER_COULD_NOT_TRUNCATE_COLLECTION + text: "could not truncate collection" + desc: "Will be raised if a Coordinator cannot truncate all shards of a cluster collection." + code: 1473 +- name: ERROR_CLUSTER_AQL_COMMUNICATION + text: "error in cluster internal communication for AQL" + desc: "Will be raised if the internal communication of the cluster for AQL produces an error." + code: 1474 +- name: ERROR_CLUSTER_ONLY_ON_DBSERVER + text: "this operation is only valid on a DBserver in a cluster" + desc: "Will be raised if there is an attempt to run a DB-Server-only operation on a different type of node." + code: 1477 +- name: ERROR_CLUSTER_BACKEND_UNAVAILABLE + text: "A cluster backend which was required for the operation could not be reached" + desc: "Will be raised if a required DB-Server can't be reached." + code: 1478 +- name: ERROR_CLUSTER_AQL_COLLECTION_OUT_OF_SYNC + text: "collection/view is out of sync" + desc: "Will be raised if a collection/view needed during query execution is out of sync. This currently can happen when using SatelliteCollections, Arangosearch links or inverted indexes." + code: 1481 +- name: ERROR_CLUSTER_COULD_NOT_CREATE_INDEX_IN_PLAN + text: "could not create index in plan" + desc: "Will be raised when a Coordinator in a cluster cannot create an entry for a new index in the Plan hierarchy in the Agency." + code: 1482 +- name: ERROR_CLUSTER_COULD_NOT_DROP_INDEX_IN_PLAN + text: "could not drop index in plan" + desc: "Will be raised when a Coordinator in a cluster cannot remove an index from the Plan hierarchy in the Agency." + code: 1483 +- name: ERROR_CLUSTER_CHAIN_OF_DISTRIBUTESHARDSLIKE + text: "chain of distributeShardsLike references" + desc: "Will be raised if one tries to create a collection with a distributeShardsLike attribute which points to another collection that also has one." + code: 1484 +- name: ERROR_CLUSTER_MUST_NOT_DROP_COLL_OTHER_DISTRIBUTESHARDSLIKE + text: "must not drop collection while another has a distributeShardsLike attribute pointing to it" + desc: "Will be raised if one tries to drop a collection to which another collection points with its distributeShardsLike attribute." + code: 1485 +- name: ERROR_CLUSTER_UNKNOWN_DISTRIBUTESHARDSLIKE + text: "must not have a distributeShardsLike attribute pointing to an unknown collection" + desc: "Will be raised if one tries to create a collection which points to an unknown collection in its distributeShardsLike attribute." + code: 1486 +- name: ERROR_CLUSTER_INSUFFICIENT_DBSERVERS + text: "the number of current dbservers is lower than the requested replicationFactor" + desc: "Will be raised if one tries to create a collection with a replicationFactor greater than the available number of DB-Servers." + code: 1487 +- name: ERROR_CLUSTER_COULD_NOT_DROP_FOLLOWER + text: "a follower could not be dropped in agency" + desc: "Will be raised if a follower that ought to be dropped could not be dropped in the Agency (under Current)." + code: 1488 +- name: ERROR_CLUSTER_SHARD_LEADER_REFUSES_REPLICATION + text: "a shard leader refuses to perform a replication operation" + desc: "Will be raised if a replication operation is refused by a shard leader." + code: 1489 +- name: ERROR_CLUSTER_SHARD_FOLLOWER_REFUSES_OPERATION + text: "a shard follower refuses to perform an operation" + desc: "Will be raised if a replication operation is refused by a shard follower because it is coming from the wrong leader." + code: 1490 +- name: ERROR_CLUSTER_SHARD_LEADER_RESIGNED + text: "a (former) shard leader refuses to perform an operation, because it has resigned in the meantime" + desc: "Will be raised if a non-replication operation is refused by a former shard leader that has found out that it is no longer the leader." + code: 1491 +- name: ERROR_CLUSTER_AGENCY_COMMUNICATION_FAILED + text: "some agency operation failed" + desc: "Will be raised if after various retries an Agency operation could not be performed successfully." + code: 1492 +- name: ERROR_CLUSTER_LEADERSHIP_CHALLENGE_ONGOING + text: "leadership challenge is ongoing" + desc: "Will be raised when servers are currently competing for leadership, and the result is still unknown." + code: 1495 +- name: ERROR_CLUSTER_NOT_LEADER + text: "not a leader" + desc: "Will be raised when an operation is sent to a non-leading server." + code: 1496 +- name: ERROR_CLUSTER_COULD_NOT_CREATE_VIEW_IN_PLAN + text: "could not create view in plan" + desc: "Will be raised when a Coordinator in a cluster cannot create an entry for a new View in the Plan hierarchy in the Agency." + code: 1497 +- name: ERROR_CLUSTER_VIEW_ID_EXISTS + text: "view ID already exists" + desc: "Will be raised when a Coordinator in a cluster tries to create a View and the View ID already exists." + code: 1498 +- name: ERROR_CLUSTER_COULD_NOT_DROP_COLLECTION + text: "could not drop collection in plan" + desc: "Will be raised when a Coordinator in a cluster cannot drop a collection entry in the Plan hierarchy in the Agency." + code: 1499 +- group: ArangoDB query errors +- name: ERROR_QUERY_KILLED + text: "query killed" + desc: "Will be raised when a running query is killed by an explicit admin command." + code: 1500 +- name: ERROR_QUERY_PARSE + text: "%s" + desc: "Will be raised when query is parsed and is found to be syntactically invalid." + code: 1501 +- name: ERROR_QUERY_EMPTY + text: "query is empty" + desc: "Will be raised when an empty query is specified." + code: 1502 +- name: ERROR_QUERY_SCRIPT + text: "runtime error '%s'" + desc: "Will be raised when a runtime error is caused by the query." + code: 1503 +- name: ERROR_QUERY_NUMBER_OUT_OF_RANGE + text: "number out of range" + desc: "Will be raised when a number is outside the expected range." + code: 1504 +- name: ERROR_QUERY_INVALID_GEO_VALUE + text: "invalid geo coordinate value" + desc: "Will be raised when a geo index coordinate is invalid or out of range." + code: 1505 +- name: ERROR_QUERY_VARIABLE_NAME_INVALID + text: "variable name '%s' has an invalid format" + desc: "Will be raised when an invalid variable name is used." + code: 1510 +- name: ERROR_QUERY_VARIABLE_REDECLARED + text: "variable '%s' is assigned multiple times" + desc: "Will be raised when a variable gets re-assigned in a query." + code: 1511 +- name: ERROR_QUERY_VARIABLE_NAME_UNKNOWN + text: "unknown variable '%s'" + desc: "Will be raised when an unknown variable is used or the variable is undefined the context it is used." + code: 1512 +- name: ERROR_QUERY_COLLECTION_LOCK_FAILED + text: "unable to read-lock collection %s" + desc: "Will be raised when a read lock on the collection cannot be acquired." + code: 1521 +- name: ERROR_QUERY_TOO_MANY_COLLECTIONS + text: "too many collections/shards" + desc: "Will be raised when the number of collections or shards in a query is beyond the allowed value." + code: 1522 +- name: ERROR_QUERY_TOO_MUCH_NESTING + text: "too much nesting or too many objects" + desc: "Will be raised when a query contains expressions or other constructs with too many objects or that are too deeply nested." + code: 1524 +- name: ERROR_QUERY_INVALID_OPTIONS_ATTRIBUTE + text: "unknown OPTIONS attribute used" + desc: "Will be raised when an unknown attribute is used inside an OPTIONS clause." + code: 1539 +- name: ERROR_QUERY_FUNCTION_NAME_UNKNOWN + text: "usage of unknown function '%s()'" + desc: "Will be raised when an undefined function is called." + code: 1540 +- name: ERROR_QUERY_FUNCTION_ARGUMENT_NUMBER_MISMATCH + text: "invalid number of arguments for function '%s()', expected number of arguments: minimum: %d, maximum: %d" + desc: "Will be raised when the number of arguments used in a function call does not match the expected number of arguments for the function." + code: 1541 +- name: ERROR_QUERY_FUNCTION_ARGUMENT_TYPE_MISMATCH + text: "invalid argument type in call to function '%s()'" + desc: "Will be raised when the type of an argument used in a function call does not match the expected argument type." + code: 1542 +- name: ERROR_QUERY_INVALID_REGEX + text: "invalid regex value" + desc: "Will be raised when an invalid regex argument value is used in a call to a function that expects a regex." + code: 1543 +- name: ERROR_QUERY_BIND_PARAMETERS_INVALID + text: "invalid structure of bind parameters" + desc: "Will be raised when the structure of bind parameters passed has an unexpected format." + code: 1550 +- name: ERROR_QUERY_BIND_PARAMETER_MISSING + text: "no value specified for declared bind parameter '%s'" + desc: "Will be raised when a bind parameter was declared in the query but the query is being executed with no value for that parameter." + code: 1551 +- name: ERROR_QUERY_BIND_PARAMETER_UNDECLARED + text: "bind parameter '%s' was not declared in the query" + desc: "Will be raised when a value gets specified for an undeclared bind parameter." + code: 1552 +- name: ERROR_QUERY_BIND_PARAMETER_TYPE + text: "bind parameter '%s' has an invalid value or type" + desc: "Will be raised when a bind parameter has an invalid value or type." + code: 1553 +- name: ERROR_QUERY_INVALID_ARITHMETIC_VALUE + text: "invalid arithmetic value" + desc: "Will be raised when a non-numeric value is used in an arithmetic operation." + code: 1561 +- name: ERROR_QUERY_DIVISION_BY_ZERO + text: "division by zero" + desc: "Will be raised when there is an attempt to divide by zero." + code: 1562 +- name: ERROR_QUERY_ARRAY_EXPECTED + text: "array expected" + desc: "Will be raised when a non-array operand is used for an operation that expects an array argument operand." + code: 1563 +- name: ERROR_QUERY_COLLECTION_USED_IN_EXPRESSION + text: "collection '%s' used as expression operand" + desc: "Will be raised when a collection is used as an operand in an AQL expression." + code: 1568 +- name: ERROR_QUERY_FAIL_CALLED + text: "FAIL(%s) called" + desc: "Will be raised when the function FAIL() is called from inside a query." + code: 1569 +- name: ERROR_QUERY_GEO_INDEX_MISSING + text: "no suitable geo index found for geo restriction on '%s'" + desc: "Will be raised when a geo restriction was specified but no suitable geo index is found to resolve it." + code: 1570 +- name: ERROR_QUERY_FULLTEXT_INDEX_MISSING + text: "no suitable fulltext index found for fulltext query on '%s'" + desc: "Will be raised when a fulltext query is performed on a collection without a suitable fulltext index." + code: 1571 +- name: ERROR_QUERY_INVALID_DATE_VALUE + text: "invalid date value" + desc: "Will be raised when a value cannot be converted to a date." + code: 1572 +- name: ERROR_QUERY_MULTI_MODIFY + text: "multi-modify query" + desc: "Will be raised when an AQL query contains more than one data-modifying operation." + code: 1573 +- name: ERROR_QUERY_INVALID_AGGREGATE_EXPRESSION + text: "invalid aggregate expression" + desc: "Will be raised when an AQL query contains an invalid aggregate expression." + code: 1574 +- name: ERROR_QUERY_COMPILE_TIME_OPTIONS + text: "query options must be readable at query compile time" + desc: "Will be raised when an AQL query contains OPTIONS that cannot be figured out at query compile time." + code: 1575 +- name: ERROR_QUERY_FORCED_INDEX_HINT_UNUSABLE + text: "could not use forced index hint" + desc: "Will be raised when forceIndexHint is specified, and the hint cannot be used to serve the query." + code: 1577 +- name: ERROR_QUERY_DISALLOWED_DYNAMIC_CALL + text: "disallowed dynamic call to '%s'" + desc: "Will be raised when a dynamic function call is made to a function that cannot be called dynamically." + code: 1578 +- name: ERROR_QUERY_ACCESS_AFTER_MODIFICATION + text: "access after data-modification by %s" + desc: "Will be raised when collection data are accessed after a data-modification operation." + code: 1579 +- group: AQL user function errors +- name: ERROR_QUERY_FUNCTION_INVALID_NAME + text: "invalid user function name" + desc: "Will be raised when a user function with an invalid name is registered." + code: 1580 +- name: ERROR_QUERY_FUNCTION_INVALID_CODE + text: "invalid user function code" + desc: "Will be raised when a user function is registered with invalid code." + code: 1581 +- name: ERROR_QUERY_FUNCTION_NOT_FOUND + text: "user function '%s()' not found" + desc: "Will be raised when a user function is accessed but not found." + code: 1582 +- name: ERROR_QUERY_FUNCTION_RUNTIME_ERROR + text: "user function runtime error: %s" + desc: "Will be raised when a user function throws a runtime exception." + code: 1583 +- group: AQL query registry errors +- name: ERROR_QUERY_BAD_JSON_PLAN + text: "bad execution plan JSON" + desc: "Will be raised when an HTTP API for a query got an invalid JSON object." + code: 1590 +- name: ERROR_QUERY_NOT_FOUND + text: "query ID not found" + desc: "Will be raised when an Id of a query is not found by the HTTP API." + code: 1591 +- name: ERROR_QUERY_USER_ASSERT + text: "%s" + desc: "Will be raised if and user provided expression fails to evaluate to true" + code: 1593 +- name: ERROR_QUERY_USER_WARN + text: "%s" + desc: "Will be raised if and user provided expression fails to evaluate to true" + code: 1594 +- name: ERROR_QUERY_WINDOW_AFTER_MODIFICATION + text: "window operation after data-modification" + desc: "Will be raised when a window node is created after a data-modification operation." + code: 1595 +- group: ArangoDB cursor errors +- name: ERROR_CURSOR_NOT_FOUND + text: "cursor not found" + desc: "Will be raised when a cursor is requested via its id but a cursor with that id cannot be found." + code: 1600 +- name: ERROR_CURSOR_BUSY + text: "cursor is busy" + desc: "Will be raised when a cursor is requested via its id but a concurrent request is still using the cursor." + code: 1601 +- group: ArangoDB schema validation errors +- name: ERROR_VALIDATION_FAILED + text: "schema validation failed" + desc: "Will be raised when a document does not pass schema validation." + code: 1620 +- name: ERROR_VALIDATION_BAD_PARAMETER + text: "invalid schema validation parameter" + desc: "Will be raised when the schema description is invalid." + code: 1621 +- group: ArangoDB transaction errors +- name: ERROR_TRANSACTION_INTERNAL + text: "internal transaction error" + desc: "Will be raised when a wrong usage of transactions is detected. this is an internal error and indicates a bug in ArangoDB." + code: 1650 +- name: ERROR_TRANSACTION_NESTED + text: "nested transactions detected" + desc: "Will be raised when transactions are nested." + code: 1651 +- name: ERROR_TRANSACTION_UNREGISTERED_COLLECTION + text: "unregistered collection used in transaction" + desc: "Will be raised when a collection is used in the middle of a transaction but was not registered at transaction start." + code: 1652 +- name: ERROR_TRANSACTION_DISALLOWED_OPERATION + text: "disallowed operation inside transaction" + desc: "Will be raised when a disallowed operation is carried out in a transaction." + code: 1653 +- name: ERROR_TRANSACTION_ABORTED + text: "transaction aborted" + desc: "Will be raised when a transaction was aborted." + code: 1654 +- name: ERROR_TRANSACTION_NOT_FOUND + text: "transaction not found" + desc: "Will be raised when a transaction was not found." + code: 1655 +- group: User management errors +- name: ERROR_USER_INVALID_NAME + text: "invalid user name" + desc: "Will be raised when an invalid user name is used." + code: 1700 +- name: ERROR_USER_DUPLICATE + text: "duplicate user" + desc: "Will be raised when a user name already exists." + code: 1702 +- name: ERROR_USER_NOT_FOUND + text: "user not found" + desc: "Will be raised when a user name is updated that does not exist." + code: 1703 +- name: ERROR_USER_EXTERNAL + text: "user is external" + desc: "Will be raised when the user is authenticated by an external server." + code: 1705 +- group: Service management errors (legacy) +- name: ERROR_SERVICE_DOWNLOAD_FAILED + text: "service download failed" + desc: "Will be raised when a service download from the central repository failed." + code: 1752 +- name: ERROR_SERVICE_UPLOAD_FAILED + text: "service upload failed" + desc: "Will be raised when a service upload from the client to the ArangoDB server failed." + code: 1753 +- group: LDAP errors +- name: ERROR_LDAP_CANNOT_INIT + text: "cannot init a LDAP connection" + desc: "can not init a LDAP connection" + code: 1800 +- name: ERROR_LDAP_CANNOT_SET_OPTION + text: "cannot set a LDAP option" + desc: "can not set a LDAP option" + code: 1801 +- name: ERROR_LDAP_CANNOT_BIND + text: "cannot bind to a LDAP server" + desc: "can not bind to a LDAP server" + code: 1802 +- name: ERROR_LDAP_CANNOT_UNBIND + text: "cannot unbind from a LDAP server" + desc: "can not unbind from a LDAP server" + code: 1803 +- name: ERROR_LDAP_CANNOT_SEARCH + text: "cannot issue a LDAP search" + desc: "can not search the LDAP server" + code: 1804 +- name: ERROR_LDAP_CANNOT_START_TLS + text: "cannot start a TLS LDAP session" + desc: "can not star a TLS LDAP session" + code: 1805 +- name: ERROR_LDAP_FOUND_NO_OBJECTS + text: "LDAP didn't found any objects" + desc: "LDAP didn't found any objects with the specified search query" + code: 1806 +- name: ERROR_LDAP_NOT_ONE_USER_FOUND + text: "LDAP found zero ore more than one user" + desc: "LDAP found zero ore more than one user" + code: 1807 +- name: ERROR_LDAP_USER_NOT_IDENTIFIED + text: "LDAP found a user, but its not the desired one" + desc: "LDAP found a user, but its not the desired one" + code: 1808 +- name: ERROR_LDAP_OPERATIONS_ERROR + text: "LDAP returned an operations error" + desc: "LDAP returned an operations error" + code: 1809 +- name: ERROR_LDAP_INVALID_MODE + text: "invalid ldap mode" + desc: "cant distinguish a valid mode for provided LDAP configuration" + code: 1820 +- group: Task errors +- name: ERROR_TASK_INVALID_ID + text: "invalid task id" + desc: "Will be raised when a task is created with an invalid id." + code: 1850 +- name: ERROR_TASK_DUPLICATE_ID + text: "duplicate task id" + desc: "Will be raised when a task id is created with a duplicate id." + code: 1851 +- name: ERROR_TASK_NOT_FOUND + text: "task not found" + desc: "Will be raised when a task with the specified id could not be found." + code: 1852 +- group: Graph / traversal errors +- name: ERROR_GRAPH_INVALID_GRAPH + text: "invalid graph" + desc: "Will be raised when an invalid name is passed to the server." + code: 1901 +- name: ERROR_GRAPH_INVALID_EDGE + text: "invalid edge" + desc: "Will be raised when an invalid edge id is passed to the server." + code: 1906 +- name: ERROR_GRAPH_TOO_MANY_ITERATIONS + text: "too many iterations - try increasing the value of 'maxIterations'" + desc: "Will be raised when too many iterations are done in a graph traversal." + code: 1909 +- name: ERROR_GRAPH_INVALID_FILTER_RESULT + text: "invalid filter result" + desc: "Will be raised when an invalid filter result is returned in a graph traversal." + code: 1910 +- name: ERROR_GRAPH_COLLECTION_MULTI_USE + text: "multi use of edge collection in edge def" + desc: "an edge collection may only be used once in one edge definition of a graph." + code: 1920 +- name: ERROR_GRAPH_COLLECTION_USE_IN_MULTI_GRAPHS + text: "edge collection already used in edge def" + desc: " is already used by another graph in a different edge definition." + code: 1921 +- name: ERROR_GRAPH_CREATE_MISSING_NAME + text: "missing graph name" + desc: "a graph name is required to create or drop a graph." + code: 1922 +- name: ERROR_GRAPH_CREATE_MALFORMED_EDGE_DEFINITION + text: "malformed edge definition" + desc: "the edge definition is malformed. It has to be an array of objects." + code: 1923 +- name: ERROR_GRAPH_NOT_FOUND + text: "graph '%s' not found" + desc: "a graph with this name could not be found." + code: 1924 +- name: ERROR_GRAPH_DUPLICATE + text: "graph already exists" + desc: "a graph with this name already exists." + code: 1925 +- name: ERROR_GRAPH_VERTEX_COL_DOES_NOT_EXIST + text: "vertex collection does not exist or is not part of the graph" + desc: "the specified vertex collection does not exist or is not part of the graph." + code: 1926 +- name: ERROR_GRAPH_WRONG_COLLECTION_TYPE_VERTEX + text: "collection not a vertex collection" + desc: "the collection is not a vertex collection." + code: 1927 +- name: ERROR_GRAPH_NOT_IN_ORPHAN_COLLECTION + text: "collection is not in list of orphan collections" + desc: "Vertex collection not in list of orphan collections of the graph." + code: 1928 +- name: ERROR_GRAPH_COLLECTION_USED_IN_EDGE_DEF + text: "collection already used in edge def" + desc: "The collection is already used in an edge definition of the graph." + code: 1929 +- name: ERROR_GRAPH_EDGE_COLLECTION_NOT_USED + text: "edge collection not used in graph" + desc: "The edge collection is not used in any edge definition of the graph." + code: 1930 +- name: ERROR_GRAPH_NO_GRAPH_COLLECTION + text: "collection _graphs does not exist" + desc: "collection _graphs does not exist." + code: 1932 +- name: ERROR_GRAPH_INVALID_NUMBER_OF_ARGUMENTS + text: "Invalid number of arguments. Expected: " + desc: "Invalid number of arguments. Expected: " + code: 1935 +- name: ERROR_GRAPH_INVALID_PARAMETER + text: "Invalid parameter type." + desc: "Invalid parameter type." + code: 1936 +- name: ERROR_GRAPH_COLLECTION_USED_IN_ORPHANS + text: "collection used in orphans" + desc: "The collection is already used in the orphans of the graph." + code: 1938 +- name: ERROR_GRAPH_EDGE_COL_DOES_NOT_EXIST + text: "edge collection does not exist or is not part of the graph" + desc: "the specified edge collection does not exist or is not part of the graph." + code: 1939 +- name: ERROR_GRAPH_EMPTY + text: "empty graph" + desc: "The requested graph has no edge collections." + code: 1940 +- name: ERROR_GRAPH_INTERNAL_DATA_CORRUPT + text: "internal graph data corrupt" + desc: "The _graphs collection contains invalid data." + code: 1941 +- name: ERROR_GRAPH_CREATE_MALFORMED_ORPHAN_LIST + text: "malformed orphan list" + desc: "the orphan list argument is malformed. It has to be an array of strings." + code: 1943 +- name: ERROR_GRAPH_EDGE_DEFINITION_IS_DOCUMENT + text: "edge definition collection is a document collection" + desc: "the collection used as a relation is existing, but is a document collection, it cannot be used here." + code: 1944 +- name: ERROR_GRAPH_COLLECTION_IS_INITIAL + text: "initial collection is not allowed to be removed manually" + desc: "the collection is used as the initial collection of this graph and is not allowed to be removed manually." + code: 1945 +- name: ERROR_GRAPH_NO_INITIAL_COLLECTION + text: "no valid initial collection found" + desc: "during the graph creation process no collection could be selected as the needed initial collection. Happens if a distributeShardsLike or replicationFactor mismatch was found." + code: 1946 +- name: ERROR_GRAPH_REFERENCED_VERTEX_COLLECTION_NOT_USED + text: "referenced vertex collection is not part of the graph" + desc: "the _from or _to collection specified for the edge refers to a vertex collection which is not used in any edge definition of the graph." + code: 1947 +- name: ERROR_GRAPH_NEGATIVE_EDGE_WEIGHT + text: "negative edge weight found" + desc: "a negative edge weight was found during a weighted graph traversal or shortest path query" + code: 1948 +- group: Session errors +- name: ERROR_SESSION_UNKNOWN + text: "unknown session" + desc: "Will be raised when an invalid/unknown session id is passed to the server." + code: 1950 +- name: ERROR_SESSION_EXPIRED + text: "session expired" + desc: "Will be raised when a session is expired." + code: 1951 +- group: Simple Client errors +- name: ERROR_SIMPLE_CLIENT_UNKNOWN_ERROR + text: "unknown client error" + desc: "This error should not happen." + code: 2000 +- name: ERROR_SIMPLE_CLIENT_COULD_NOT_CONNECT + text: "could not connect to server" + desc: "Will be raised when the client could not connect to the server." + code: 2001 +- name: ERROR_SIMPLE_CLIENT_COULD_NOT_WRITE + text: "could not write to server" + desc: "Will be raised when the client could not write data." + code: 2002 +- name: ERROR_SIMPLE_CLIENT_COULD_NOT_READ + text: "could not read from server" + desc: "Will be raised when the client could not read data." + code: 2003 +- name: ERROR_WAS_ERLAUBE + text: "was erlaube?!" + desc: "Will be raised if was erlaube?!" + code: 2019 +- group: internal AQL errors +- name: ERROR_INTERNAL_AQL + text: "General internal AQL error" + desc: "Internal error during AQL execution" + code: 2200 +- name: ERROR_WROTE_TOO_FEW_OUTPUT_REGISTERS + text: "An AQL block wrote too few output registers" + desc: "An AQL block wrote too few output registers" + code: 2201 +- name: ERROR_WROTE_TOO_MANY_OUTPUT_REGISTERS + text: "An AQL block wrote too many output registers" + desc: "An AQL block wrote too many output registers" + code: 2202 +- name: ERROR_WROTE_OUTPUT_REGISTER_TWICE + text: "An AQL block wrote an output register twice" + desc: "An AQL block wrote an output register twice" + code: 2203 +- name: ERROR_WROTE_IN_WRONG_REGISTER + text: "An AQL block wrote in a register that is not its output" + desc: "An AQL block wrote in a register that is not its output" + code: 2204 +- name: ERROR_INPUT_REGISTERS_NOT_COPIED + text: "An AQL block did not copy its input registers" + desc: "An AQL block did not copy its input registers" + code: 2205 +- group: Foxx management errors +- name: ERROR_MALFORMED_MANIFEST_FILE + text: "failed to parse manifest file" + desc: "The service manifest file is not well-formed JSON." + code: 3000 +- name: ERROR_INVALID_SERVICE_MANIFEST + text: "manifest file is invalid" + desc: "The service manifest contains invalid values." + code: 3001 +- name: ERROR_SERVICE_FILES_MISSING + text: "service files missing" + desc: "The service folder or bundle does not exist on this server." + code: 3002 +- name: ERROR_SERVICE_FILES_OUTDATED + text: "service files outdated" + desc: "The local service bundle does not match the checksum in the database." + code: 3003 +- name: ERROR_INVALID_FOXX_OPTIONS + text: "service options are invalid" + desc: "The service options contain invalid values." + code: 3004 +- name: ERROR_INVALID_MOUNTPOINT + text: "invalid mountpath" + desc: "The service mountpath contains invalid characters." + code: 3007 +- name: ERROR_SERVICE_NOT_FOUND + text: "service not found" + desc: "No service found at the given mountpath." + code: 3009 +- name: ERROR_SERVICE_NEEDS_CONFIGURATION + text: "service needs configuration" + desc: "The service is missing configuration or dependencies." + code: 3010 +- name: ERROR_SERVICE_MOUNTPOINT_CONFLICT + text: "service already exists" + desc: "A service already exists at the given mountpath." + code: 3011 +- name: ERROR_SERVICE_MANIFEST_NOT_FOUND + text: "missing manifest file" + desc: "The service directory does not contain a manifest file." + code: 3012 +- name: ERROR_SERVICE_OPTIONS_MALFORMED + text: "failed to parse service options" + desc: "The service options are not well-formed JSON." + code: 3013 +- name: ERROR_SERVICE_SOURCE_NOT_FOUND + text: "source path not found" + desc: "The source path does not match a file or directory." + code: 3014 +- name: ERROR_SERVICE_SOURCE_ERROR + text: "error resolving source" + desc: "The source path could not be resolved." + code: 3015 +- name: ERROR_SERVICE_UNKNOWN_SCRIPT + text: "unknown script" + desc: "The service does not have a script with this name." + code: 3016 +- name: ERROR_SERVICE_API_DISABLED + text: "service api disabled" + desc: "The API for managing Foxx services has been disabled on this server." + code: 3099 +- group: JavaScript module loader errors +- name: ERROR_MODULE_NOT_FOUND + text: "cannot locate module" + desc: "The module path could not be resolved." + code: 3100 +- name: ERROR_MODULE_SYNTAX_ERROR + text: "syntax error in module" + desc: "The module could not be parsed because of a syntax error." + code: 3101 +- name: ERROR_MODULE_FAILURE + text: "failed to invoke module" + desc: "Failed to invoke the module in its context." + code: 3103 +- group: Enterprise Edition errors +- name: ERROR_NO_SMART_COLLECTION + text: "collection is not smart" + desc: "The requested collection needs to be smart, but it isn't." + code: 4000 +- name: ERROR_NO_SMART_GRAPH_ATTRIBUTE + text: "smart graph attribute not given" + desc: "The given document does not have the SmartGraph attribute set." + code: 4001 +- name: ERROR_CANNOT_DROP_SMART_COLLECTION + text: "cannot drop this smart collection" + desc: "This smart collection cannot be dropped, it dictates sharding in the graph." + code: 4002 +- name: ERROR_KEY_MUST_BE_PREFIXED_WITH_SMART_GRAPH_ATTRIBUTE + text: "in smart vertex collections _key must be a string and prefixed with the value of the smart graph attribute" + desc: "In a smart vertex collection _key must be prefixed with the value of the SmartGraph attribute." + code: 4003 +- name: ERROR_ILLEGAL_SMART_GRAPH_ATTRIBUTE + text: "attribute cannot be used as smart graph attribute" + desc: "The given smartGraph attribute is illegal and cannot be used for sharding. All system attributes are forbidden." + code: 4004 +- name: ERROR_SMART_GRAPH_ATTRIBUTE_MISMATCH + text: "smart graph attribute mismatch" + desc: "The SmartGraph attribute of the given collection does not match the SmartGraph attribute of the graph." + code: 4005 +- name: ERROR_INVALID_SMART_JOIN_ATTRIBUTE + text: "invalid smart join attribute declaration" + desc: "Will be raised when the smartJoinAttribute declaration is invalid." + code: 4006 +- name: ERROR_KEY_MUST_BE_PREFIXED_WITH_SMART_JOIN_ATTRIBUTE + text: "shard key value must be prefixed with the value of the smart join attribute" + desc: "when using smartJoinAttribute for a collection, the shard key value must be prefixed with the value of the SmartJoin attribute." + code: 4007 +- name: ERROR_NO_SMART_JOIN_ATTRIBUTE + text: "smart join attribute not given or invalid" + desc: "The given document does not have the required SmartJoin attribute set or it has an invalid value." + code: 4008 +- name: ERROR_CLUSTER_MUST_NOT_CHANGE_SMART_JOIN_ATTRIBUTE + text: "must not change the value of the smartJoinAttribute" + desc: "Will be raised if there is an attempt to update the value of the smartJoinAttribute." + code: 4009 +- name: ERROR_INVALID_DISJOINT_SMART_EDGE + text: "non disjoint edge found" + desc: "Will be raised if there is an attempt to create an edge between separated graph components." + code: 4010 +- name: ERROR_UNSUPPORTED_CHANGE_IN_SMART_TO_SATELLITE_DISJOINT_EDGE_DIRECTION + text: "Unsupported alternating Smart and Satellite in Disjoint SmartGraph." + desc: "Switching back and forth between Satellite and Smart in Disjoint SmartGraph is not supported within a single AQL statement. Split into multiple statements." + code: 4011 +- group: Agency errors +- name: ERROR_AGENCY_MALFORMED_GOSSIP_MESSAGE + text: "malformed gossip message" + desc: "Malformed gossip message." + code: 20001 +- name: ERROR_AGENCY_MALFORMED_INQUIRE_REQUEST + text: "malformed inquire request" + desc: "Malformed inquire request." + code: 20002 +- name: ERROR_AGENCY_INFORM_MUST_BE_OBJECT + text: "Inform message must be an object." + desc: "The inform message in the Agency must be an object." + code: 20011 +- name: ERROR_AGENCY_INFORM_MUST_CONTAIN_TERM + text: "Inform message must contain uint parameter 'term'" + desc: "The inform message in the Agency must contain a uint parameter 'term'." + code: 20012 +- name: ERROR_AGENCY_INFORM_MUST_CONTAIN_ID + text: "Inform message must contain string parameter 'id'" + desc: "The inform message in the Agency must contain a string parameter 'id'." + code: 20013 +- name: ERROR_AGENCY_INFORM_MUST_CONTAIN_ACTIVE + text: "Inform message must contain array 'active'" + desc: "The inform message in the Agency must contain an array 'active'." + code: 20014 +- name: ERROR_AGENCY_INFORM_MUST_CONTAIN_POOL + text: "Inform message must contain object 'pool'" + desc: "The inform message in the Agency must contain an object 'pool'." + code: 20015 +- name: ERROR_AGENCY_INFORM_MUST_CONTAIN_MIN_PING + text: "Inform message must contain object 'min ping'" + desc: "The inform message in the Agency must contain an object 'min ping'." + code: 20016 +- name: ERROR_AGENCY_INFORM_MUST_CONTAIN_MAX_PING + text: "Inform message must contain object 'max ping'" + desc: "The inform message in the Agency must contain an object 'max ping'." + code: 20017 +- name: ERROR_AGENCY_INFORM_MUST_CONTAIN_TIMEOUT_MULT + text: "Inform message must contain object 'timeoutMult'" + desc: "The inform message in the Agency must contain an object 'timeoutMult'." + code: 20018 +- name: ERROR_AGENCY_CANNOT_REBUILD_DBS + text: "Cannot rebuild readDB and spearHead" + desc: "Will be raised if the readDB or the spearHead cannot be rebuilt from the replicated log." + code: 20021 +- name: ERROR_AGENCY_MALFORMED_TRANSACTION + text: "malformed agency transaction" + desc: "Malformed agency transaction." + code: 20030 +- group: Supervision errors +- name: ERROR_SUPERVISION_GENERAL_FAILURE + text: "general supervision failure" + desc: "General supervision failure." + code: 20501 +- group: Scheduler errors +- name: ERROR_QUEUE_FULL + text: "queue is full" + desc: "Will be returned if the scheduler queue is full." + code: 21003 +- name: ERROR_QUEUE_TIME_REQUIREMENT_VIOLATED + text: "queue time violated" + desc: "Will be returned if a request with a queue time requirement is set and it cannot be fulfilled." + code: 21004 +- group: Maintenance errors +- name: ERROR_ACTION_OPERATION_UNABORTABLE + text: "this maintenance action cannot be stopped" + desc: "This maintenance action cannot be stopped once it is started" + code: 6002 +- name: ERROR_ACTION_UNFINISHED + text: "maintenance action still processing" + desc: "This maintenance action is still processing" + code: 6003 +- group: Backup/Restore errors +- name: ERROR_HOT_BACKUP_INTERNAL + text: "internal hot backup error" + desc: "Failed to create hot backup set" + code: 7001 +- name: ERROR_HOT_RESTORE_INTERNAL + text: "internal hot restore error" + desc: "Failed to restore to hot backup set" + code: 7002 +- name: ERROR_BACKUP_TOPOLOGY + text: "backup does not match this topology" + desc: "The hot backup set cannot be restored on non matching cluster topology" + code: 7003 +- name: ERROR_NO_SPACE_LEFT_ON_DEVICE + text: "no space left on device" + desc: "No space left on device" + code: 7004 +- name: ERROR_FAILED_TO_UPLOAD_BACKUP + text: "failed to upload hot backup set to remote target" + desc: "Failed to upload hot backup set to remote target" + code: 7005 +- name: ERROR_FAILED_TO_DOWNLOAD_BACKUP + text: "failed to download hot backup set from remote source" + desc: "Failed to download hot backup set from remote source" + code: 7006 +- name: ERROR_NO_SUCH_HOT_BACKUP + text: "no such hot backup set can be found" + desc: "Cannot find a hot backup set with this Id" + code: 7007 +- name: ERROR_REMOTE_REPOSITORY_CONFIG_BAD + text: "remote hotback repository configuration error" + desc: "The configuration given for upload or download operation to/from remote hot backup repositories is wrong." + code: 7008 +- name: ERROR_LOCAL_LOCK_FAILED + text: "some db servers cannot be reached for transaction locks" + desc: "Some of the DB-Servers cannot be reached for transaction locks." + code: 7009 +- name: ERROR_LOCAL_LOCK_RETRY + text: "some db servers cannot be reached for transaction locks" + desc: "Some of the DB-Servers cannot be reached for transaction locks." + code: 7010 +- name: ERROR_HOT_BACKUP_CONFLICT + text: "hot backup conflict" + desc: "Conflict of multiple hot backup processes." + code: 7011 +- name: ERROR_HOT_BACKUP_DBSERVERS_AWOL + text: "hot backup not all db servers reachable" + desc: "One or more DB-Servers could not be reached for hot backup inquiry" + code: 7012 +- group: Plan Analyzers errors +- name: ERROR_CLUSTER_COULD_NOT_MODIFY_ANALYZERS_IN_PLAN + text: "analyzers in plan could not be modified" + desc: "Plan could not be modified while creating or deleting Analyzers revision" + code: 7021 +- group: AIR errors +- name: ERROR_AIR_EXECUTION_ERROR + text: "error during AIR execution" + desc: "During the execution of an AIR program an error occurred" + code: 8001 +- group: Licensing +- name: ERROR_LICENSE_EXPIRED_OR_INVALID + text: "license has expired or is invalid" + desc: "The license has expired or is invalid." + code: 9001 +- name: ERROR_LICENSE_SIGNATURE_VERIFICATION + text: "license verification failed" + desc: "Verification of license failed." + code: 9002 +- name: ERROR_LICENSE_NON_MATCHING_ID + text: "non-matching license id" + desc: "The ID of the license does not match the ID of this instance." + code: 9003 +- name: ERROR_LICENSE_FEATURE_NOT_ENABLED + text: "feature is not enabled by the license" + desc: "The installed license does not cover this feature." + code: 9004 +- name: ERROR_LICENSE_RESOURCE_EXHAUSTED + text: "the resource is exhausted" + desc: "The installed license does not cover a higher number of this resource." + code: 9005 +- name: ERROR_LICENSE_INVALID + text: "invalid license" + desc: "The license does not hold features of an ArangoDB license." + code: 9006 +- name: ERROR_LICENSE_CONFLICT + text: "conflicting license" + desc: "The license has one or more inferior features." + code: 9007 +- name: ERROR_LICENSE_VALIDATION_FAILED + text: "failed to validate license signature" + desc: "Could not verify the license's signature." + code: 9008 diff --git a/site/data/3.10/optimizer-rules.json b/site/data/3.10/optimizer-rules.json new file mode 100644 index 0000000000..0f6f9fbebb --- /dev/null +++ b/site/data/3.10/optimizer-rules.json @@ -0,0 +1,782 @@ +[ + { + "name": "replace-function-with-index", + "description": "Replace deprecated index functions such as `FULLTEXT()`,\n`NEAR()`, `WITHIN()`, or `WITHIN_RECTANGLE()` with a regular subquery.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": false, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "inline-subqueries", + "description": "Try to pull subqueries out into their surrounding scope, e.g.\n`FOR x IN (FOR y IN collection FILTER y.value >= 5 RETURN y.test) RETURN x.a`\nbecomes `FOR tmp IN collection FILTER tmp.value >= 5 LET x = tmp.test RETURN x.a`.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "simplify-conditions", + "description": "Replace parts in `CalculationNode` expressions with\nsimpler expressions.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "move-calculations-up", + "description": "Move calculations up in the processing pipeline as far as\npossible (ideally out of enumerations) so they are not executed in loops if not\nrequired. It is quite common that this rule enables further optimizations.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "move-filters-up", + "description": "Move filters up in the processing pipeline as far as possible\n(ideally out of inner loops) so they filter results as early as possible.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-redundant-calculations", + "description": "Replace references to redundant calculations (expressions\nwith the exact same result) with a single reference, allowing other rules to\nremove no longer needed calculations.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-unnecessary-filters", + "description": "Remove `FILTER` conditions that always evaluate to `true`.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-unnecessary-calculations", + "description": "Remove all calculations whose result is not referenced in the\nquery. This can be a consequence of applying other optimizations.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "specialize-collect", + "description": "Appears whenever a `COLLECT` statement is used in a query to determine\nthe type of `CollectNode` to use.", + "flags": { + "hidden": true, + "clusterOnly": false, + "canBeDisabled": false, + "canCreateAdditionalPlans": true, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-redundant-sorts", + "description": "Try to merge multiple `SORT` statements into fewer sorts.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "optimize-subqueries", + "description": "Apply optimizations to subqueries.\n\nThis rule adds a `LIMIT` statement to qualifying subqueries to make them return\nless data. It also modifies the result value of subqueries in case only the\nnumber of subquery results is checked later. This saves copying the document\ndata from the subquery to the outer scope and may enable follow-up\noptimizations.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "interchange-adjacent-enumerations", + "description": "Try out permutations of `FOR` statements in queries that contain\nmultiple loops, which may enable further optimizations by other rules.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": true, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "move-calculations-up-2", + "description": "Second pass of moving calculations up in the processing\npipeline as far as possible, to pull them out of inner loops etc.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "move-filters-up-2", + "description": "Second pass of moving filters up in the processing pipeline\nas far as possible so they filter results as early as possible.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-redundant-sorts-2", + "description": "Second pass of trying to merge multiple `SORT` statements\ninto fewer sorts.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-sort-rand-limit-1", + "description": "Remove `SORT RAND() LIMIT 1` constructs by moving the random iteration\ninto `EnumerateCollectionNode`.\n\nThe RocksDB storage engine doesn't allow to seek random documents efficiently.\nThis optimization picks a pseudo-random document based on a limited number of\nseeks within the collection's key range, selecting a random start key in the\nkey range, and then going a few steps before or after that.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-collect-variables", + "description": "Remove `INTO` and `AGGREGATE` clauses from `COLLECT`\nstatements if the result is not used.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "propagate-constant-attributes", + "description": "Insert constant values into `FILTER` conditions, replacing\ndynamic attribute values.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-data-modification-out-variables", + "description": "Avoid setting the pseudo-variables `OLD` and `NEW` if they\nare not used in data modification queries.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "replace-or-with-in", + "description": "Combine multiple `OR` equality conditions on the same\nvariable or attribute with an `IN` condition.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-redundant-or", + "description": "Combine multiple `OR` conditions for the same variable or\nattribute into a single condition.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "geo-index-optimizer", + "description": "Utilize geo-spatial indexes.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "use-indexes", + "description": "Use indexes to iterate over collections, replacing\n`EnumerateCollectionNode` with `IndexNode` in the query plan.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-filter-covered-by-index", + "description": "Replace or remove `FilterNode` if the filter conditions are\nalready covered by `IndexNode`.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-unnecessary-filters-2", + "description": "Second pass of removing `FILTER` conditions that always\nevaluate to `true`.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "use-index-for-sort", + "description": "Use indexes to avoid `SORT` operations, removing `SortNode`\nfrom the query plan.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "sort-in-values", + "description": "Use a binary search for in-list lookups with a logarithmic\ncomplexity instead of the default linear complexity in-list lookup if the\ncomparison array on the right-hand side of an `IN` operator is pre-sorted by an\nextra function call.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "optimize-traversals", + "description": "Try to move `FILTER` conditions into `TraversalNode` for\nearly pruning of results, apply traversal projections, and avoid calculating\nedge and path output variables that are not declared in the query for the\nAQL traversal.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "optimize-paths", + "description": "Check how the output variables of `K_PATHS`, `K_SHORTEST_PATHS`,\nand `ALL_SHORTEST_PATHS` path search graph algorithms are used and avoid\nloading the vertex documents if they are not accessed in the query.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-filter-covered-by-traversal", + "description": "Replace or remove `FilterNode` if the filter conditions are\nalready covered by `TraversalNode`.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "handle-arangosearch-views", + "description": "Appears whenever an `arangosearch` or `search-alias` View is accessed\nin a query.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": false, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "arangosearch-constrained-sort", + "description": "Make nodes of type `EnumerateViewNode` aware of `SORT` with a\nsubsequent `LIMIT` when using Views to reduce memory usage and avoid unnecessary\nsorting that has already been carried out by ArangoSearch internally.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-unnecessary-calculations-2", + "description": "Second pass of removing all calculations whose result is not\nreferenced in the query. This can be a consequence of applying other\noptimizations", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-redundant-path-var", + "description": "Avoid computing the variables emitted by AQL traversals if\nthey are declared but unused in the query, or only used in filters that are\npulled into the traversal, significantly reducing overhead.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "optimize-cluster-single-document-operations", + "description": "Let a Coordinator work with a document directly if you\nreference a document by its `_key`. In this case, no AQL is executed on the\nDB-Servers.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "move-calculations-down", + "description": "Move calculations down in the processing pipeline as far as\npossible (below `FILTER`, `LIMIT` and `SUBQUERY` nodes) so they are executed as\nlate as possible and not before their results are required.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "fuse-filters", + "description": "Merges adjacent `FILTER` nodes together into a single\n`FILTER` node.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "cluster-one-shard", + "description": "Offload the entire query to the DB-Server (except the client\ncommunication via a Coordinator). This saves all the back and forth that\nnormally exists in regular cluster queries, benefitting traversals and joins\nin particular.\n\nOnly for eligible queries in the OneShard deployment mode as well as for\nqueries that only involve collection(s) with a single shard (and identical\nsharding in case of multiple collections, e.g. via `distributeShardsLike`).\nQueries involving V8 / JavaScript (e.g. user-defined AQL functions) or\nSmartGraphs cannot be optimized.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "cluster-lift-constant-for-disjoint-graph-nodes", + "description": "Detect SmartGraph traversals with a constant start vertex to\nprepare follow-up optimizations that can determine the shard location and push\ndown calculations to a DB-Server.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": false, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "distribute-in-cluster", + "description": "Appears if query parts get distributed in a cluster.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": false, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "smart-joins", + "description": "Reduce inter-node joins to server-local joins.\nThis rule is only employed when joining two collections with identical sharding\nsetup via their shard keys.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "scatter-in-cluster", + "description": "Appears if nodes of the types `ScatterNode`, `GatherNode`,\nand `RemoteNode` are inserted into a distributed query plan.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": false, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "scatter-satellite-graphs", + "description": "Execute nodes of the types `TraversalNode`,\n`ShortestPathNode`, and `KShortestPathsNode` on a DB-Server instead of on a\nCoordinator if the nodes operate on SatelliteGraphs, removing the need to\ntransfer data for these nodes.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "remove-satellite-joins", + "description": "Optimize nodes of the types `ScatterNode`, `GatherNode`, and\n`RemoteNode` for SatelliteCollections and SatelliteGraphs away. Execute the\nrespective query parts on each participating DB-Server independently, so that\nthe results become available locally without network communication.\nDepends on the `remove-unnecessary-remote-scatter` rule.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "remove-distribute-nodes", + "description": "Combine multiples nodes of type `DistributeNode` into one if\ntwo adjacent `DistributeNode` nodes share the same input variables and\ntherefore can be optimized into a single `DistributeNode`.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "distribute-offset-info-to-cluster", + "description": "Push the calculation of search highlighting information to\nDB-Servers where the data for determining the offsets is stored.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": false, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "distribute-filtercalc-to-cluster", + "description": "Move filters up in a distributed execution plan. Filters are\nmoved as far up in the plan as possible to make result sets as small as\npossible, as early as possible.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "distribute-sort-to-cluster", + "description": "Move sort operations up in a distributed query. Sorts are\nmoved as far up in the query plan as possible to make result sets as small as\npossible, as early as possible.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "move-filters-into-enumerate", + "description": "Move filters on non-indexed collection attributes into\n`IndexNode` or `EnumerateCollectionNode` to allow early pruning of\nnon-matching documents. This optimization can help to avoid a lot of temporary\ndocument copies.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "remove-unnecessary-calculations-3", + "description": "Third pass of removing all calculations whose result is not\nreferenced in the query. This can be a consequence of applying other\noptimizations", + "flags": { + "hidden": true, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": true, + "enterpriseOnly": false + } + }, + { + "name": "remove-unnecessary-remote-scatter", + "description": "Avoid distributing calculations and handle them centrally if\na `RemoteNode` is followed by a `ScatterNode`, and the `ScatterNode` is only\nfollowed by calculations or a `SingletonNode`.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "undistribute-remove-after-enum-coll", + "description": "Push nodes of type `RemoveNode` into the same query part that\nenumerates over the documents of a collection. This saves inter-cluster\nroundtrips between the `EnumerateCollectionNode` and the `RemoveNode`.\nIt includes simple `UPDATE` and `REPLACE` operations that modify multiple\ndocuments and do not use `LIMIT`.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "collect-in-cluster", + "description": "Perform the heavy processing for `COLLECT` statements on\nDB-Servers and only light-weight aggregation on a Coordinator. Both sides get\na `CollectNode` in the query plan.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "sort-limit", + "description": "Make `SORT` aware of a subsequent `LIMIT` to enable\noptimizations internal to the `SortNode` that allow to reduce memory usage\nand, in many cases, improve the sorting speed.\n\nA `SortNode` needs to be followed by a `LimitNode` with no intervening nodes\nthat may change the element count (e.g. a `FilterNode` which cannot be moved\nbefore the sort, or a source node like `EnumerateCollectionNode`).\n\nThe optimizer may choose not to apply the rule if it decides that it offers\nlittle or no benefit. In particular, it does not apply the rule if the input\nsize is very small or if the output from the `LimitNode` is similar in size to\nthe input. In exceptionally rare cases, this rule could result in some small\nslowdown. If observed, you can disable the rule for the affected query at the\ncost of increased memory usage.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "reduce-extraction-to-projection", + "description": "Modify `EnumerationCollectionNode` and `IndexNode` that would have\nextracted entire documents to only return a projection of each document.\n\nProjections are limited to at most 5 different document attributes by default.\nThe maximum number of projected attributes can optionally be adjusted by\nsetting the `maxProjections` hint for an AQL `FOR` operation since\nArangoDB 3.9.1.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "restrict-to-single-shard", + "description": "Restrict operations to a single shard instead of applying\nthem for all shards if a collection operation (`IndexNode` or a\ndata modification node) only affects a single shard.\n \nThis optimization can be applied for queries that access a collection only once\nin the query, and that do not use traversals, shortest path queries, and that\ndo not access collection data dynamically using the `DOCUMENT()`, `FULLTEXT()`,\n`NEAR()` or `WITHIN()` AQL functions. Additionally, the optimizer can only\napply this optimization if it can safely determine the values of all the\ncollection's shard keys from the query, and when the shard keys are covered by\na single index (this is always true if the shard key is the default `_key`).", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "optimize-count", + "description": "Optimize subqueries to use an optimized code path for\ncounting documents.\n\nThe requirements are that the subquery result must only be used with the\n`COUNT()` or `LENGTH()` AQL function and not for anything else. The subquery\nitself must be read-only (no data modification subquery), not use nested `FOR`\nloops, no `LIMIT` statement, and no `FILTER` condition or calculation that\nrequires accessing document data. Accessing index data is supported for\nfiltering but not for further calculations.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "parallelize-gather", + "description": "Apply an optimization to execute Coordinator `GatherNode`\nnodes in parallel. These notes cannot be parallelized if they depend on a\n`TraversalNode`, except for certain Disjoint SmartGraph traversals where the\ntraversal can run completely on the local DB-Server.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "async-prefetch", + "description": "Allow query execution nodes to asynchronously prefetch the\nnext batch while processing the current batch, allowing parts of the query to\nrun in parallel. This is an experimental option as not all operations are\nthread-safe.", + "flags": { + "hidden": true, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": true, + "enterpriseOnly": false + } + }, + { + "name": "decay-unnecessary-sorted-gather", + "description": "Avoid merge-sorting results on a Coordinator if they are all\nfrom a single shard and fully sorted by a DB-Server already.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "push-subqueries-to-dbserver", + "description": "Execute subqueries entirely on a DB-Server if possible.\nSubqueries need to contain exactly one distribute/gather section, and only one\ncollection access or traversal, shortest path, or k-shortest paths query.", + "flags": { + "hidden": false, + "clusterOnly": true, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "late-document-materialization-arangosearch", + "description": "Try to read from the underlying collections of a View as late\nas possible if the involved attributes are covered by the View index.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "late-document-materialization", + "description": "Try to read from collections as late as possible if the\ninvolved attributes are covered by regular indexes.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + }, + { + "name": "late-materialization-offset-info", + "description": "Get the search highlighting offsets as late as possible to\navoid unnecessary reads.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": true, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": true + } + }, + { + "name": "splice-subqueries", + "description": "Appears if subqueries are spliced into the surrounding query,\nreducing overhead for executing subqueries by inlining the execution.\nThis mainly benefits queries which execute subqueries very often that only\nreturn a few results at a time.\n\nThis optimization is performed on all subqueries and is applied after all other\noptimizations.", + "flags": { + "hidden": false, + "clusterOnly": false, + "canBeDisabled": false, + "canCreateAdditionalPlans": false, + "disabledByDefault": false, + "enterpriseOnly": false + } + } +] diff --git a/site/data/versions.yaml b/site/data/versions.yaml index c61d8b28ab..cba066d07d 100644 --- a/site/data/versions.yaml +++ b/site/data/versions.yaml @@ -9,6 +9,6 @@ deprecated: false - name: '3.10' - version: '3.10.9' + version: "3.10.9" alias: "" deprecated: false \ No newline at end of file