Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,6 @@ Note that this page does not list all open issues.
| **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 |
| **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 |

## Schema Validation

| Issue |
|------------|
| **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 |
| **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 |
| **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 |

## Other

| Issue |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,6 @@ Note that this page does not list all open issues.
| **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 |
| **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 |

## Schema Validation

| Issue |
|------------|
| **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 |
| **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 |
| **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 |

## Other

| Issue |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,6 @@ Note that this page does not list all open issues.
| **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 |
| **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 |

## Schema Validation

| Issue |
|------------|
| **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 |
| **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 |
| **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 |

## Other

| Issue |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 = {
Expand Down Expand Up @@ -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

Expand All @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,6 @@ Note that this page does not list all open issues.
| **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 |
| **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 |

## Schema Validation

| Issue |
|------------|
| **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 |
| **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 |
| **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 |

## Other

| Issue |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,6 @@ Note that this page does not list all open issues.
| **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 |
| **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 |

## Schema Validation

| Issue |
|------------|
| **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 |
| **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 |
| **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 |

## Other

| Issue |
Expand Down
Loading