Set validation rules

A validator is a rule the server checks on every insert and update of a collection. It can be a query document ({ "price": { "$gte": 0 } }) or a JSON Schema ({ "$jsonSchema": { … } }). The Edit Validator dialog shows the current validator of a collection, checks your text before sending it, and saves it together with its validation level and action.

Add or edit a validator

1. In the connection tree, right-click the collection (for example acme_store.products) and choose Add / Edit Validator…. The same entry is in the menu bar under Collection › Add/Edit Validator….
2. The dialog shows the current validator, or an empty box if the collection has none. Type or paste the validator document under Enter the validator document for this collection:.
3. Click Validate JSON to check the syntax. The dialog says Valid JSON or points at the error.
4. Choose the Validation Level and the Validation Action (see below).
5. Click Save. The text is checked again before anything is sent; if the server rejects the validator, nothing changes on the server and your text stays in the dialog so you can fix it.

Example for products: every product needs a name and a non-negative price.

{
  "$jsonSchema": {
    "bsonType": "object",
    "required": ["name", "price"],
    "properties": {
      "name": { "bsonType": "string" },
      "price": { "bsonType": ["double", "int", "decimal"], "minimum": 0 }
    }
  }
}

Remove a validator

Open Add / Edit Validator…, clear the text box and click Save. An empty validator removes the rule.

Set a validator when creating a collection

The Add Collection… dialog (right-click a database) has a Validator page where you can enter a validator document for the new collection. See Explore for creating collections.

Options

Tips

• Analyze the collection first to see which fields are really present and with which types: see Analyze a collection’s schema.
• Roll out a new rule with Validation Action warn, check the server log, then switch to error.
• Use Validation Level moderate on a collection that still holds old, invalid documents you plan to fix later.

Troubleshooting