Error
Error Code:
167
MongoDB Error 167: Option Not Supported On View
Description
This error signifies an attempt to use a database operation option that is not valid or supported when applied to a MongoDB view. Views are virtual, read-only collections and have limitations on specific operations, especially those involving data modification or certain advanced configurations.
Error Message
Option Not Supported On View
Known Causes
3 known causesAttempting Write Operations
MongoDB views are read-only and do not support write operations such as insert, update, delete, or replaceOne. Applying these operations to a view will trigger this error.
Unsupported Aggregation Stages
Certain aggregation pipeline stages, particularly those that modify data or require specific collection-level features like indexes or schema validation, are not compatible with views.
Invalid Indexing or Schema Options
Views do not have their own indexes or schema validation rules. Attempting to define or apply indexing options or schema validation directly to a view will result in this error.
Solutions
3 solutions available1. Remove Unsupported Option from Aggregation Pipeline easy
Identify and remove any aggregation stages or options that are not permitted on views.
1
Review the aggregation pipeline being executed against the view. Common unsupported options include stages like `$out`, `$merge`, and `$geoNear` when directly applied to a view. Also, check for unsupported operators within `$project` or `$addFields` stages.
2
If an unsupported stage is found, consider if it's truly necessary for the operation on the view. Often, these operations are intended for collections. If the operation is essential, you might need to perform it on a materialized collection derived from the view.
3
If the option is an unsupported operator within a supported stage (e.g., a projection), try to replace it with a supported alternative or remove it if it's not critical. For instance, if you're trying to use a geospatial operator that's not supported on views, you might need to pre-process the data or rethink the query.
2. Materialize View Data into a Collection medium
Copy the data from the view into a regular collection to perform operations not supported on views.
1
Create a new collection to store the materialized data. This collection will hold a snapshot of the view's data at the time of materialization.
db.createCollection('materialized_view_data')2
Use the `$out` or `$merge` aggregation stage on the view to populate the new collection with its data. `$out` will replace the collection if it exists, while `$merge` can be used for more incremental updates.
db.myView.aggregate([
{ $match: { /* optional filters */ } },
{ $out: 'materialized_view_data' }
])3
Now, perform your aggregation operations that were previously failing on the view against the newly created `materialized_view_data` collection. You can then schedule regular updates to this collection to keep it synchronized with the view's underlying data if needed.
db.materialized_view_data.aggregate([
// Your original aggregation pipeline here
])3. Adapt Query to View Capabilities medium
Modify your query to only use operators and stages that are supported by MongoDB views.
1
Consult the MongoDB documentation for a list of supported aggregation pipeline stages and operators for views. The documentation will detail which operations are permissible.
2
If your query uses a stage like `$lookup` or certain projection operators that are not supported on views, you'll need to find alternative ways to achieve the desired result. This might involve re-designing the view itself or performing parts of the operation on the client-side or on a materialized collection.
3
For example, if you're using `$sort` with a field that's not part of the view's definition or is derived in an unsupported way, you might need to adjust the view definition or sort on a different, view-compatible field.