Página inicial do Docs → Iniciar e gerenciar o MongoDB → MongoDB Atlas

`sqlGetSchema`

Nesta página

Sintaxe

Parâmetros
Saída
Exemplo

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

Sintaxe

db.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 collection ou o nome de 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 collection é obrigatório.	Condicional

Saída

O comando retornará a seguinte saída se a collection ou visualização não tiver um esquema.

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

O comando retornará uma saída semelhante à seguinte se a collection 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 sqlGenerateSchema porque a opção setSchema foi definida como true.

set using sqlSetSchema: Indica que o esquema foi configurado utilizando o comando sqlSetSchema .

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 seguintescampos : `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 seguinte comando recupera o esquema armazenado para a coleção egData :

db.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"
                        ]
                      }
                }
              }
        }
      }

← sqlSetSchema

Tutoriais →