Release Notes
Rust Release Notes
4.11 - DQL & Legacy Compatibility
With 4.11 we are excited to introduce legacy compatibility for DQL, which allows developers to use the new DQL APIs while maintaining compatibility with existing code and data. This capability, called STRICT MODE, is designed to ease the transition to the new APIs and ensure that existing applications continue to function as expected.DQL Strict Mode
DQL Strict Mode provides control over how DQL statements are evaluated and how data types are inferred. When disabled, it offers more flexibility in working with documents without requiring explicit collection definitions.For more information see
DQL Strict ModeDQL_STRICT_MODE=false), Ditto is more flexible and will infer the CRDT type based on the document’s shape:- Objects are treated as CRDT maps
- Scalars and arrays are treated as Registers
- Counters and attachments are inferred from operations
- Collection definitions are no longer required
DQL
DQL Differ
DQL 4.11 introduces a newDiffer API for calculating diffs between query results.
This API can be used with a store observer to understand how its results change
over successive callbacks. The Differ API provides a way to track changes in
the data and can be used to optimize data synchronization and conflict resolution.Differ API documentation.DQL Transactions
DQL 4.11 introduces support for transactions. Transactions can be used to group multiple DQL statements together, ensuring that either all of the statements are executed successfully or none of them are. This is particularly useful in scenarios where multiple updates or inserts need to be made to the database, and you want to ensure that either all of them are applied or none of them are.Transactions API documentation.Advanced DQL Features
DQL 4.11 introduces numerous advanced querying and manipulation features:| Feature | Description | Example |
|---|---|---|
UNSET clause | Remove fields from documents | UPDATE orders UNSET items.abc WHERE _id = 'my-id' |
| CAST function | Explicitly convert between data types | SELECT * FROM products WHERE CAST(price AS INT) > 10 |
| USE IDS clause | Direct document retrieval by ID | SELECT * FROM products USE IDS '123', '456' |
| SIMILAR TO | Pattern matching expressions | SELECT * FROM products WHERE name SIMILAR TO '%phone%' |
| Runtime expressions | Use expressions in object/array construction | UPDATE products SET metadata = { 'updated_at': current_timestamp() } |
| Counters | Support for legacy compatible counter type | UPDATE products APPLY in_stock PN_INCREMENT BY 1.0 |
In 4.11, functional operations are denoted with an arrow (
->) are deprecated. Read more.Tombstone Reaper
The tombstone reaper is now enabled by default for all SDKs. This feature helps clean up deleted document markers (tombstones) to improve database performance and reduce storage requirements.The reaper:- Automatically removes tombstones after a configurable time-to-live (TTL)
- Uses read transactions for efficiency
- Includes random scheduling variations to prevent performance problems
- Tracks the number of tombstones evicted for monitoring
- Remembers previous reap times across restarts
DELETE to remove documents.4.11.0 Common Changelog
Added
- Introduced
DQL_STRICT_MODEas a system parameter to opt-out of requiring collection definitions (#16573) - Added transports_ble_adapter_mac system parameter to allow configuring bluetooth adapter MAC address (#16159)
- Small peers now log the result of OnlinePlayground authentication, including if the supplied shared token was incorrect (#16301)
- A cumulative running total of the number of tombstones ever evicted by the reaper to Small Peer Info (#16424)
- Added system parameters to fine-tune Ditto behavior when it encounters a locked persistence directory (#CORE-479)
- New DQL CAST function to explicitly cast between types (#QE-108)
- Conditional functions for unknowns (#QE-111)
- DQL DATE processing functions (#QE-112)
- New DQL clause USE IDS for direct document retrieval by id (#QE-114)
- Additional string functions (#QE-124)
- SIMILAR TO filter expression (#QE-125)
- PN_COUNTER support (APPLY clause in UPDATE statement) (#QE-127)
- UNSET clause to the UPDATE statement (#QE-128)
- MERGE as an alias for UPDATE in the ON ID CONFLICT clause of an INSERT statement (#QE-132)
- The ability to use runtime-evaluated expressions in object constructs in DQL statements (#QE-133)
- The ability to use runtime-evaluated expressions in array constructs in DQL statements (#QE-134)
- Static expressions in mutators (#QE-139)
- Additional object manipulation DQL scalar functions (#QE-159)
- EXPLAIN for query plan (#QE-105)
- More detailed messages about network problems are logged when authentication fails (#SEC-124)
Changed
- Use the modern rustls-platform-verifier TLS crate on all platforms rather than rustls-native-certs (#15956)
- The tombstone reaper scheduling to remember the previous reap times across shutdown and restart of the small peer (#16237)
- The tombstone reaper scheduling code to add random variations, which helps prevent performance problems if/when all peers run the reaper simultaneously (#16286)
- The tombstone reaper to be enabled by default for all SDKs (#16350)
- INSERT to now accept either DOCUMENTS or VALUES as the keyword introducing the list of values to insert (#QE-140)
- Date functions accept “local” as a timezone & use the executing peer’s local timezone (#QE-168)
- Unified dedicated TCP servers across different transports (Multicast, mDNS, and WiFi Aware) by utilizing a single static TCP server implementation (#TRANS-131)
Fixed
- Fixed issue where user_collection_sync_scopes could not be updated after initial set (#16299)
- Fixed: A rare crash on Android devices when shutting down Bluetooth. (#17069)
- Fixed: Bluetooth connectivity on Apple devices works when background Bluetooth permissions are missing. (#17065)
Removed
- Old multihop networking stack and system parameter
network_use_nextgen_multihop_stack(#16370) - TLS certificate compression, which led to incompatibilities (#SDKS-1046)
Performance
- The tombstone reaper uses read transactions for some of its work instead of holding open a long-running write transaction, thus reducing contention on the small peer database (#16338)
- Improved speed and efficiency of the tombstone reaping process (#16535)
4.11.0 Rust Specific Changes
Changed: New and improved DQL APIs (#16651) Added: structDiffer, which calculates diffs between query results. This can be used with a store observer to understand how its results change over successive callbacks. (#SDKS-986) Added: struct Diff to represent diffs produced by the Differ. (#SDKS-986)4.10.2 Common Changes
Removed: zlib certificate compression for small peer TLS 1.3 session negotiation, which caused incompatibilities (#1005)4.10.1 Common Changes
Changed: The tombstone reaper scheduling to remember the previous reap times across shutdown and restart of the small peer. (#16237) Changed: the tombstone reaper scheduling code to add random variations, which helps prevent performance problems if/when all peers run the reaper simultaneously. (#16286) Fixed: Unable to update user_collection_sync_scopes after initial set bug (#16299)Performance: The tombstone reaper uses read transactions for some of its work instead of holding open a long-running write transaction, thus reducing contention on the small peer database. (#16338) Changed: The tombstone reaper to be enabled by default for all SDKs. (#16350)4.10.0 New Capabilities
4.10.0 Rust Specific Changelog
BatchIdOperation::execto allow getting a specific document within the scope of a write transaction block. (#SDKS-425)- Repeated reads of a document within an ID-specific transaction scope of the query builder API now reflect changes made in the same transaction. (SDKS-245)
- (Experimental) Bus API correctly falls back to multihop connectivity if a direct connection is lost. (#15670)
- Deprecated
arm-unknown-linux-gnueabihftarget from support due to missing internal coverage and usage. (#15795)
4.9.4 Common Changes
Added: new system parameter which defines the number of threads used by the store observer runtime to dispatch the sdk callback invocations. For more information reach out to Ditto’s Support (#15814)4.9.3 Common Changes
Changed: Added more actionable information to common connection handshake issues. (#15298) Fixed: Fixed: Some Android devices could fail to export logs to the portal due to a file permissions error (#15582)No Rust Specific Changes
4.9.1 Common Changes
Fixed: iOS 18 crashes related to Bluetooth LE are now resolved. (#15351) Fixed: Disk usage stats are now reported in small peer info on android devices4.9.0 Rust Specific Changes
The 4.9.0 Rust release has come with a collection of API changes designed to align the Rust SDK with the standards of our other SDK. These changes were done to align naming conventions as well as to regorganice the module to make it more consistent with other SDKs.These API changes include a number of depreciated APIs. For insteances where APIs are depreciated you’ll find replacement APIs provided.All changes are backwards compatable.General Changes
Fixed: Resolved an issue where store_observer.is_cancelled() could return incorrect values (#14419). Added: ditto.update_transport_config() API (#5928) Added: V3ConnectionType to provide internal access to a presence peer’s connection type (#12945). Added: #[must_use] attribute on Subscription, PresenceObserver, and LiveQuery to encourage correct usage (#13256).API Renaming
Deprecated: ditto.authenticator() & DittoAuthenticator::new(#13606, 13851)- Useditto.auth()
- Use ditto.transport_config()
- Use ditto.app_id()
Module Reorganization
Added a dedicated presence module for the Presence API Deprecated: dittolive_ditto::transport::{Peer, Presence, PresenceGraph, PresenceObserver, PresenceOs, Connection, ConnectionType} (#13645).- use dittolive_ditto::presence::{Peer, Presence, PresenceGraph, PresenceObserver, PresenceOs, Connection, ConnectionType}
- use store::attachment::{FetcherVersion, DittoAttachmentFetcher, DittoAttachmentToken, DittoAttachmentFetchEvent, DittoAttachmentTokenLike}
- use store::collections::{CollectionsEvent, PendingCollectionsOperation, CollectionsEventHandler}
- use store::collection::{DocumentId, PendingCursorOperation, PendingIdSpecificOperation, DittoDocument, DittoMutDocument, MutableValue}
- Moved ditto module contents to crate-level (#13645)
- Changed: Updated sync module docs (#13702)
- Deprecated: dittolive_ditto::store::dql::SyncSubscription
- Added: dittolive_ditto::sync::SyncSubscription
- Deprecated: crate-level types module, contents moved into query_builder
- Deprecated: store::{batch,collection,collections,live_query,update} modules, contents moved into query_builder
- Deprecated: crate-level subscription module, Subscription moved into query_builder module
Depreciated unused and unintentially exposed items
Deprecated: removed ValidityListener from public API (#13857) Deprecated: DittoBuilder::new()- use Ditto::builder() instead.
4.9.0 Logging Clarity Improvements
This release comes with a number of logging clarity improvements. The goal of these changes are to make Ditto logs more consumable and actionable for end users. While there are wide ranging changes one of the principal goals of this work is to make our INFO level logs contain the right information to understand the state and health of the Ditto SDK.- More information is included when physical connections start and end (such as the type of connection and the remote peer’s key)
- Devices that try to connect to themselves now say “device has connected to itself” instead of an error about the remote site ID being the same as the local peer
- Authentication client logs have been made more human readable. In particular:
- Recoverable errors are logged together with information about the recovery actions that are being undertaken
- Several abbreviations have been replaced with human-readable descriptions
- Errors are printed using their descriptions rather than by dumping debug representations
- Abbreviated jargon has been replaced with clearer wording in various log lines
- “phy ended” has become “physical connection ended”
- “error getting char” has become “required Ditto BLE characteristic not found”
- “error getting radio state” has become “error getting Windows Bluetooth radio state”
- Peer events that represent a transport starting or stopping are now logged with the message “transport started”/“transport ended” rather than as a raw peer_event=… log
- Reduced the noisiness of “starting” log lines around Ditto initialization time
- Noise from long peer keys in logs has been reduced in some places by replacing them with their truncated form
- Noise from duplicated peer ID/peer key information in replication logs has been reduced by consolidating the information
- “starting compression and export” is now followed by a “completed export” log at the same level
- Successful SQLite WAL recovery logs were further lowered from INFO to DEBUG