Visualizar esquema

Nesta página

Exibir esquema usando a IU do Atlas

No Atlas, acesse sua instância de banco de dados federado para seu projeto.
Navegue até a página Manage SQL Schemas .
Visualizar esquema usando mongosh
Sintaxe
Parâmetros
Saída
Exemplo

Exibir esquema usando a IU do Atlas

No Atlas, acesse sua instância de banco de dados federado para seu projeto.

Se ainda não tiver sido exibido, selecione a organização que contém seu projeto no menu Organizations na barra de navegação.
Se ainda não estiver exibido, selecione seu projeto no menu Projects na barra de navegação.
Na barra lateral, clique em Data Federation sob o título Services.
A página Data Federation é exibida.

Navegue até a Manage SQL Schemas página.

Na seção Federated Database Instances , clique em ícone à direita do esquema e selecione Manage SQL Schemas no menu suspenso.

Aqui, você pode visualizar todos os esquemas SQL do Atlas existentes.

Para visualizar um esquema específico no formato JSON, clique em .

Visualizar esquema usando `mongosh`

O comando sqlGetSchema recupera o esquema armazenado para a coleção ou visualização especificada.

Sintaxe

db.getSiblingDB("<dbName>").runCommand({
     sqlGetSchema: "<collection-name>|<view-name>"
})

Parâmetros

Parâmetro	Tipo	Descrição	necessidade
`<collection-name>`	string	Nome da coleção para a qual recuperar o esquema. O nome da coleção ou o nome da visualização são obrigatórios.	Condicional
`<view-name>`	string	Nome da visualização para a qual recuperar o esquema. O nome da visualização ou o nome da coleção é obrigatório.	Condicional

Saída

O comando retorna a seguinte saída se a coleção ou visualização não tiver um esquema.

{ "ok" : 1, "metadata" : { }, "schema" : { } }

O comando retornará uma saída semelhante à seguinte se a coleção ou visualização tiver um esquema.

{
  "ok": 1,
  "metadata": {
        "description": "<description>"
  },
  "schema": {
        "version": NumberLong(1),
        "jsonSchema": {}
  }
}

O campo metadata.description descreve como o esquema foi definido para a coleção. O valor pode ser um dos seguintes:

generated automatically by Atlas Data Federation: Indica que o esquema foi gerado automaticamente pelo Atlas Data Federation.

set using sqlGenerateSchema with setSchemas = true: Indica que o esquema foi definido pelo comando Criar esquema usando mongosh porque a opção setSchema foi definida como true.

set using sqlSetSchema: Indica que o esquema foi definido usando o comando Editar esquema usando mongosh .

O documento schema contém os seguintes campos:

Parâmetro	Tipo	Descrição
`schema.version`	inteiro	Formatar versão do esquema. O valor é sempre 1.
`schema.jsonSchema`	documento	Esquema JSON da coleção ou visualização. O esquema JSON pode conter os seguintes campos : `bsonType` `properties` `items` Para saber mais sobre esses campos, consulte Palavras-chave do JSON schema.

Exemplo

Considere uma coleção denominada egData em um banco de dados denominada sampleDB com os seguintes documentos:

{"a": {"b": {"c": [1, 2, 3]}}, "s": 1}
{"a": {"b": {"c": [4, 5, 6]}}, "s": 2}
{"a": {"b": [7, 8, 9]}, "s": 3}
{"a": {"b": {"c": []}}, "s": 4}
{"a": {"b": {"c": "hello"}}, "s": 5}
{"a": {"b": {"c": {"d": 1}}}, "s": 6}
{"a": {"b": {"c": null}}}
{"s": 7}

O comando a seguir recupera o esquema armazenado para a coleção egData:

db.getSiblingDB("sampleDB").runCommand({
     sqlGetSchema: "egData"
})

O comando anterior retorna a seguinte saída. Para obter mais informações sobre os campos na saída, consulte Saída.

{
      "ok" : 1,
      "metadata" : {
        "description" : "set using sqlGenerateSchema with setSchemas = true"
      },
      "schema" : {
        "version" : NumberLong(1),
        "jsonSchema" : {
              "bsonType" : [
                "object"
              ],
              "properties" : {
                "a" : {
                      "bsonType" : [
                        "object"
                      ],
                      "properties" : {
                        "b" : {
                              "bsonType" : [
                                "object",
                                      "array"
                                ],
                                "properties" : {
                                      "c" : {
                                        "bsonType" : [
                                              "array",
                                              "string",
                                              "object",
                                              "null"
                                        ],
                                        "properties" : {
                                              "d" : {
                                                "bsonType" : [
                                                      "int"
                                                ]
                                              }
                                        },
                                        "items" : {
                                                "bsonType" : [
                                                  "int"
                                                ]
                                        }
                                      }
                                },
                                "items" : {
                                        "bsonType" : [
                                          "int"
                                        ]
                                }
                              }
                        }
                      },
                      "s" : {
                        "bsonType" : [
                              "int",
                              "object"
                        ]
                      }
                }
              }
        }
      }

Voltar

criar

definir