-
Type: Spec Change
-
Resolution: Unresolved
-
Priority: Minor - P4
-
None
-
Component/s: CRUD
-
None
-
Needed
Summary
What is the problem or use case, what are we trying to achieve?
DRIVERS-2968 relaxed the index numeric type requirement for maps that store indexes as keys. The CRUD spec should make this change as well for BulkWriteResult, InsertManyResult, and anywhere else an index is represented as an Int64.
Motivation
Who is the affected end user?
Users who expect idiomatic index types.
How does this affect the end user?
Type conversion may be required.
How likely is it that this problem or use case will occur?
Somewhat likely: this may be an issue for users who are inspecting results from collection.bulkWrite and/or insertMany.
If the problem does occur, what are the consequences and how severe are they?
Minor: users may need to convert between number types.
Is this issue urgent?
This is not urgent. Additionally, drivers may not be able to change these numeric types without breaking their APIs. This spec change should be made as guidance for future new drivers, and as a consideration for future major versions for existing drivers.
Is this ticket required by a downstream team?
No.
Is this ticket only for tests?
No.
Acceptance Criteria
Update the CRUD spec to use a general Index type, similar to the change made to the bulk write spec in DRIVERS-2968.