Ver esquema

Ver esquema usando la interfaz de usuario de Atlas

En Atlas, ve a tu instancia federada de base de datos para tu proyecto.

Si aún no aparece, se debe seleccionar la organización que contiene el proyecto en el menú Organizations de la barra de navegación.
Si aún no se muestra, seleccione su proyecto en el menú Projects de la barra de navegación.
En la barra lateral, haz clic en Data Federation en la sección Services.

Se muestra la página Data Federation.

Navegue a la Manage SQL Schemas página.

Desde la sección Federated Database Instances, haz clic en el icono a la derecha del esquema, y luego selecciona Manage SQL Schemas del menú desplegable.

Aquí puedes ver todos los esquemas de MongoSQL existentes.

Para ver un esquema específico en formato JSON, haz clic en el .

Ver esquema usando `mongosh`

El comando sqlGetSchema recupera el esquema almacenado para la colección o vista especificada.

Sintaxis

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

Parámetros

Parameter	Tipo	Descripción	Necesidad
`<collection-name>`	string	Nombre de la colección para la que se debe recuperar el esquema. Se requiere el nombre de la colección o el nombre de la vista.	Condicional
`<view-name>`	string	Nombre de la vista para la que se debe recuperar el esquema. Se requiere el nombre de la vista o el nombre de la colección.	Condicional

Salida

El comando devuelve la siguiente salida si la colección o vista no tiene un esquema.

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

El comando devuelve una salida similar a la siguiente si la colección o vista tiene un esquema.

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

El campo metadata.description es donde se describe cómo se estableció el esquema para la colección. El valor puede ser uno de los siguientes:

generated automatically by Atlas Data Federation: Indica que el esquema fue generado automáticamente por Atlas Data Federation.

set using sqlGenerateSchema with setSchemas = true: Indica que el esquema fue establecido por el comando Crear esquema usando mongosh porque la opción setSchema estaba configurada como true.

set using sqlSetSchema: Indica que el esquema se configuró usando el comando Editar esquema usando mongosh.

El documento schema contiene los siguientes campos:

Parameter	Tipo	Descripción
`schema.version`	entero	Versión del formato del esquema. El valor siempre es 1.
`schema.jsonSchema`	Documento	JSON esquema de la colección o la vista. El esquema JSON puede contener los siguientes campos : `bsonType` `properties` `items` Para obtener más información sobre estos campos, consulta JSON Schema Keywords.

Ejemplo

Considera una colección llamada egData en una base de datos llamada sampleDB con los siguientes 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}

El siguiente comando recupera el esquema almacenado para la colección egData:

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

El comando anterior devuelve la siguiente salida. Para obtener más información sobre los campos en la salida, consulta Salida.

{
      "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"
                        ]
                      }
                }
              }
        }
      }