Skip to content

Commit 3750148

Browse files
authored
Integrate KIs into schema validation docs (#515)
1 parent 938a07e commit 3750148

File tree

18 files changed

+76
-116
lines changed

18 files changed

+76
-116
lines changed

site/content/3.10/components/tools/arangodb-starter/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ args.all.log.level = startup=trace
123123
args.all.log.level = warning
124124
125125
[starter]
126-
mode = single
126+
mode = single
127127
128128
[args]
129129
all.log.level = queries=debug

site/content/3.10/concepts/data-structure/documents/schema-validation.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,11 @@ description: >-
1010

1111
While ArangoDB is schema-less, it allows to enforce certain document structures
1212
on the collection level. The desired structure can be described in the popular
13-
[JSON Schema](https://json-schema.org/) format (draft-4,
14-
without remote schema support). The level of validation and a custom error
13+
[JSON Schema](https://json-schema.org/) format (draft-4, without support for
14+
remote schemas for security reasons). The level of validation and a custom error
1515
message can be configured. The system attributes `_key`, `_id`, `_rev`, `_from`
1616
and `_to` are ignored by the schema validation.
1717

18-
Also see [Known Issues](../../../release-notes/version-3.10/known-issues-in-3-10.md#schema-validation)
19-
2018
## Enable schema validation for a collection
2119

2220
Schema validation can be managed via the JavaScript API, typically
@@ -94,10 +92,14 @@ The level controls when the validation is triggered:
9492
## Error message
9593

9694
If the schema validation for a document fails, then a generic error is raised.
97-
The schema validation cannot pin-point which part of a rule made it fail,
98-
also see [Known Issues](../../../release-notes/version-3.10/known-issues-in-3-10.md#schema-validation).
9995
You may customize the error message via the `message` attribute to provide a
100-
summary of what is expected or point out common mistakes.
96+
summary of what the expected document structure is or point out common mistakes.
97+
98+
The schema validation cannot pin-point which part of a rule made it fail because
99+
it is difficult to determine and report for complex schemas. For example, when
100+
using `not` and `anyOf`, this would result in trees of possible errors. You can
101+
use tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
102+
to examine schema validation issues.
101103

102104
## Performance
103105

@@ -112,3 +114,11 @@ The following AQL functions are available to work with schemas:
112114

113115
- [SCHEMA_GET()](../../../aql/functions/miscellaneous.md#schema_get)
114116
- [SCHEMA_VALIDATE()](../../../aql/functions/miscellaneous.md#schema_validate)
117+
118+
## Backup and restore
119+
120+
Logical backups created with arangodump include the schema configuration, which
121+
is a collection property.
122+
123+
When using arangorestore to restore to a collection with a defined schema,
124+
no schema validation is executed.

site/content/3.10/release-notes/version-3.10/known-issues-in-3-10.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,6 @@ Note that this page does not list all open issues.
4545
| **Date Added:** 2019-10-09 <br> **Component:** Hot Backup API / arangobackup <br> **Deployment Mode:** DC2DC <br> **Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4646
| **Date Added:** 2019-10-09 <br> **Component:** arangobackup <br> **Deployment Mode:** All <br> **Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4747

48-
## Schema Validation
49-
50-
| Issue |
51-
|------------|
52-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **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/) <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
53-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
54-
| **Date Added:** 2019-06-25 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
55-
5648
## Other
5749

5850
| Issue |

site/content/3.11/components/tools/arangodb-starter/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ args.all.log.level = startup=trace
123123
args.all.log.level = warning
124124
125125
[starter]
126-
mode = single
126+
mode = single
127127
128128
[args]
129129
all.log.level = queries=debug

site/content/3.11/concepts/data-structure/documents/schema-validation.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ description: >-
88
---
99
While ArangoDB is schema-less, it allows to enforce certain document structures
1010
on the collection level. The desired structure can be described in the popular
11-
[JSON Schema](https://json-schema.org/) format (draft-4,
12-
without remote schema support). The level of validation and a custom error
11+
[JSON Schema](https://json-schema.org/) format (draft-4, without support for
12+
remote schemas for security reasons). The level of validation and a custom error
1313
message can be configured. The system attributes `_key`, `_id`, `_rev`, `_from`
1414
and `_to` are ignored by the schema validation.
1515

16-
Also see [Known Issues](../../../release-notes/version-3.11/known-issues-in-3-11.md#schema-validation)
17-
1816
## Enable schema validation for a collection
1917

2018
Schema validation can be managed via the JavaScript API, typically
@@ -92,10 +90,14 @@ The level controls when the validation is triggered:
9290
## Error message
9391

9492
If the schema validation for a document fails, then a generic error is raised.
95-
The schema validation cannot pin-point which part of a rule made it fail,
96-
also see [Known Issues](../../../release-notes/version-3.11/known-issues-in-3-11.md#schema-validation).
9793
You may customize the error message via the `message` attribute to provide a
98-
summary of what is expected or point out common mistakes.
94+
summary of what the expected document structure is or point out common mistakes.
95+
96+
The schema validation cannot pin-point which part of a rule made it fail because
97+
it is difficult to determine and report for complex schemas. For example, when
98+
using `not` and `anyOf`, this would result in trees of possible errors. You can
99+
use tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
100+
to examine schema validation issues.
99101

100102
## Performance
101103

@@ -110,3 +112,11 @@ The following AQL functions are available to work with schemas:
110112

111113
- [SCHEMA_GET()](../../../aql/functions/miscellaneous.md#schema_get)
112114
- [SCHEMA_VALIDATE()](../../../aql/functions/miscellaneous.md#schema_validate)
115+
116+
## Backup and restore
117+
118+
Logical backups created with arangodump include the schema configuration, which
119+
is a collection property.
120+
121+
When using arangorestore to restore to a collection with a defined schema,
122+
no schema validation is executed.

site/content/3.11/release-notes/version-3.10/known-issues-in-3-10.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,6 @@ Note that this page does not list all open issues.
4545
| **Date Added:** 2019-10-09 <br> **Component:** Hot Backup API / arangobackup <br> **Deployment Mode:** DC2DC <br> **Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4646
| **Date Added:** 2019-10-09 <br> **Component:** arangobackup <br> **Deployment Mode:** All <br> **Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4747

48-
## Schema Validation
49-
50-
| Issue |
51-
|------------|
52-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **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/) <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
53-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
54-
| **Date Added:** 2019-06-25 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
55-
5648
## Other
5749

5850
| Issue |

site/content/3.11/release-notes/version-3.11/known-issues-in-3-11.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,6 @@ Note that this page does not list all open issues.
4040
| **Date Added:** 2019-10-09 <br> **Component:** Hot Backup API / arangobackup <br> **Deployment Mode:** DC2DC <br> **Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4141
| **Date Added:** 2019-10-09 <br> **Component:** arangobackup <br> **Deployment Mode:** All <br> **Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4242

43-
## Schema Validation
44-
45-
| Issue |
46-
|------------|
47-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **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/) <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
48-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
49-
| **Date Added:** 2019-06-25 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x, 3.11.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
50-
5143
## Other
5244

5345
| Issue |

site/content/3.12/components/tools/arangodb-starter/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ args.all.log.level = startup=trace
120120
args.all.log.level = warning
121121
122122
[starter]
123-
mode = single
123+
mode = single
124124
125125
[args]
126126
all.log.level = queries=debug

site/content/3.12/concepts/data-structure/documents/schema-validation.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,11 @@ description: >-
88
---
99
While ArangoDB is schema-less, it allows to enforce certain document structures
1010
on the collection level. The desired structure can be described in the popular
11-
[JSON Schema](https://json-schema.org/) format (draft-4,
12-
without remote schema support). The level of validation and a custom error
11+
[JSON Schema](https://json-schema.org/) format (draft-4, without support for
12+
remote schemas for security reasons). The level of validation and a custom error
1313
message can be configured. The system attributes `_key`, `_id`, `_rev`, `_from`
1414
and `_to` are ignored by the schema validation.
1515

16-
Also see [Known Issues](../../../release-notes/version-3.12/known-issues-in-3-12.md#schema-validation)
17-
1816
## Enable schema validation for a collection
1917

2018
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
2523
object with the following attributes: `rule`, `level` and `message`.
2624

2725
- The `rule` attribute must contain the JSON Schema description.
28-
- `level` controls when the validation will be applied.
29-
- `message` sets the message that will be used when validation fails.
26+
- `level` controls when the validation is applied.
27+
- `message` sets the message that is used when validation fails.
3028

3129
```js
3230
var schema = {
@@ -92,10 +90,14 @@ The level controls when the validation is triggered:
9290
## Error message
9391

9492
If the schema validation for a document fails, then a generic error is raised.
95-
The schema validation cannot pin-point which part of a rule made it fail,
96-
also see [Known Issues](../../../release-notes/version-3.12/known-issues-in-3-12.md#schema-validation).
9793
You may customize the error message via the `message` attribute to provide a
98-
summary of what is expected or point out common mistakes.
94+
summary of what the expected document structure is or point out common mistakes.
95+
96+
The schema validation cannot pin-point which part of a rule made it fail because
97+
it is difficult to determine and report for complex schemas. For example, when
98+
using `not` and `anyOf`, this would result in trees of possible errors. You can
99+
use tools like [jsonschemavalidator.net](https://www.jsonschemavalidator.net/)
100+
to examine schema validation issues.
99101

100102
## Performance
101103

@@ -110,3 +112,11 @@ The following AQL functions are available to work with schemas:
110112

111113
- [SCHEMA_GET()](../../../aql/functions/miscellaneous.md#schema_get)
112114
- [SCHEMA_VALIDATE()](../../../aql/functions/miscellaneous.md#schema_validate)
115+
116+
## Backup and restore
117+
118+
Logical backups created with arangodump include the schema configuration, which
119+
is a collection property.
120+
121+
When using arangorestore to restore to a collection with a defined schema,
122+
no schema validation is executed.

site/content/3.12/release-notes/version-3.10/known-issues-in-3-10.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,6 @@ Note that this page does not list all open issues.
4545
| **Date Added:** 2019-10-09 <br> **Component:** Hot Backup API / arangobackup <br> **Deployment Mode:** DC2DC <br> **Description:** Hot Backup functionality in Datacenter-to-Datacenter Replication setups is experimental and may not work. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4646
| **Date Added:** 2019-10-09 <br> **Component:** arangobackup <br> **Deployment Mode:** All <br> **Description:** The startup option `--operation` works as positional argument only, e.g. `arangobackup list`. The alternative syntax `arangobackup --operation list` is not accepted. <br> **Affected Versions:** 3.5.x, 3.6.x, 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
4747

48-
## Schema Validation
49-
50-
| Issue |
51-
|------------|
52-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **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/) <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
53-
| **Date Added:** 2019-03-17 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** Remote schemas are not supported for security reasons. This limitation will likely remain unfixed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
54-
| **Date Added:** 2019-06-25 <br> **Component:** Schema Validation <br> **Deployment Mode:** All <br> **Description:** When using arangorestore for a collection with a defined schema, schema validation is not executed. <br> **Affected Versions:** 3.7.x, 3.8.x, 3.9.x, 3.10.x <br> **Fixed in Versions:** - <br> **Reference:** N/A |
55-
5648
## Other
5749

5850
| Issue |

0 commit comments

Comments
 (0)