Edit Schema

On this page

Edit Schema Using the Atlas UI

In Atlas, go to your federated database instance for your project.
Navigate to Manage SQL Schemas page.
Edit schema.
Edit Schema Using mongosh
Syntax
Parameters
Output
Examples
Set Schema Example
Delete Schema Example

Edit Schema Using the Atlas UI

To edit an existing schema, use the following steps.

In Atlas, go to your federated database instance for your project.

If it's not already displayed, select the organization that contains your project from the Organizations menu in the navigation bar.
If it's not already displayed, select your project from the Projects menu in the navigation bar.
In the sidebar, click Data Federation under the Services heading.
The Data Federation page displays.

Navigate to Manage SQL Schemas page.

From the Federated Database Instances section, click the icon to the right of the schema, and then select Manage SQL Schemas from the dropdown.

Edit schema.

Next to a schema, click the .
Edit the JSON.
Click Save.

Edit Schema Using `mongosh`

The sqlSetSchema command sets or deletes the schema for a collection or view. The command uses the provided schema to create the relational schema. The command doesn't validate the schema provided with the command against the data in the collection.

Syntax

db.getSiblingDB("<dbName>").runCommand({
   sqlSetSchema: "<collection-name>|<view-name>",
   schema: {
      "version": 1,
      "jsonSchema": <jsonSchema>
   }
})

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

Parameters

Parameter	Type	Description	Necessity
`<collection-name>`	string	Name of the collection for which to set the schema. You must provide either a collection name or a view name.	Conditional
`<view-name>`	string	Name of the view for which to set the schema. You must provide either a view name or a collection name.	Conditional
`schema`	document	The format version of the schema and either: the JSON schema for the collection or view an empty document to remove the schema for the collection or view. You can provide a single document or an array of documents in the `items` field. When you retrieve the schema, `items` shows the form that you used to set the schema.	Required

Output

The command returns the following output if it succeeds.

{ "ok" : 1 }

You can verify that the command succeeded by running the sqlGetSchema command. The metadata.description field in the response contains the following value:

"set using sqlSetSchema"

Examples

Consider a collection named egData in a database named sampleDB with the following documents:

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

The examples below use the sqlSetSchema command to set and remove schema for the above collection.

Set Schema Example

The following sqlSetSchema command sets the schema for the egData collection.

db.getSiblingDB("sampleDB").runCommand({
   sqlSetSchema : "egData",
   "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" ],
               "properties" : {
                  "b" : {
                     "bsonType" : [ "object" ],
                     "properties" : {
                        "c" : {
                           "bsonType" : [ "object" ],
                           "properties" : {
                              "d" : {
                                 "bsonType" : [ "array" ],
                                 "items" : {
                                    "bsonType" : [ "string" ]
                                 }
                              }
                           }
                        }
                     }
                  }
               }
            }
         }
      }
   }
})

The previous command returns the following output.

{ "ok" : 1 }

Delete Schema Example

The following sqlSetSchema command removes the schema for the egData collection.

db.getSiblingDB("sampleDB").runCommand({
   sqlSetSchema: "egData",
   schema: {}
})

The previous command returns the following output.

{ "ok" : 1 }

Back

View

Schedule Updates