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 @@ -34,7 +34,7 @@ import Panel from "@site/src/components/Panel";

<Panel heading="Running an audit operation">

Use this audit approach to examine the [compliance of documents in a collection](../../../documents/schema-validation/schema-validation_overview#running-an-audit-operation) with a validation schema. You can limit the number of documents to be checked and the number of error messages returned.
Use this audit approach to examine the [compliance of documents in a collection](../../../documents/schema-validation/overview#running-an-audit-operation) with a validation schema. You can limit the number of documents to be checked and the number of error messages returned.
This method is useful for one-time audits or periodic checks of data integrity.

To execute this audit, run `StartSchemaValidationOperation`. The operation will scan the documents in the specified collection, validate each document against the provided JSON schema, and produce a report of any validation errors.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ import Panel from "@site/src/components/Panel";
This page aims to clarify the scope of settings and configurations related to schema validation.

* In this article:
* [Enabling and disabling validation for the database](../../documents/schema-validation/schema-validation_configuration#enabling-and-disabling-validation-for-the-database)
* [Per-collection configuration](../../documents/schema-validation/schema-validation_configuration#per-collection-configuration)
* [Index configuration](../../documents/schema-validation/schema-validation_configuration#index-configuration)
* [Enabling and disabling validation for the database](../../documents/schema-validation/configuration#enabling-and-disabling-validation-for-the-database)
* [Per-collection configuration](../../documents/schema-validation/configuration#per-collection-configuration)
* [Index configuration](../../documents/schema-validation/configuration#index-configuration)

</Admonition>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import Panel from "@site/src/components/Panel";
* A validation schema is a JSON object associated with a document collection.
If a schema is enabled for a collection, the collection's documents can be written only if the documents comply with the constraints defined by the schema.

* Validation is enforced both when documents are saved directly, and when they are added or modified via [supported batch operations](../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation) such as patching or ETL tasks.
* Validation is enforced both when documents are saved directly, and when they are added or modified via [supported batch operations](../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation) such as patching or ETL tasks.

* Validating document compliance during writing can help ensure data consistency (e.g., by preventing the saving of documents with missing required fields) and simplify read-time handling by preventing the need for additional checks and transformations.

Expand All @@ -31,12 +31,12 @@ import Panel from "@site/src/components/Panel";
- By [validating documents during indexing](../../documents/schema-validation/auditing-document-compliance/auditing-document-compliance_api#audit-document-compliance-by-index) and embedding validation error messages in the indexes.

* In this article:
* [The validation process](../../documents/schema-validation/schema-validation_overview#the-validation-process)
* [A list of operations that trigger validation](../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation)
* [Available constraints](../../documents/schema-validation/schema-validation_overview#available-constraints)
* [Considerations](../../documents/schema-validation/schema-validation_overview#considerations)
* [Auditing schema validation](../../documents/schema-validation/schema-validation_overview#auditing-schema-validation)
* [Use cases](../../documents/schema-validation/schema-validation_overview#use-cases)
* [The validation process](../../documents/schema-validation/overview#the-validation-process)
* [A list of operations that trigger validation](../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation)
* [Available constraints](../../documents/schema-validation/overview#available-constraints)
* [Considerations](../../documents/schema-validation/overview#considerations)
* [Auditing schema validation](../../documents/schema-validation/overview#auditing-schema-validation)
* [Use cases](../../documents/schema-validation/overview#use-cases)

</Admonition>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ await store.Maintenance.SendAsync(new ConfigureSchemaValidationOperation(configu
```

<Admonition type="note" title="">
Once a schema is enabled for a collection, collection documents are validated when they are saved directly, as well as when they are added or modified by operations such as patching or ETL tasks. (See a list of [operations that trigger validation](../../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation).)
Once a schema is enabled for a collection, collection documents are validated when they are saved directly, as well as when they are added or modified by operations such as patching or ETL tasks. (See a list of [operations that trigger validation](../../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation).)
</Admonition>

</ContentFrame>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import Panel from "@site/src/components/Panel";
# Write validation: Studio
<Admonition type="note" title="">

Manage [schema validation](../../../documents/schema-validation/schema-validation_overview) using the Studio **Document Schema** view, to condition documents storage on their compliance with a defined JSON schema.
Manage [schema validation](../../../documents/schema-validation/overview) using the Studio **Document Schema** view, to condition documents storage on their compliance with a defined JSON schema.

* In this article:
* [The Document Schema view](../../../documents/schema-validation/write-validation/write-validation_studio#the-document-schema-view)
Expand Down Expand Up @@ -73,7 +73,7 @@ To create a validation schema, open: **Settings** > **Document schema** > **Add
```

<Admonition type="note" title="">
[See a list of available constraints.](../../../documents/schema-validation/schema-validation_overview#available-constraints)
[See a list of available constraints.](../../../documents/schema-validation/overview#available-constraints)
</Admonition>

3. **Save**
Expand All @@ -86,7 +86,7 @@ To create a validation schema, open: **Settings** > **Document schema** > **Add

<Admonition type="note" title="">
Note that once a schema is enabled for a collection, collection documents are validated when they are saved directly, as well as when they are added or modified by operations such as patching or ETL tasks.
[See a list of operations that trigger validation](../../../documents/schema-validation/schema-validation_overview#a-list-of-operations-that-trigger-validation).
[See a list of operations that trigger validation](../../../documents/schema-validation/overview#a-list-of-operations-that-trigger-validation).
</Admonition>

</Panel>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ export default function DocumentExtensionsFeaturesGrid() {
{
title: "JSON Schema Validation",
icon: "document-schema",
url: `/${activeVersion.label}/documents/schema-validation/schema-validation_overview`,
url: `/${activeVersion.label}/documents/schema-validation/overview`,
description: "Simple, scalable, and conflict-free numeric counters",
minimumSupportedVersion: "7.2",
},
Expand Down