Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2854

update the index management spec to use the `v` option instead of `version` for createIndex

    • Type: Icon: Spec Change Spec Change
    • Resolution: Unresolved
    • Priority: Icon: Unknown Unknown
    • None
    • Component/s: Index Management
    • None
    • Needed
    • Hide

      Summary of necessary driver changes

      •  

      Commits for syncing spec/prose tests
      (and/or refer to an existing language POC if needed)

      •  

      Context for other referenced/linked tickets

      •  
      Show
      Summary of necessary driver changes   Commits for syncing spec/prose tests (and/or refer to an existing language POC if needed)   Context for other referenced/linked tickets  

      Summary

      The index management specification lists `version` as an option for the create index helpers.  This is not a valid option for the `createIndexes` command and the correct option is `v`.

      It seems that the original intent of the specification was to provide users with a `version` option that would result in the `v` option being attached to the `createIndexes` command, but this was not specified.  The spec should clarify that if drivers provide a `version` option, it should correspond to the `v` option on the createIndexes command.

      We can also consider making `version` optional in the spec, since it is an undocumented option to the `createIndexes` command.

      We may also want to consider adding tests for the index management helpers - there are currently no index management prose or unified tests.

      Motivation

      Who is the affected end user?

      driver users.

      How does this affect the end user?

      users may encounter server errors when attempting to specify the version of their indexes, if drivers support the `version` option for createIndex

      How likely is it that this problem or use case will occur?

      unlikely - these fields aren't documented so it's unlikely that users are using them.

      If the problem does occur, what are the consequences and how severe are they?

      minor - users might encounter server errors trying to specify the index version or might be unable to create indexes with version 1 in some drivers.

      Is this issue urgent?

      no.

      Is this ticket required by a downstream team?

      no.

      Is this ticket only for tests?

      no.

      Acceptance Criteria

      1. clarify that `version` maps to the `v` field in the createIndexes command
      2. (optional) make `version` optional for drivers to implement
      3. (optional) add tests for the createIndex specification

            Assignee:
            bailey.pearson@mongodb.com Bailey Pearson
            Reporter:
            bailey.pearson@mongodb.com Bailey Pearson
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: