rosbag2_storage_sqlite3

Storage implementation plugin for rosbag2 providing SQLite3 .db3 files as the bag storage backend.

Storage Configuration File

The --storage-config-file option for this plugin takes files in the following format:

read:
  pragmas: <list of SQLite pragma settings for read-only>
write:
  pragmas: <list of SQLite pragma settings for write modes>

By default, SQLite settings are significantly optimized for performance. This might have consequences of bag data being corrupted after an application or system-level crash. This consideration only applies to current bagfile in case bag splitting is on (through --max-bag-* parameters). If increased crash-caused corruption resistance is necessary, use resilient option for --storage-preset-profile setting.

Settings are fully exposed to the user and should be applied with understanding. Please refer to documentation of pragmas.

An example configuration file could look like this:

write:
  pragmas: ["journal_mode = MEMORY", "synchronous = OFF", "schema.cache_size = 1000", "schema.page_size = 4096"]

Changelog for package rosbag2_storage_default_plugins

0.26.1 (2024-04-17)

0.26.0 (2024-04-16)

• Support service 2/2 --- rosbag2 service play (#1481)
• Use middleware send and receive timestamps from message_info during recording (#1531)
• Update to use yaml-cpp version 0.8.0. (#1605)
• Contributors: Barry Xu, Chris Lalancette, jmachowinski, Michael Orlov

0.25.0 (2024-03-27)

• Make some changes for newer versions of uncrustify. (#1578)
• Add topic_id returned by storage to the TopicMetadata (#1538)
• Remove rcpputils::fs dependencies from rosbag2_storages (#1558)
• Change an incorrect TSA annotation. (#1552)
• Improve performance in SqliteStorage::get_bagfile_size() (#1516)
• Update rosbag2_storage_sqlite3 to C++17. (#1501)
• Use enum values for offered_qos_profiles in code and string names in serialized metadata (#1476)
• Stop inheriting from std::iterator. (#1424)
• Contributors: Chris Lalancette, Michael Orlov, Patrick Roncagliolo, Roman Sokolkov

0.24.0 (2023-07-11)

• Implement storing and loading ROS_DISTRO from metadata.yaml and mcap files (#1241)
• Store metadata in db3 file (#1294)
• Contributors: Emerson Knapp, Michael Orlov

0.23.0 (2023-04-28)

0.22.0 (2023-04-18)

• Add type_hash in MessageDefinition struct (#1296)
• Store message definitions in SQLite3 storage plugin (#1293)
• Add message definition read API (#1292)
• rosbag2_storage: add type description hash to topic metadata (#1272)
• Contributors: Michael Orlov, james-rms

0.21.0 (2023-04-12)

• rosbag2_cpp: move local message definition source out of MCAP plugin (#1265)
• Update rosbag2 to C++17. (#1238)
• Use target_link_libraries instead of ament_target_dependencies (#1202)
• Contributors: Chris Lalancette, Daisuke Nishimatsu, Michael Orlov, james-rms

0.20.0 (2023-02-14)

• CLI: Get storage-specific values from plugin (#1209)
• Contributors: Emerson Knapp

0.19.0 (2023-01-13)

• Add Michael Orlov as maintainer in rosbag2 packages (#1215)
• Remove sqlite3-specific info from main README, make it more storage agnostic and point to plugin-specific README (#1193)
• set_read_order: return success (#1177)
• Add [update_metadata(BagMetadata)]{.title-ref} API for storage plugin interface (#1149)
• Store db schema version and ROS_DISTRO name in db3 files (#1156)
• Contributors: Emerson Knapp, Michael Orlov, james-rms

0.18.0 (2022-11-15)

• ros2bag: move storage preset validation to sqlite3 plugin (#1135)
• Move sqlite3 storage implementation to rosbag2_storage_sqlite3 package (#1113)
• Contributors: Emerson Knapp, james-rms

0.17.0 (2022-07-30)

• Use a single variable for evaluating the filter regex (#1053)
• Renamed --topics-regex to --regex and -e in Player class to be consistent with Recorder (#1045)
• Added support for filtering topics via regular expressions on Playback (#1034)
• Contributors: Esteve Fernandez

0.16.0 (2022-05-11)

0.15.1 (2022-04-06)

0.15.0 (2022-04-05)

0.14.1 (2022-03-29)

• Bump version number to avoid conflict
• Contributors: Chris Lalancette

0.14.0 (2022-03-29)

• Install headers to include/\${PROJECT_NAME} (#958)
• Contributors: Shane Loretz

0.13.0 (2022-01-13)

• Emit a warning rather than crash when a message is too big for sqlite (#919)
• Contributors: William Woodall

0.12.0 (2021-12-17)

• Enable YAML encoding/decoding for RecordOptions and StorageOptions (#916)
• Contributors: Emerson Knapp

0.11.0 (2021-11-08)

• Update package maintainers (#899)
• Contributors: Michel Hidalgo

0.10.1 (2021-10-22)

0.10.0 (2021-10-19)

• added seek interface (#836)
• Contributors: sonia

0.9.0 (2021-05-17)

0.8.0 (2021-04-19)

• Remove -Werror from builds, enable it in Action CI (#722)
• Explicitly add emersonknapp as maintainer (#692)
• Reindexer core (#641) Add a new C++ Reindexer class for reconstructing metadata from bags that are missing it.
• Contributors: Emerson Knapp, jhdcs

0.7.0 (2021-03-18)

0.6.0 (2021-02-01)

• Fix build issues when rosbag2_storage is binary installed (#585)
• Mutex protection for db writing and stl collections in writer & storage (#603)
• SQLite storage optimized by default (#568)
• Contributors: Adam D