diff --git a/site/content/3.10/components/tools/arangodb-starter/architecture.md b/site/content/3.10/components/tools/arangodb-starter/architecture.md index 75d745d609..00af5d642d 100644 --- a/site/content/3.10/components/tools/arangodb-starter/architecture.md +++ b/site/content/3.10/components/tools/arangodb-starter/architecture.md @@ -123,7 +123,7 @@ args.all.log.level = startup=trace args.all.log.level = warning [starter] - mode = single +mode = single [args] all.log.level = queries=debug diff --git a/site/content/3.10/concepts/data-structure/documents/schema-validation.md b/site/content/3.10/concepts/data-structure/documents/schema-validation.md index d29a5e5dbd..aea4ceaf9a 100644 --- a/site/content/3.10/concepts/data-structure/documents/schema-validation.md +++ b/site/content/3.10/concepts/data-structure/documents/schema-validation.md @@ -10,13 +10,11 @@ description: >- While ArangoDB is schema-less, it allows to enforce certain document structures on the collection level. The desired structure can be described in the popular -[JSON Schema](https://json-schema.org/) format (draft-4, -without remote schema support). The level of validation and a custom error +[JSON Schema](https://json-schema.org/) format (draft-4, without support for +remote schemas for security reasons). The level of validation and a custom error message can be configured. The system attributes `_key`, `_id`, `_rev`, `_from` and `_to` are ignored by the schema validation. -Also see [Known Issues](../../../release-notes/version-3.10/known-issues-in-3-10.md#schema-validation) - ## Enable schema validation for a collection Schema validation can be managed via the JavaScript API, typically @@ -94,10 +92,14 @@ The level controls when the validation is triggered: ## Error message If the schema validation for a document fails, then a generic error is raised. -The schema validation cannot pin-point which part of a rule made it fail, -also see [Known Issues](../../../release-notes/version-3.10/known-issues-in-3-10.md#schema-validation). You may customize the error message via the `message` attribute to provide a -summary of what is expected or point out common mistakes. +summary of what the expected document structure is or point out common mistakes. + +The schema validation cannot pin-point which part of a rule made it fail because +it is difficult to determine and report for complex schemas. For example, when +using `not` and `anyOf`, this would result in trees of possible errors. You can +use tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/) +to examine schema validation issues. ## Performance @@ -112,3 +114,11 @@ The following AQL functions are available to work with schemas: - [SCHEMA_GET()](../../../aql/functions/miscellaneous.md#schema_get) - [SCHEMA_VALIDATE()](../../../aql/functions/miscellaneous.md#schema_validate) + +## Backup and restore + +Logical backups created with arangodump include the schema configuration, which +is a collection property. + +When using arangorestore to restore to a collection with a defined schema, +no schema validation is executed. diff --git a/site/content/3.10/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/3.10/release-notes/version-3.10/known-issues-in-3-10.md index 286fba8a2b..884cccf599 100644 --- a/site/content/3.10/release-notes/version-3.10/known-issues-in-3-10.md +++ b/site/content/3.10/release-notes/version-3.10/known-issues-in-3-10.md @@ -45,14 +45,6 @@ Note that this page does not list all open issues. | **Date Added:** 2019-10-09
**Component:** Hot Backup API / arangobackup
**Deployment Mode:** DC2DC
**Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.11/components/tools/arangodb-starter/architecture.md b/site/content/3.11/components/tools/arangodb-starter/architecture.md index 75d745d609..00af5d642d 100644 --- a/site/content/3.11/components/tools/arangodb-starter/architecture.md +++ b/site/content/3.11/components/tools/arangodb-starter/architecture.md @@ -123,7 +123,7 @@ args.all.log.level = startup=trace args.all.log.level = warning [starter] - mode = single +mode = single [args] all.log.level = queries=debug diff --git a/site/content/3.11/concepts/data-structure/documents/schema-validation.md b/site/content/3.11/concepts/data-structure/documents/schema-validation.md index 8f1443e8c9..4103722824 100644 --- a/site/content/3.11/concepts/data-structure/documents/schema-validation.md +++ b/site/content/3.11/concepts/data-structure/documents/schema-validation.md @@ -8,13 +8,11 @@ description: >- --- While ArangoDB is schema-less, it allows to enforce certain document structures on the collection level. The desired structure can be described in the popular -[JSON Schema](https://json-schema.org/) format (draft-4, -without remote schema support). The level of validation and a custom error +[JSON Schema](https://json-schema.org/) format (draft-4, without support for +remote schemas for security reasons). The level of validation and a custom error message can be configured. The system attributes `_key`, `_id`, `_rev`, `_from` and `_to` are ignored by the schema validation. -Also see [Known Issues](../../../release-notes/version-3.11/known-issues-in-3-11.md#schema-validation) - ## Enable schema validation for a collection Schema validation can be managed via the JavaScript API, typically @@ -92,10 +90,14 @@ The level controls when the validation is triggered: ## Error message If the schema validation for a document fails, then a generic error is raised. -The schema validation cannot pin-point which part of a rule made it fail, -also see [Known Issues](../../../release-notes/version-3.11/known-issues-in-3-11.md#schema-validation). You may customize the error message via the `message` attribute to provide a -summary of what is expected or point out common mistakes. +summary of what the expected document structure is or point out common mistakes. + +The schema validation cannot pin-point which part of a rule made it fail because +it is difficult to determine and report for complex schemas. For example, when +using `not` and `anyOf`, this would result in trees of possible errors. You can +use tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/) +to examine schema validation issues. ## Performance @@ -110,3 +112,11 @@ The following AQL functions are available to work with schemas: - [SCHEMA_GET()](../../../aql/functions/miscellaneous.md#schema_get) - [SCHEMA_VALIDATE()](../../../aql/functions/miscellaneous.md#schema_validate) + +## Backup and restore + +Logical backups created with arangodump include the schema configuration, which +is a collection property. + +When using arangorestore to restore to a collection with a defined schema, +no schema validation is executed. diff --git a/site/content/3.11/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/3.11/release-notes/version-3.10/known-issues-in-3-10.md index 286fba8a2b..884cccf599 100644 --- a/site/content/3.11/release-notes/version-3.10/known-issues-in-3-10.md +++ b/site/content/3.11/release-notes/version-3.10/known-issues-in-3-10.md @@ -45,14 +45,6 @@ Note that this page does not list all open issues. | **Date Added:** 2019-10-09
**Component:** Hot Backup API / arangobackup
**Deployment Mode:** DC2DC
**Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.11/release-notes/version-3.11/known-issues-in-3-11.md b/site/content/3.11/release-notes/version-3.11/known-issues-in-3-11.md index 8451eecb16..ccf040e4af 100644 --- a/site/content/3.11/release-notes/version-3.11/known-issues-in-3-11.md +++ b/site/content/3.11/release-notes/version-3.11/known-issues-in-3-11.md @@ -40,14 +40,6 @@ Note that this page does not list all open issues. | **Date Added:** 2019-10-09
**Component:** Hot Backup API / arangobackup
**Deployment Mode:** DC2DC
**Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.12/components/tools/arangodb-starter/architecture.md b/site/content/3.12/components/tools/arangodb-starter/architecture.md index b6d94d0903..b06cc0abbe 100644 --- a/site/content/3.12/components/tools/arangodb-starter/architecture.md +++ b/site/content/3.12/components/tools/arangodb-starter/architecture.md @@ -120,7 +120,7 @@ args.all.log.level = startup=trace args.all.log.level = warning [starter] - mode = single +mode = single [args] all.log.level = queries=debug diff --git a/site/content/3.12/concepts/data-structure/documents/schema-validation.md b/site/content/3.12/concepts/data-structure/documents/schema-validation.md index afe09a0220..4103722824 100644 --- a/site/content/3.12/concepts/data-structure/documents/schema-validation.md +++ b/site/content/3.12/concepts/data-structure/documents/schema-validation.md @@ -8,13 +8,11 @@ description: >- --- While ArangoDB is schema-less, it allows to enforce certain document structures on the collection level. The desired structure can be described in the popular -[JSON Schema](https://json-schema.org/) format (draft-4, -without remote schema support). The level of validation and a custom error +[JSON Schema](https://json-schema.org/) format (draft-4, without support for +remote schemas for security reasons). The level of validation and a custom error message can be configured. The system attributes `_key`, `_id`, `_rev`, `_from` and `_to` are ignored by the schema validation. -Also see [Known Issues](../../../release-notes/version-3.12/known-issues-in-3-12.md#schema-validation) - ## Enable schema validation for a collection Schema validation can be managed via the JavaScript API, typically @@ -25,8 +23,8 @@ creation or when updating the properties of an existing collection. It expects a object with the following attributes: `rule`, `level` and `message`. - The `rule` attribute must contain the JSON Schema description. -- `level` controls when the validation will be applied. -- `message` sets the message that will be used when validation fails. +- `level` controls when the validation is applied. +- `message` sets the message that is used when validation fails. ```js var schema = { @@ -92,10 +90,14 @@ The level controls when the validation is triggered: ## Error message If the schema validation for a document fails, then a generic error is raised. -The schema validation cannot pin-point which part of a rule made it fail, -also see [Known Issues](../../../release-notes/version-3.12/known-issues-in-3-12.md#schema-validation). You may customize the error message via the `message` attribute to provide a -summary of what is expected or point out common mistakes. +summary of what the expected document structure is or point out common mistakes. + +The schema validation cannot pin-point which part of a rule made it fail because +it is difficult to determine and report for complex schemas. For example, when +using `not` and `anyOf`, this would result in trees of possible errors. You can +use tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/) +to examine schema validation issues. ## Performance @@ -110,3 +112,11 @@ The following AQL functions are available to work with schemas: - [SCHEMA_GET()](../../../aql/functions/miscellaneous.md#schema_get) - [SCHEMA_VALIDATE()](../../../aql/functions/miscellaneous.md#schema_validate) + +## Backup and restore + +Logical backups created with arangodump include the schema configuration, which +is a collection property. + +When using arangorestore to restore to a collection with a defined schema, +no schema validation is executed. diff --git a/site/content/3.12/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/3.12/release-notes/version-3.10/known-issues-in-3-10.md index 286fba8a2b..884cccf599 100644 --- a/site/content/3.12/release-notes/version-3.10/known-issues-in-3-10.md +++ b/site/content/3.12/release-notes/version-3.10/known-issues-in-3-10.md @@ -45,14 +45,6 @@ Note that this page does not list all open issues. | **Date Added:** 2019-10-09
**Component:** Hot Backup API / arangobackup
**Deployment Mode:** DC2DC
**Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.12/release-notes/version-3.11/known-issues-in-3-11.md b/site/content/3.12/release-notes/version-3.11/known-issues-in-3-11.md index 8451eecb16..ccf040e4af 100644 --- a/site/content/3.12/release-notes/version-3.11/known-issues-in-3-11.md +++ b/site/content/3.12/release-notes/version-3.11/known-issues-in-3-11.md @@ -40,14 +40,6 @@ Note that this page does not list all open issues. | **Date Added:** 2019-10-09
**Component:** Hot Backup API / arangobackup
**Deployment Mode:** DC2DC
**Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.12/release-notes/version-3.12/known-issues-in-3-12.md b/site/content/3.12/release-notes/version-3.12/known-issues-in-3-12.md index 7dbe6e4e5e..a0b4fd3486 100644 --- a/site/content/3.12/release-notes/version-3.12/known-issues-in-3-12.md +++ b/site/content/3.12/release-notes/version-3.12/known-issues-in-3-12.md @@ -36,14 +36,6 @@ Note that this page does not list all open issues. |------------| | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.13/components/tools/arangodb-starter/architecture.md b/site/content/3.13/components/tools/arangodb-starter/architecture.md index b6d94d0903..b06cc0abbe 100644 --- a/site/content/3.13/components/tools/arangodb-starter/architecture.md +++ b/site/content/3.13/components/tools/arangodb-starter/architecture.md @@ -120,7 +120,7 @@ args.all.log.level = startup=trace args.all.log.level = warning [starter] - mode = single +mode = single [args] all.log.level = queries=debug diff --git a/site/content/3.13/concepts/data-structure/documents/schema-validation.md b/site/content/3.13/concepts/data-structure/documents/schema-validation.md index bc41b89ba1..4103722824 100644 --- a/site/content/3.13/concepts/data-structure/documents/schema-validation.md +++ b/site/content/3.13/concepts/data-structure/documents/schema-validation.md @@ -8,13 +8,11 @@ description: >- --- While ArangoDB is schema-less, it allows to enforce certain document structures on the collection level. The desired structure can be described in the popular -[JSON Schema](https://json-schema.org/) format (draft-4, -without remote schema support). The level of validation and a custom error +[JSON Schema](https://json-schema.org/) format (draft-4, without support for +remote schemas for security reasons). The level of validation and a custom error message can be configured. The system attributes `_key`, `_id`, `_rev`, `_from` and `_to` are ignored by the schema validation. -Also see [Known Issues](../../../release-notes/version-3.13/known-issues-in-3-13.md#schema-validation) - ## Enable schema validation for a collection Schema validation can be managed via the JavaScript API, typically @@ -25,8 +23,8 @@ creation or when updating the properties of an existing collection. It expects a object with the following attributes: `rule`, `level` and `message`. - The `rule` attribute must contain the JSON Schema description. -- `level` controls when the validation will be applied. -- `message` sets the message that will be used when validation fails. +- `level` controls when the validation is applied. +- `message` sets the message that is used when validation fails. ```js var schema = { @@ -92,10 +90,14 @@ The level controls when the validation is triggered: ## Error message If the schema validation for a document fails, then a generic error is raised. -The schema validation cannot pin-point which part of a rule made it fail, -also see [Known Issues](../../../release-notes/version-3.13/known-issues-in-3-13.md#schema-validation). You may customize the error message via the `message` attribute to provide a -summary of what is expected or point out common mistakes. +summary of what the expected document structure is or point out common mistakes. + +The schema validation cannot pin-point which part of a rule made it fail because +it is difficult to determine and report for complex schemas. For example, when +using `not` and `anyOf`, this would result in trees of possible errors. You can +use tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/) +to examine schema validation issues. ## Performance @@ -110,3 +112,11 @@ The following AQL functions are available to work with schemas: - [SCHEMA_GET()](../../../aql/functions/miscellaneous.md#schema_get) - [SCHEMA_VALIDATE()](../../../aql/functions/miscellaneous.md#schema_validate) + +## Backup and restore + +Logical backups created with arangodump include the schema configuration, which +is a collection property. + +When using arangorestore to restore to a collection with a defined schema, +no schema validation is executed. diff --git a/site/content/3.13/release-notes/version-3.10/known-issues-in-3-10.md b/site/content/3.13/release-notes/version-3.10/known-issues-in-3-10.md index 286fba8a2b..884cccf599 100644 --- a/site/content/3.13/release-notes/version-3.10/known-issues-in-3-10.md +++ b/site/content/3.13/release-notes/version-3.10/known-issues-in-3-10.md @@ -45,14 +45,6 @@ Note that this page does not list all open issues. | **Date Added:** 2019-10-09
**Component:** Hot Backup API / arangobackup
**Deployment Mode:** DC2DC
**Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.13/release-notes/version-3.11/known-issues-in-3-11.md b/site/content/3.13/release-notes/version-3.11/known-issues-in-3-11.md index 8451eecb16..ccf040e4af 100644 --- a/site/content/3.13/release-notes/version-3.11/known-issues-in-3-11.md +++ b/site/content/3.13/release-notes/version-3.11/known-issues-in-3-11.md @@ -40,14 +40,6 @@ Note that this page does not list all open issues. | **Date Added:** 2019-10-09
**Component:** Hot Backup API / arangobackup
**Deployment Mode:** DC2DC
**Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.13/release-notes/version-3.12/known-issues-in-3-12.md b/site/content/3.13/release-notes/version-3.12/known-issues-in-3-12.md index 7dbe6e4e5e..a0b4fd3486 100644 --- a/site/content/3.13/release-notes/version-3.12/known-issues-in-3-12.md +++ b/site/content/3.13/release-notes/version-3.12/known-issues-in-3-12.md @@ -36,14 +36,6 @@ Note that this page does not list all open issues. |------------| | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue | diff --git a/site/content/3.13/release-notes/version-3.13/known-issues-in-3-13.md b/site/content/3.13/release-notes/version-3.13/known-issues-in-3-13.md index 92fd4f5815..be0c19097e 100644 --- a/site/content/3.13/release-notes/version-3.13/known-issues-in-3-13.md +++ b/site/content/3.13/release-notes/version-3.13/known-issues-in-3-13.md @@ -36,14 +36,6 @@ Note that this page does not list all open issues. |------------| | **Date Added:** 2019-10-09
**Component:** arangobackup
**Deployment Mode:** All
**Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted.
**Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x, 3.13.x
**Fixed in Versions:** -
**Reference:** N/A | -## Schema Validation - -| Issue | -|------------| -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** The schema validation cannot pin-point which part of a rule made it fail. This is under investigation but very hard to solve for complex schemas. For example, when using `not` and `anyOf`, this would result in trees of possible errors. For now users should fall back to tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x, 3.13.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-03-17
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x, 3.13.x
**Fixed in Versions:** -
**Reference:** N/A | -| **Date Added:** 2019-06-25
**Component:** Schema Validation
**Deployment Mode:** All
**Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed.
**Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x, 3.12.x, 3.13.x
**Fixed in Versions:** -
**Reference:** N/A | - ## Other | Issue |