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

Update ChangeStreamEvent type definition to include clusterTime

XMLWordPrintableJSON

    • Type: Icon: Spec Change Spec Change
    • Resolution: Unresolved
    • Priority: Icon: Trivial - P5 Trivial - P5
    • None
    • Component/s: Change Streams
    • Labels:
    • Needed
    • Hide

      DRIVERS-471 introduced a requirement that drivers which use a static type for ChangeStreamEvent documents include the clusterTime field. The Change Streams spec includes a sketch of a such a type, but it was not updated to include a clusterTime field. To ensure the spec is up to date, we should add such a field.

      Drivers should sync unified change stream spec tests to mongodb/specifications@d9a0e7b.

      Show
      DRIVERS-471  introduced a requirement that drivers which use a static type for ChangeStreamEvent documents include the clusterTime field. The Change Streams spec includes a sketch of a such a type, but it was not updated to include a clusterTime field. To ensure the spec is up to date, we should add such a field. Drivers should sync unified change stream spec tests to mongodb/specifications@d9a0e7b .
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-4469 Backlog
      CXX-2571 Backlog
      CSHARP-4305 Done 2.18.0
      GODRIVER-2538 Done
      JAVA-4720 Fixed 4.8.0
      NODE-4605 Fixed 4.10.0
      MOTOR-1024 Duplicate
      PYTHON-3420 Fixed 4.3
      PHPLIB-945 Fixed 1.15.0
      RUBY-3106 Fixed 2.19.0
      RUST-1461 Fixed 2.4.0
      SWIFT-1632 Fixed 1.4.0
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-4469 Backlog CXX-2571 Backlog CSHARP-4305 Done 2.18.0 GODRIVER-2538 Done JAVA-4720 Fixed 4.8.0 NODE-4605 Fixed 4.10.0 MOTOR-1024 Duplicate PYTHON-3420 Fixed 4.3 PHPLIB-945 Fixed 1.15.0 RUBY-3106 Fixed 2.19.0 RUST-1461 Fixed 2.4.0 SWIFT-1632 Fixed 1.4.0

      Summary

      DRIVERS-471 introduced a requirement that drivers which use a static type for ChangeStreamEvent documents include the clusterTime field. The Change Streams spec includes a sketch of a such a type, but it was not updated to include a clusterTime field. To ensure the spec is up to date, we should add such a field.

      Motivation

      Who is the affected end user?

      Driver authors

      How does this affect the end user?

      New drivers may accidentally omit this field, since the specifications don't mention it.

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

      Somewhat likely, though we don't have any new drivers being worked on right now.

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

      Users won't be able to retrieve the clusterTime from an event document. Consequences are not severe.

      Is this issue urgent?

      No

      Is this ticket required by a downstream team?

      No

      Is this ticket only for tests?

      No

            Assignee:
            abraham.egnor@mongodb.com Abraham Egnor
            Reporter:
            patrick.freed@mongodb.com Patrick Freed
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: