How to set collection schema for CosmosDB MongoDB API 3.6 using Pymongo

Question

How to set collection schema for CosmosDB MongoDB API 3.6 using Pymongo

Dakarai McCoy 96

I have been searching for a way to instantiate a collection with a schema using the Pymongo API to access the Cosmos DB API.
I see the MongoDB API 3.6 does not support the 'myColl' database operator. Is there another method to do this? I need a method that I can script so that the process can be automated and run in the background.

Navtej Singh Saini 4,226 Reputation points Microsoft Employee Moderator

2021-05-03T13:15:05.977+00:00

@Dakarai McCoy We are checking this and will get back to you.
Navtej Singh Saini 4,226 Reputation points Microsoft Employee Moderator

2021-05-04T02:15:32.203+00:00

@Dakarai McCoy

Here are some of the documents - Document1, Document2 external to Microsoft which you can refer for getting more info. If you still need further help, please get back to us.

Regards
Navtej S
Dakarai McCoy 96 Reputation points

2021-05-04T16:10:12.013+00:00

Hi @Navtej Singh Saini ,

Thank you for following up. After looking at the documents I need to clarify my question. The sources you provided do illustrate how to connect to the CosmosDB and create a collection, however none of them demonstrate how to create a collection and insert a specific schema for validation. Currently anything is accepted as true even when I give data that does not match the schema.

best,

Dakarai
Dakarai McCoy 96 Reputation points

2021-05-04T22:10:23.793+00:00

I've tried following this option here however I get the error that 'collmod' is not supported. I see the query operator $jsonschema is not supported as well in the documentation. I've tried an approach with the pymongo.collection.Collection class however even if it accepts the validator parameter, anything is still acceptable in the collection.

Dakarai McCoy 96

here is an example script.

import datetime
import pymongo
validSchema = {'name': [{'bysontype': 'string'}], 'date': [{'bsontype': 'Date'}]}
gooddata = {'name': 'hello', 'date': datetime.datetime.fromisoformat('2021-02-16 11:59:00')}
baddata = {'x': 1}
client = pymongo.MongoClient(conection_uri)
temp = pymongo.collection.Collection(client['_socket_for_writes'], 'temp', validator = validSchema)
good = temp.insert_one(gooddata)
good.acknowledged
bad = temp.insert_one(baddata)
bad.acknowledged

with the output

>>> good.acknowledged

True
>>> bad.acknowledged

True
>>> temp.estimated_document_count()

2

Navtej Singh Saini 4,226 Reputation points Microsoft Employee Moderator

2021-05-06T01:55:22.767+00:00

We are checking this with our team.

1 answer

Your answer

Navtej Singh Saini 4,226 Reputation points Microsoft Employee Moderator

2021-05-03T13:15:05.977+00:00

@Dakarai McCoy We are checking this and will get back to you.
Navtej Singh Saini 4,226 Reputation points Microsoft Employee Moderator

2021-05-04T02:15:32.203+00:00

@Dakarai McCoy

Here are some of the documents - Document1, Document2 external to Microsoft which you can refer for getting more info. If you still need further help, please get back to us.

Regards
Navtej S
Dakarai McCoy 96 Reputation points

2021-05-04T16:10:12.013+00:00

Hi @Navtej Singh Saini ,

Thank you for following up. After looking at the documents I need to clarify my question. The sources you provided do illustrate how to connect to the CosmosDB and create a collection, however none of them demonstrate how to create a collection and insert a specific schema for validation. Currently anything is accepted as true even when I give data that does not match the schema.

best,

Dakarai
Dakarai McCoy 96 Reputation points

2021-05-04T22:10:23.793+00:00

I've tried following this option here however I get the error that 'collmod' is not supported. I see the query operator $jsonschema is not supported as well in the documentation. I've tried an approach with the pymongo.collection.Collection class however even if it accepts the validator parameter, anything is still acceptable in the collection.
Dakarai McCoy 96 Reputation points

