MongoDB Schema
Resumo
- Gerencia validadores de esquema de documento do MongoDB.
- Crie, atualize e remova validadores em uma coleção.
- Suporta toda a gama de palavras-chave jsonSchema.
- Consulte [palavras-chave disponíveis jsonSchema] (https://docs.mongodb.com/manual/reference/operator/query/jsonSchema/#available-keywords) para obter detalhes.
Parâmetros
Parâmetro | Tipo | Escolhas | Valores padrão | Comentários |
|---|---|---|---|
action | string | Escolhas:
| A ação de validação para o MongoDB executar ao lidar com documentos inválidos. |
collection | string | | A coleção para trabalhar. |
db | string | | O banco de dados com o qual trabalhar. |
debug | boolean | Escolhas:
| Ative a saída de depuração adicional. |
level | string | Escolhas:
| O nível de validação do MongoDB deve ser aplicado ao atualizar documentos existentes. |
properties | dictionary | | Especificação de propriedade individual. |
required | list | | Lista de campos obrigatórios. |
state | string | Escolhas:
| O estado do validador. |
Extende fragmentos da documentação do módulo MongoDB Login options e MongoDB SSL options.
Exemplos
-- name: Require that an email address field is in every document
mongodb_schema:
db: "mydb"
collection: "contacts"
required:
- "email"
- name: More advanced example using properties
mongodb_schema:
db: "mydb"
collection: "contacts"
state: "absent"
- name: Test with debuging option - Without check mode
mongodb_schema:
<<: *mongo_parameters
db: "mydb"
collection: "contacts"
required:
- "email"
- "first_name"
- "last_name"
properties:
status:
bsonType: "string"
enum: ["ACTIVE", "DISABLED"]
description: "can only be ACTIVE or DISABLED"
year:
bsonType: "int"
minimum: 2021
maximum: 3020
exclusiveMaximum: false
description: "must be an integer from 2021 to 3020"
options:
bsonType: "array"
maxItems: 10
minItems: 5
uniqueItems: yes
email:
maxLength: 150
minLength: 5
Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
changed | boolean | sucesso | Se o módulo causou uma mudança. |
module_config | dictionary | quando debug está true | O documento validador conforme indicado pela invocação do módulo. |
msg | string | sempre | Mensagem de status. |
validator | dictionary | quando debug está true | O documento validador lido da instância. |