MOD: Change upgrade policy to Upgrade by default

Author: threecgreen

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.16.0 - TBD
+
+### Breaking changes
+- Changed default `upgrade_policy` to `Upgrade` so by default the primary record types
+  can always be used
+
 ## 0.15.0 - 2024-01-16
 
 ### Breaking changes

example/live/simple.cpp

@@ -23,7 +23,6 @@ int main() {
                     .SetLogReceiver(log_receiver.get())
                     .SetKeyFromEnv()
                     .SetDataset(databento::dataset::kGlbxMdp3)
-                    .SetUpgradePolicy(databento::VersionUpgradePolicy::Upgrade)
                     .BuildThreaded();
 
   // Set up signal handler for Ctrl+C

include/databento/dbn_decoder.hpp

@@ -14,8 +14,7 @@
 
 namespace databento {
 // DBN decoder. Set upgrade_policy to control how DBN version 1 data should be
-// handled. Currently it defaults to returning this data as-is, but this default
-// will change in a future version.
+// handled. Defaults to upgrading DBNv1 data to version 2 (the current version).
 class DbnDecoder {
  public:
   explicit DbnDecoder(detail::SharedChannel channel);

include/databento/live.hpp

@@ -26,8 +26,7 @@ class LiveBuilder {
   // Whether to append the gateway send timestamp after each DBN message.
   LiveBuilder& SetSendTsOut(bool send_ts_out);
   // Set the version upgrade policy for when receiving DBN data from a prior
-  // version. In this version defaults to as-is, but in a future version
-  // will default to upgrading it to DBNv2.
+  // version. Defaults to upgrading to DBNv2 (if not already).
   LiveBuilder& SetUpgradePolicy(VersionUpgradePolicy upgrade_policy);
   // Sets the receiver of the logs to be used by the client.
   LiveBuilder& SetLogReceiver(ILogReceiver* log_receiver);
@@ -45,6 +44,6 @@ class LiveBuilder {
   std::string key_;
   std::string dataset_;
   bool send_ts_out_{false};
-  VersionUpgradePolicy upgrade_policy_{VersionUpgradePolicy::AsIs};
+  VersionUpgradePolicy upgrade_policy_{VersionUpgradePolicy::Upgrade};
 };
 }  // namespace databento

src/dbn_decoder.cpp

@@ -57,7 +57,7 @@ DbnDecoder::DbnDecoder(detail::FileStream file_stream)
           new detail::FileStream{std::move(file_stream)}}) {}
 
 DbnDecoder::DbnDecoder(std::unique_ptr<IReadable> input)
-    : DbnDecoder(std::move(input), VersionUpgradePolicy::AsIs) {}
+    : DbnDecoder(std::move(input), VersionUpgradePolicy::Upgrade) {}
 
 DbnDecoder::DbnDecoder(std::unique_ptr<IReadable> input,
                        VersionUpgradePolicy upgrade_policy)