DesignDocument accepts additional properties.
Schema for a map of attachment name to attachment metadata.
Schema for a list of document revision identifiers.
Deletion flag. Available if document was removed.
Schema for a list of document revision identifiers.
Document ID.
Document's update sequence in current database. Available if requested with local_seq=true query parameter.
Schema for a document revision identifier.
Schema for list of revision information.
Schema for a list of objects with information about local revisions and their status.
Indicates whether to automatically build indexes defined in this design document.
Schema for filter functions definition. This schema is a map where keys are the names of the filter functions and values are the function definition in string format.
Search (text) index function definitions.
Defines Query Server key to process design document functions.
Schema for design document options.
Schema for geospatial index function definitions.
Validate document update function can be used to prevent invalid or unauthorized document update requests from being stored. Validation functions typically examine the structure of the new document to ensure that required fields are present and to verify that the requesting user should be allowed to make changes to the document properties. When a write request is received for a given database, the validation function in each design document in that database is called in an unspecified order. If any of the validation functions throw an error, the write will not succeed.
The validation function can abort the pending document write by throwing one of two error objects:
// user is not authorized to make the change but may re-authenticate throw({ unauthorized: 'Error message here.'
});
// change is not allowed throw({ forbidden: 'Error message here.' });
The function takes 4 parameters:
newDoc - New version of document that will be stored
from the update request.oldDoc - Previous version of document that is already stored.userCtx - User Context Object, containing information about the
user writing the document (if present), see the UserContext.secObj - Security Object, with lists of database security roles,
see the SecurityObject.Schema for design document views.
Generated using TypeDoc
Schema for a design document.