docs/mcp/mongo-ops/modules/mongo_ops.models.json

{
  "module": "mongo_ops.models",
  "content": {
    "path": "mongo_ops.models",
    "docstring": "Base document models for MongoDB.",
    "objects": {
      "datetime": {
        "name": "datetime",
        "kind": "alias",
        "path": "mongo_ops.models.datetime",
        "signature": "<bound method Alias.signature of Alias('datetime', 'datetime.datetime')>",
        "docstring": null
      },
      "Any": {
        "name": "Any",
        "kind": "alias",
        "path": "mongo_ops.models.Any",
        "signature": "<bound method Alias.signature of Alias('Any', 'typing.Any')>",
        "docstring": null
      },
      "Optional": {
        "name": "Optional",
        "kind": "alias",
        "path": "mongo_ops.models.Optional",
        "signature": "<bound method Alias.signature of Alias('Optional', 'typing.Optional')>",
        "docstring": null
      },
      "ObjectId": {
        "name": "ObjectId",
        "kind": "alias",
        "path": "mongo_ops.models.ObjectId",
        "signature": "<bound method Alias.signature of Alias('ObjectId', 'bson.ObjectId')>",
        "docstring": null
      },
      "BaseModel": {
        "name": "BaseModel",
        "kind": "alias",
        "path": "mongo_ops.models.BaseModel",
        "signature": "<bound method Alias.signature of Alias('BaseModel', 'pydantic.BaseModel')>",
        "docstring": null
      },
      "Field": {
        "name": "Field",
        "kind": "alias",
        "path": "mongo_ops.models.Field",
        "signature": "<bound method Alias.signature of Alias('Field', 'pydantic.Field')>",
        "docstring": null
      },
      "GetCoreSchemaHandler": {
        "name": "GetCoreSchemaHandler",
        "kind": "alias",
        "path": "mongo_ops.models.GetCoreSchemaHandler",
        "signature": "<bound method Alias.signature of Alias('GetCoreSchemaHandler', 'pydantic.GetCoreSchemaHandler')>",
        "docstring": null
      },
      "core_schema": {
        "name": "core_schema",
        "kind": "alias",
        "path": "mongo_ops.models.core_schema",
        "signature": "<bound method Alias.signature of Alias('core_schema', 'pydantic_core.core_schema')>",
        "docstring": null
      },
      "PyObjectId": {
        "name": "PyObjectId",
        "kind": "class",
        "path": "mongo_ops.models.PyObjectId",
        "signature": "<bound method Class.signature of Class('PyObjectId', 10, 65)>",
        "docstring": "Custom ObjectId type compatible with Pydantic v2.\n\nThis class extends the standard BSON ObjectId to provide validation and \nserialization support within Pydantic models.",
        "members": {
          "validate": {
            "name": "validate",
            "kind": "function",
            "path": "mongo_ops.models.PyObjectId.validate",
            "signature": "<bound method Function.signature of Function('validate', 35, 53)>",
            "docstring": "Validate the input value and convert it to an ObjectId if possible.\n\nArgs:\n    v: The value to validate (can be str or ObjectId).\n\nReturns:\n    ObjectId: The validated ObjectId instance.\n\nRaises:\n    ValueError: If the value is not a valid ObjectId."
          }
        }
      },
      "BaseDocument": {
        "name": "BaseDocument",
        "kind": "class",
        "path": "mongo_ops.models.BaseDocument",
        "signature": "<bound method Class.signature of Class('BaseDocument', 68, 95)>",
        "docstring": "Base document class with common MongoDB fields.\n\nInherit from this class to create Pydantic models that represent \nMongoDB documents. It includes automatic handling of the `_id` field \nand timestamps.\n\nAttributes:\n    id: The MongoDB document ID (aliased to `_id`).\n    created_at: Timestamp when the document was created.\n    updated_at: Timestamp when the document was last updated.",
        "members": {
          "id": {
            "name": "id",
            "kind": "attribute",
            "path": "mongo_ops.models.BaseDocument.id",
            "signature": null,
            "docstring": null
          },
          "created_at": {
            "name": "created_at",
            "kind": "attribute",
            "path": "mongo_ops.models.BaseDocument.created_at",
            "signature": null,
            "docstring": null
          },
          "updated_at": {
            "name": "updated_at",
            "kind": "attribute",
            "path": "mongo_ops.models.BaseDocument.updated_at",
            "signature": null,
            "docstring": null
          },
          "Config": {
            "name": "Config",
            "kind": "class",
            "path": "mongo_ops.models.BaseDocument.Config",
            "signature": "<bound method Class.signature of Class('Config', 86, 95)>",
            "docstring": null,
            "members": {
              "populate_by_name": {
                "name": "populate_by_name",
                "kind": "attribute",
                "path": "mongo_ops.models.BaseDocument.Config.populate_by_name",
                "signature": null,
                "docstring": null
              },
              "arbitrary_types_allowed": {
                "name": "arbitrary_types_allowed",
                "kind": "attribute",
                "path": "mongo_ops.models.BaseDocument.Config.arbitrary_types_allowed",
                "signature": null,
                "docstring": null
              },
              "json_encoders": {
                "name": "json_encoders",
                "kind": "attribute",
                "path": "mongo_ops.models.BaseDocument.Config.json_encoders",
                "signature": null,
                "docstring": null
              },
              "json_schema_extra": {
                "name": "json_schema_extra",
                "kind": "attribute",
                "path": "mongo_ops.models.BaseDocument.Config.json_schema_extra",
                "signature": null,
                "docstring": null
              }
            }
          }
        }
      }
    }
  }
}