Você pode exportar seu esquema depois de analisá-lo. Isso é útil para compartilhar seu esquema e comparar esquemas entre collections.
Antes de começar
Se ainda não o fez, analise seu esquema:
Analisar o esquema.
Clique em Analyze Schema.
Quando o Compass analisa seu esquema, ele coleta amostras de um subconjunto aleatório de documentos da sua coleção. Para saber mais sobre amostragem, consulte Amostragem.
Depois que seu esquema for analisado, use o procedimento a seguir para exportar seu esquema.
Passos
Propriedades do objeto de esquema de formato padrão
Os objetos de esquema de formato padrão contêm os seguintes campos:
Propriedade | Tipo de Dados | Descrição |
|---|---|---|
| String ou Array | Tipo JSON deste tipo de dados. Para obter detalhes, consulte os Documentos JSON oficiais do tipo. |
| array de strings | Campos que devem aparecer no esquema. Para detalhes, consulte "obrigatório" na documentação oficial JSON. |
| objeto | Propriedades para cada campo. As chaves são nomes de propriedade e os valores são subesquemas. Para obter detalhes, consulte os Documentos JSON oficiais para propriedades. |
| documento | Metadados sobre elementos em campos de array. Os metadados aparecem como subesquemas incorporados. Para obter detalhes, consulte "itens" na documentação oficial do JSON. |
Esta não é uma lista exaustiva de todos os campos possíveis. Para obter detalhes sobre campos adicionais, consulte a especificação oficial do JSON schema.
Propriedades do objeto de esquema de formato MongoDB
Os objetos de esquema de formato MongoDB contêm os seguintes campos:
Propriedade | Tipo de Dados | Descrição |
|---|---|---|
| cadeia de caracteres ou matriz de cadeias de caracteres | Tipo BSON deste campo. |
| array de strings | Campos que devem aparecer no esquema. |
| documento | Propriedades para cada campo. As chaves são nomes de propriedade e os valores são subesquemas. |
| documento | Metadados sobre elementos em campos de array. Os metadados aparecem como subesquemas incorporados. |
Esta não é uma lista exaustiva de todos os campos possíveis. Para obter detalhes sobre campos adicionais, consulte a especificação oficial do JSON schema.
Propriedades de objeto de esquema de formato expandido
Os objetos de esquema de formato expandido contêm estes campos além dos campos do Esquema padrão:
Propriedade | Tipo de Dados | Descrição |
|---|---|---|
| String ou Array | Tipo BSON deste campo. |
| documento | Documento contendo metadados sobre o campo. |
| booleano |
|
| float | Probabilidade de que o campo exista em um documento aleatório. |
| inteiro | Número de documentos da amostra que contêm este campo. |
| array | Valores de amostra como JSON expandido. Os valores das amostras estão limitados aos primeiros 100 caracteres. |
Esta não é uma lista exaustiva de todos os campos possíveis. Para obter detalhes sobre campos adicionais, consulte a especificação oficial do JSON schema.
Limitações
O Compass não pode exportar um esquema que possua mais de 1000 campos distintos. Se você tentar exportar um esquema com mais de 1000 campos distintos, o Compass retornará um erro.
Exemplo do esquema
O exemplo a seguir usa uma collection de documentos 3, cada um com um campo title e informações exclusivas sobre esse filme:
[ { "_id": { "$oid": "573a1390f29313caabcd6223" }, "title": "The Poor Little Rich Girl", "plot": "Gwen's family is rich, but her parents ignore her and most of the serv...", "year": 1917, }, { "_id": { "$oid": "573a1391f29313caabcd7616" }, "title": "Salomè", "plot": "Salome, the daughter of Herodias, seduces her step-father/uncle Herod, ...", "year": 1922, "genres": [ "drama", "horror" ] }, { "_id": { "$oid": "573a1392f29313caabcd9c1b" }, "title": "Payment Deferred", "year": 1932, },]Você pode importar o exemplo acima para o MongoDB Compass para experimentar as saídas do esquema. Para importar a coleção de exemplo para o MongoDB Compass:
Copie os documentos JSON na área de transferência.
Copie os documentos JSON acima.
O exemplo acima gera o seguinte esquema:
{ "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "required": [ "_id", "title", "year" ], "properties": { "_id": { "$ref": "#/$defs/ObjectId" }, "genres": { "type": "array", "items": { "type": "string" } }, "plot": { "type": "string" }, "title": { "type": "string" }, "year": { "type": "integer" } }, "$defs": { "ObjectId": { "type": "object", "properties": { "$oid": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" } }, "required": [ "$oid" ], "additionalProperties": false } }}{ "$jsonSchema": { "bsonType": "object", "required": [ "_id", "title", "year" ], "properties": { "_id": { "bsonType": "objectId" }, "genres": { "bsonType": "array", "items": { "bsonType": "string" } }, "plot": { "bsonType": "string" }, "title": { "bsonType": "string" }, "year": { "bsonType": "int" } } }}Os valores das amostras estão limitados aos primeiros 100 caracteres.
{ "type": "object", "x-bsonType": "object", "required": [ "_id", "title", "year" ], "properties": { "_id": { "$ref": "#/$defs/ObjectId", "x-bsonType": "objectId", "x-metadata": { "hasDuplicates": false, "probability": 1, "count": 3 }, "x-sampleValues": [ "573a1391f29313caabcd7616", "573a1392f29313caabcd9c1b", "573a1390f29313caabcd6223" ] }, "genres": { "type": "array", "x-bsonType": "array", "x-metadata": { "hasDuplicates": true, "probability": 0.3333333333333333, "count": 1 }, "items": { "type": "string", "x-bsonType": "string", "x-metadata": { "hasDuplicates": false, "probability": 1, "count": 2 }, "x-sampleValues": [ "drama", "horror" ] } }, "plot": { "type": "string", "x-bsonType": "string", "x-metadata": { "hasDuplicates": false, "probability": 0.6666666666666666, "count": 2 }, "x-sampleValues": [ "Salome, the daughter of Herodias, seduces her step-father/uncle Herod, ...", "Gwen's family is rich, but her parents ignore her and most of the serv..." ] }, "title": { "type": "string", "x-bsonType": "string", "x-metadata": { "hasDuplicates": false, "probability": 1, "count": 3 }, "x-sampleValues": [ "Salomè", "Payment Deferred", "The Poor Little Rich Girl" ] }, "year": { "type": "integer", "x-bsonType": "int", "x-metadata": { "hasDuplicates": false, "probability": 1, "count": 3 }, "x-sampleValues": [ 1922, 1932, 1917 ] } }, "$defs": { "ObjectId": { "type": "object", "properties": { "$oid": { "type": "string", "pattern": "^[0-9a-fA-F]{24}$" } }, "required": [ "$oid" ], "additionalProperties": false } }}