2021-05-04T22:27:22.313+00:00

here is an example script.

import datetime import pymongo validSchema = {'name': [{'bysontype': 'string'}], 'date': [{'bsontype': 'Date'}]} gooddata = {'name': 'hello', 'date': datetime.datetime.fromisoformat('2021-02-16 11:59:00')} baddata = {'x': 1} client = pymongo.MongoClient(conection_uri) temp = pymongo.collection.Collection(client['_socket_for_writes'], 'temp', validator = validSchema) good = temp.insert_one(gooddata) good.acknowledged bad = temp.insert_one(baddata) bad.acknowledged

with the output

>>> good.acknowledged True >>> bad.acknowledged True >>> temp.estimated_document_count() 2
Navtej Singh Saini 4,226 Reputation points Microsoft Employee Moderator

2021-05-06T01:55:22.767+00:00

We are checking this with our team.

Answer 1

Navtej Singh Saini 4,226 Microsoft Employee Moderator

@Dakarai McCoy

We got info from our team - Cosmos DB doesn’t support schema validation, but here’s a workaround in the last answer of this thread.

Hope this helps.

Regards
Navtej S

Dakarai McCoy 96 Reputation points

2021-05-06T17:46:33.493+00:00
Hi @Navtej Singh Saini ,

Thank you for taking the time to get back to me.
I have found this page before reaching out to you and tried the solution you suggest.
However I get an error after the db.command(cmd) that says collMod is not an accepted parameter and the documentation verifies this command is not supported.

File "C:\***\lib\site-packages\pymongo\helpers.py", line 160, in _check_command_response raise OperationFailure(errmsg, code, response, max_wire_version) pymongo.errors.OperationFailure: Command collMod not supported., full error: {'ok': 0.0, 'errmsg': 'Command collMod not supported.', 'code': 115, 'codeName': 'CommandNotSupported'}

Dakarai McCoy 96

I tried deleting the collmod operator and re-running my script and this is the error I receive.

File "C:\***\lib\site-packages\pymongo\helpers.py", line 160, in _check_command_response
    raise OperationFailure(errmsg, code, response, max_wire_version)
pymongo.errors.OperationFailure: Command validator not found., full error: {'ok': 0.0, 'errmsg': 'Command validator not found.', 'code': 59, 'codeName': 'CommandNotFound'}

I also tried deleting the validator operator and this is the error.

File "C:\***\lib\site-packages\pymongo\helpers.py", line 160, in _check_command_response
    raise OperationFailure(errmsg, code, response, max_wire_version)
pymongo.errors.OperationFailure: Command $jsonSchema not found., full error: {'ok': 0.0, 'errmsg': 'Command $jsonSchema not found.', 'code': 59, 'codeName': 'CommandNotFound'}

Dakarai McCoy 96 Reputation points

2021-05-06T18:15:42.82+00:00
After deleting the $jsonschema operator received another error.

File "C:\***\lib\site-packages\pymongo\helpers.py", line 160, in _check_command_response raise OperationFailure(errmsg, code, response, max_wire_version) pymongo.errors.OperationFailure: Command bsontype not found., full error: {'ok': 0.0, 'errmsg': 'Command bsontype not found.', 'code': 59, 'codeName': 'CommandNotFound'}

It seems without the $jsonschema operator there is no way to use the json-style syntax for validator declaration, so operators like bsontype will not be recognized.
Looking at the documentation (see Other Query Operators) there seems to be another approach however, I've also pursued path with no luck as well.
Navtej Singh Saini 4,226 Reputation points Microsoft Employee Moderator

2021-05-10T21:18:58.94+00:00

@Dakarai McCoy

At this point our team has conveyed to reach out to Mongo DB forums for checking on how to do this without Schema validation.

Also you can reach out to our support team for further help. Please raise ticket and share the same with us so that we can get traction for the same.

Regards
Navtej S

Share via

How to set collection schema for CosmosDB MongoDB API 3.6 using Pymongo

1 answer

Your answer