_SDK 5.1 common capabilities — shared by all SDK platforms. Shown in the overall SDK view; platform filters show that platform’s own blocks only.
This makes normalized data models practical at the edge. Product catalogs, order histories, task assignments, and multi-tenant views can stay separated into logical collections without forcing every screen to coordinate multiple reads.Joins use data already present in the local store. They do not fetch missing data from peers, and they are not supported in sync-subscription queries. The inner collection normally requires an appropriate index; use It can improve queries such as:Field order matters. Put fields used in equality filters first, followed by fields used for range filters or sorting. Composite indexes can also include array and object values. If you are unsure which fields to index, run Ditto identifies the range predicate and recommends an index on Run the suggested statement yourself, or use
Ditto SDK 5.1 — Faster Local Queries. More Capable Query Engine.
The new Ditto Edge SDK 5.1 delivers major features and optimizations across five areas. The release includes 77 platform and 112 SDK-specific improvements.Key takeaway: Existing applications get better performance and more efficient memory usage on the same hardware simply by upgrading to SDK 5.1.1. Performance: Faster Queries, Lower Memory Use- Evictions are 53.6× faster and deletes are 43.0× faster on average. This speeds up routine local data clean-up, like clearing the orders from a point-of-sale terminal.
- A full-collection
COUNT(*)fell from 149.03 ms to 0.89 ms, which is 167× faster on average. This speeds up badge counts and dashboard totals across an app.
JOINcombines local collections in a singleSELECT, removing the need to run separate queries and merge their results in application code.ADVISElooks at a query and tells you the indexes to create to make it faster, all without running it or reading a document.
- If a device is lost or stolen, it’s easier to revoke the device’s certificate, disconnect it from the mesh, and prevent the device from sending or receiving data.
- Revocations travel peer to peer and reach devices even when they can’t see the cloud. Connections from revoked peers are terminated and refused.
- Identifying problems is easier with better tools for analyzing deployed devices, starting with support bundles that capture the device’s effective configuration.
- Corrupted replication metadata is detected and rebuilt automatically, so field issues can be solved without a site visit.
- Multicast allows Ditto to scale to large networks with many edge devices. Edge devices subscribe to a shared group for data sync, which has lower connection cost at scale.
- Opt-in beta capability in the Swift, Kotlin/KMP, Flutter, and Rust SDKs. Support will expand to additional SDKs in the future.
- Upgrading to Ditto SDK 5.1 changes the on-disk index format.
- If you need to downgrade from Ditto SDK 5.1 or later, migrate through Ditto 5.0.2+. You can also migrate through Ditto 4.14.6+.
1. Performance: Faster Queries, Lower Memory Use
Edge applications feel database performance differently from cloud applications. A slow local query doesn’t just delay a response from a server. It can block a screen transition, increase battery use, create UI churn, or consume memory on a device with limited resources.SDK 5.1 delivers a major leap in local query performance. Applications can load data faster, complete writes sooner, and react to changes more quickly—even as their local datasets and workloads grow.The improvements span nearly every kind of local data operation: selects, indexed reads, inserts, updates, deletes, evictions, aggregations, and observers. In practice, this means more responsive user experiences, less time waiting for data operations, and greater capacity on the same device hardware.These gains come from improvements throughout the local data path. Ditto performs less decoding and allocation, finds documents more directly, executes mutations more efficiently, avoids unnecessary observer work, and reduces full database scans during subscription changes. An opt-in relaxed durability mode can further reduce disk synchronization for rebuildable sync metadata without changing the durability of application documents.Android retail benchmark
The gains are broad rather than limited to one optimized query path. In testing on an Orion O6 Android device, SDK 5.1 was faster in 70 of 71 measured scenarios, with one result too close to call. The 72-scenario suite modeled an offline-first retail application with approximately 93,000 documents across seven synced collections.These results compare median runtimes from Ditto 5.0.3 and Ditto 5.1.0. Performance varies by device, data, indexes, and query mix, so test representative workloads on your target hardware.
Dramatically faster document counts
A count is a query that answers one simple question: how many documents match? Apps use counts all the time to show how many orders are open, how many items are in stock, or how many results a search found.One of the largest individual improvements is full-collection document counting. Ditto 5.1.0 adds an optimized path forCOUNT(*), reducing the benchmark’s median execution time from 149.03 ms to 0.89 ms—approximately 167× faster. Counts with a filter also improved by approximately 4.4×.These improvements accelerate queries such as
SELECT COUNT(*) FROM tasks and SELECT COUNT(*) FROM tasks WHERE status = 'open', making it substantially faster to calculate totals for dashboards, backlog checks, pagination, and application status displays.Lower memory use
Edge devices like phones, tablets, and point-of-sale terminals have a fixed amount of memory that every app shares. The less memory Ditto uses, the more room your app has for its own work, and the less likely the operating system is to slow it down.In a separate Android workload that grew a collection from 3,000 to 30,000 documents, Ditto 5.1.0 delivered approximately 2.1× as many observer results while using less memory than Ditto 5.0.3.Total PSS estimates the process’s physical RAM footprint, and peak Total PSS is the highest that footprint reached during the test. Native heap covers Ditto’s Rust core—the pool of memory the program sets aside while it runs to hold its working data. Tombstone cleanup, bulk mutations, and retained disconnected sync sessions are also bounded more carefully to reduce peak memory in high-volume deployments.
2. Query Engine: New Ditto Query Capabilities
Performance is only half of the query story in this new release. DQL (Ditto Query Language) gains the two capabilities customers asked for the most:JOIN and composite indexes. Customers can also run ADVISE to identify any indexes that would speed up query performance.Join collections locally
A join is a query that combines related data from two collections into one result. It matches records that share a value, like a task and the project it belongs to, so your application gets one combined answer instead of two separate lists.SELECT statements on edge devices can now join multiple local collections. This removes the need to coordinate separate queries and merge their results in application code.DQL
ADVISE when you need an index recommendation.Create composite indexes
An index is a lookup structure the database maintains so it can find matching documents without reading the whole collection, much like the index at the back of a book. A composite index covers two or more fields at once, so a query that filters on one field and sorts by another can be answered in a single lookup.Edge devices now support composite indexes over multiple fields. A single composite index can accelerate queries that repeatedly filter or sort by the same combination of fields—for example, tenant and time, status and assignee, or location and category.The following index is designed for queries that filter tasks bystatus and sort them by createdAt:DQL
DQL
ADVISE against the query to get an index recommendation.Find the right indexes with ADVISE
ADVISE turns index optimization into a guided workflow. Prefix a query with ADVISE, and Ditto plans how it would execute that query without actually running it or reading any documents. It inspects the query’s filters, sorts, projections, and joins. Then, Ditto spots the places where the engine would have to scan the whole collection. For each one, the response explains why an index would help and provides a ready-to-run CREATE INDEX statement.For example, advise a query that filters tasks by estimated effort:DQL
estimateHours:ADVISE AND PROVISION to create the recommended indexes automatically. ADVISE can also recommend composite and covering indexes for more complex filters, sorting, projections, and joins. It is currently available on edge devices.Return changed documents with RETURNING
RETURNING lets an INSERT, UPDATE, DELETE, EVICT, or TOMBSTONE statement return data from the documents it changed. A data mutation and its confirmation can become one operation. Applications can receive the affected data immediately instead of issuing a second query.For example, update matching documents and return their IDs and new values in one operation:DQL
RETURNING is especially valuable with deletes and evictions because it can return document contents before they are removed. It also supports projections, expressions, aliases, and aggregates such as RETURNING COUNT(*) AS removed.Ditto 5.1 also adds INSERT ... SELECT for creating documents directly from query results.Control long-running requests
A single expensive query on an edge device can hold resources that are needed by the rest of an application. Two new system parameters can catch runaway queries before they cause performance issues.Set either parameter to
0 to disable it. Request history can also filter by request type or explicit profiling requests.3. Security: Expanded Certificate Revocation
Security policies at the edge need to keep working even when devices are not continuously connected to the cloud. Security teams lose sleep over what happens when an edge device is lost or stolen.SDK 5.1 will help security teams sleep better. Certificate revocation information now propagates securely from Ditto Server to edge devices and from peer to peer throughout the mesh. As peers connect, they share the latest revocation information.Revocation enforcement is enabled by default. Peers reject new connections that present a revoked certificate and terminate matching active connections when a revocation arrives. This isolates revoked clients and prevents them from reconnecting through another peer in the mesh.Every hop verifies the revocation’s signature against its trusted certificate authority keys, the source that issues each device’s identity credentials. A compromised peer cannot forge revocations.4. Troubleshooting: Identify Problems and Recover Automatically
A device misbehaving in the field is a hard problem to tackle in edge computing. It’s expensive and inefficient to fly an engineer out to attach a debugger to a tablet that is 3,000 miles away in the back of a restaurant.SDK 5.1 adds new options to remotely collect edge device data and identify the root cause of an issue. Support bundles now includeconfig_snapshot.json, which records the effective DittoConfig, transport configuration, system parameters, and SDK version at capture time. This provides essential device config information at the start of every investigation or support case.Other new remote diagnostics include:- A configurable Unix
debug_socketlets you remotely run DQL diagnostics against an edge device.- You can inspect a live device directly rather than reproducing the problem in a lab.
- Nine new network counters under
ditto.network.dsoq.*surface Ditto Sync over QUIC (DSOQ) protocol failures in your existing production metrics, without debug logs. - SQLite metrics distinguish the application data store from replication metadata databases on supported Unix platforms, showing which one is driving disk activity.
5. Transport at Scale: Multicast Beta
Today, Ditto’s default peer-to-peer model establishes a session between every pair of edge devices. The total connection count grows with the square of the mesh size, O(N²). Six devices need 15 connections, and sixty devices need 1,770. Connection maintenance eventually becomes the dominant cost in environments with a large number of edge devices like a mall, a ship, a concert venue, or an aircraft.Multicast is now available in SDK 5.1 as an opt-in beta. Devices join a shared multicast group rather than pairing off, which drops the connection count from O(N²) to O(N). There is one group membership per device.A sender would typically transmit an update once per device in the mesh, which is O(N). Multicast enables the sender to publish a single broadcast to the group, which is approximately O(1). There is one send, no matter how many devices are listening.The transport is built on reliable multicast (NORM, RFC 5740) combined with Ditto’s data reconciliation, so peers recover missed data and catch up after joining or reconnecting.When multicast is configured and available, it becomes the preferred replication path. Traffic is encrypted for the group, and existing peer-to-peer transports remain active as automatic fallback for peers the group cannot reach. Documents and attachments both replicate over multicast, including repair of missing attachment data.Upgrading to 5.1
The upgrade to Ditto Edge SDK 5.1 is seamless. Simply bump your dependency to 5.1.0 and Ditto handles the rest. An index migration will run automatically the first time your app starts. Data sync is backward-compatible, and 5.1 peers will work with 5.0 and v4 peers while you roll out gradually.Tested rollback compatibility
Ditto Edge SDK 5.1 has undergone extensive backward-compatibility and rollback testing to ensure production deployments can safely return to supported earlier SDK versions when needed.The 5.1 SDK changes the on-disk index format. If you need to downgrade from Ditto 5.1 or later, migrate through Ditto 5.0.2+. You can also migrate through Ditto 4.14.6+. These versions recognize the updated index format and automatically revert it to the format understood by earlier versions.During the downgrade, composite indexes are replaced with single-field indexes, one for each of the composite index’s keys.See index migration and downgrade behavior for details. As with any production upgrade, validate the procedure with representative application data before deployment.Rust-Specific Changes
Theauth module is now public, exposing the authenticator, authentication event handler, client feedback, and development-provider APIs.The legacy identity module is deprecated in favor of auth, and the query-builder-era SortDirection enum is deprecated in favor of DQL ORDER BY clauses.Rust Specific Changelog
Added:- The
authmodule is now public, exposingDittoAuthenticator,DittoAuthenticationEventHandler,AuthenticationClientFeedback, andget_development_provider(). (#SDKS-3022) MulticastBetaConfigandPeerToPeer::multicast_betafor configuring the beta reliable UDP multicast transport. The transport is disabled by default, with availability limited to supported platforms during the beta. On Android and iOS, changes requested while sync is active take effect after sync is stopped and successfully started again, when Ditto validates platform prerequisites. (#SDKS-4471)ConnectionType::Multicastenum option representing beta reliable UDP multicast connections. Transport availability is limited to supported platforms during the beta. (#SDKS-4471)
- Added suggested actions to the warning logged when the key in attestation does not match the key reported by transport. (#21402)
- Log lines for update payloads now report
chunk_sizeinstead ofdatato clarify the meaning of the field. (#22102)
- The
SortDirectionenum in theStoremodule, a remnant of the legacy v4 Query Builder API. Use DQLORDER BYclauses instead. (#SDKS-2772) - The
identitymodule. Use theauthmodule instead. (#SDKS-3022)
Added: a new system parameter transports_websocket_watchdog_interval_secs to adjust WebSocket client watchdog. (#21885) Fixed: Corrected a formalisation bug causing DQL statement filters to never match, that was affecting observers using projections. (#QE-1056) Fixed: Corrected a hang when accessing
system:data_sync_info. (#QE-1095) Added: a new timeout for WebSocket connect that is adjustable by system parameter transport_websocket_connect_timeout. (#21866) Changed: Mesh chooser now enforces per-transport connection limits instead of a shared WiFi radio budget, preventing one transport (e.g. TCP) from starving others (e.g. AWDL, WiFi Aware). When a transport is at capacity, the behavior for new inbound connections is configurable: reject, drop oldest, drop newest, or accept. Peers at capacity reject inbound connections with a new
ConnectError::AtCapacity variant and back off exponentially to avoid retry storms. (#NETW-1586) Added: Automatic downgrading of the SP store from V3 to V2 on start-up. (#QE-595) Added: Automatic downgrading of the SQLite3 schema from V3 to V2 allowing for downgrading from version 5.1. (#QE-595) Added: disable_replication_gc_on_evict system parameter (default false). When set to true, calls to evict() no longer trigger immediate per-peer metadata cleanup; the periodic background replication GC continues to reclaim metadata for disconnected peers once they exceed the TTL (~7 days by default). Intended as an opt-in escape hatch for deployments where eviction-time filesystem work contributes to write-path latency. (#QE-686) Added: Optional background task to reclaim unused space in the Small Peer store and record space usage metrics. (#QE-779) Changed: The way query profile timing and count data is recorded to reduce overheads. (#QE-811) Fixed: A bug in internal subscription bookkeeping caused long-connected Document Sync sessions to become disabled due to spurious capacity errors. (#SPO-1011) Added: The option to set the DITTO_SQLITE3_MAX_CONNECTIONS parameter lower than 32, down until 16 (#SPO-668) Changed: The default value of SQLITE3_MAX_CONNECTIONS parameter to 32, down from 60 (#SPO-668). Changed: The replication_session_request_timeout_secs and blob_session_request_timeout_secs system parameters are no longer functional; the timeouts have been removed. They are accepted for backwards compatibility but have no effect. (#SPO-869) Removed: Spurious
dsoq.cbor CBOR warning log during auth client initialization. (#21646) Added: Garbage collection for document sync sessions now imposes limits on the number of disconnected sessions that will be retained, even if the TTL is not exceeded. (#DS-1065) Fixed: the query engines erroneously build index spans not including the higher end for the BETWEEN operator. Fixed to include it. (#QE-896)_SDK 5.0 introduced DQL for all data operations and major core, performance, and upgrade changes. Shared by all SDK platforms; platform filters show that platform’s own blocks.Each SDK provides access to the config object with language-appropriate naming conventions. See the SDK-specific migration guides for exact syntax.This maintains the same data modeling semantics you’re currently using. Once your application is stable on v5, follow the strict mode migration guide and work with the Ditto CX team to migrate to schema-free data modeling and take advantage of the improved developer experience.Example:This is equivalent to Object Transformation Syntax:Key behaviors:These collections provide unprecedented visibility into Ditto’s internal state, making it easier to monitor, debug, and optimize your applications.
DQL for All Data Operations
DQL for All Data Operations
Ditto 5.0 completes the transition to DQL (Ditto Query Language) as the single API for all data operations. The legacy query builder has been removed.What Changed
- Legacy query builder removed: All
store.collection()methods and fluent query APIs are no longer available - Full feature parity: Every legacy operation has a DQL equivalent
- Single query language: DQL handles reads, writes, subscriptions, and observers
- Works everywhere: Same syntax across mobile, server, and web
- SQL-familiar: Standard SQL patterns for immediate productivity
Why One Query Language
A unified query language means one implementation to maintain, faster feature delivery, and consistent behavior across all platforms. New capabilities and optimizations benefit every SDK simultaneously.Core Improvements
Simplified Initialization & Configuration
Ditto 5.0 introduces a completely redesigned initialization flow built around the newDittoConfig pattern. This replaces the previous Identity-based approach with a clearer, more predictable setup that aligns with modern best practices.What’s New
The new configuration system provides:- Unified configuration object: All initialization parameters are set through
DittoConfigfactory methods - Fallible initialization: Explicit error handling during setup catches configuration issues early
- Asynchronous patterns: Native async/await support where appropriate for each platform
- Simplified authentication: Clearer authorization client that’s easier to understand and implement
What This Solves
The previous initialization flow required multiple unintuitive settings due to legacy compatibility concerns. For example, developers had to setdisableCloudSync = true to connect to a Big Peer, which was confusing and non-obvious.The new pattern consolidates all configuration into a single, coherent flow that makes the relationship between settings explicit and easier to reason about.Accessing Configuration at Runtime
After initializing Ditto, you can access the configuration object to retrieve settings like the database ID. This replaces methods likegetAppID() from v4:Availability
TheDittoConfig pattern was introduced as an option in v4.12 and becomes the only initialization method in v5.0.Migration guides for each SDK are available in the v5 documentation. If you’re currently on v4.11 or later, the migration path is straightforward.
Schema-Free Data Modeling
Ditto 5.0 transforms the developer experience by making DQL strict mode disabled by default. This eliminates the need to define collection schemas or CRDT types upfront, allowing you to insert nested objects and data structures without pre-defining types.What’s New
With strict mode disabled by default, Ditto changes how objects are stored and synchronized:Objects default to MAP type instead of REGISTER typeThis fundamental change means:- Field-level sync: Ditto syncs individual field changes instead of replacing entire objects
- Automatic type inference: No need to pre-define collection schemas or CRDT types
- Nested structures: Insert complex JSON-like documents without type definitions
- Concurrent updates merge: When peers update different fields simultaneously, both changes are preserved
What This Solves
This change provides a more simplified data management structure with two key benefits:- Add-wins behavior on objects: When peers create or modify objects, additions are preserved rather than overwritten
- Field-level delta sync on all nodes: Every field in your document syncs independently, reducing bandwidth and enabling fine-grained conflict resolution throughout the entire document structure
New Customers
Schema-free data modeling is enabled by default in Ditto 5.0. No action is needed—simply start building with automatic type inference and field-level sync.Migrating Customers
Migration Considerations
Strict mode is a local configuration setting on each device that controls how DQL interprets and writes data structures.How it works across peers:- Data syncs successfully between peers regardless of different strict mode settings
- Each peer interprets data based on its own strict mode setting when reading/writing
- With
DQL_STRICT_MODE=false: Objects are inferred as MAPs (field-level merging) - With
DQL_STRICT_MODE=true: Objects without explicit type definitions are treated as REGISTERs (whole object replacement)
- Collections/documents created, modified, or read while strict mode is disabled will use inferred types (objects → MAPs by default)
- Collections/documents created, modified, or read while strict mode is enabled use default REGISTER type and require explicit definitions for other types
- If mixing settings, explicitly define MAP types in collection definitions on peers with strict mode enabled
Learn more about strict mode, cross-peer synchronization, and troubleshooting in the DQL Strict Mode documentation.
New DQL Query Features
Ditto 5.0 introduces several new DQL syntax features that expand query capabilities and make complex queries easier to write.CASE Statements
Add conditional logic to queries with CASE expressions:BETWEEN Expressions
TheBETWEEN operator provides a shorthand for defining an inclusive numeric range for an expression result.Syntax:(a >= 1 AND a <= 10).Array & Object Search Syntax
Test elements within arrays or objects usingANY, EVERY, or ANY AND EVERY operators:Syntax:- IN - Searches the array/object directly
- WITHIN - Searches recursively through nested structures
- ANY - Returns true if at least one element matches
- EVERY - Returns true if all elements match (empty arrays/objects pass)
- ANY AND EVERY - Like EVERY, but empty arrays/objects fail
Array & Object Transformation Syntax
Create new arrays and objects by transforming existing data structures:Array Transformation Syntax:- If
sourceevaluates toMISSING, the result isMISSING - For arrays: if
sourceis not an array/object, the result isNULL - For objects: duplicate field names will overwrite previous values
- Elements/fields where
valueExprevaluates toMISSINGare excluded from the result
Extended String Literals
Support for escape sequences in strings:Hexadecimal Numeric Constants
Additional numeric literal formats:Performance & Platform
DQL Query Performance Improvements
Your applications will feel noticeably faster and more responsive. Data queries complete faster, delivering a snappier user experience whether users are searching, filtering, or loading content. These performance gains happen automatically—no code changes required.Query Planner Enhancements
The DQL query planner has been enhanced to recognize more optimization opportunities:- Automatic ID scan conversion: Equality filters on
_idfields automatically convert to ID scans, bypassing index lookups when exact document IDs are known - Deferred document fetching: Query planner can defer fetching full documents until after sorting and applying offset/limit when index access supports it
- Improved covering index support: More scenarios where the query planner can satisfy queries entirely from index data without retrieving documents
- Index-only queries: Additional cases where queries can be answered using only index scans
Streaming Query Execution
The query engine now uses streaming interfaces internally:- Reduced memory overhead: Results are streamed rather than fully materialized where possible
- DISTINCT operator streaming: DISTINCT queries now stream results, reducing memory usage for large result sets
- Improved operator inlining: Query operators can be inlined into producers for better performance
Shared Statement Cache
Ditto 5.0 introduces a shared statement cache that stores and reuses compiled query plans:- Plan reuse: Compiled query plans are cached and reused for identical or similar statements, eliminating redundant parsing and planning overhead
- Automatic validation: Cached plans are automatically verified and invalidated when collection schemas or system directives change
- Dynamic sizing: The cache automatically resizes based on workload patterns
- Improved large statement performance: Particularly benefits complex queries and larger statements by avoiding expensive re-compilation
These improvements are automatic - no code changes required. Your existing DQL queries will benefit from the enhanced query planner.
Data Sync Performance Improvements
Building on the performance improvements delivered in v4.13 & v4.14, Ditto 5.0 further optimizes data synchronization through tiered blob storage and protocol enhancements, making sync operations faster and more efficient.What’s New
Version 5.0 introduces:- Tiered blob storage: Smaller sync updates avoid unnecessary disk I/O by using optimized storage tiers
- Improved session handling: Better avoidance of session resets on reconnection when in-flight updates were lost
- Optimized fsync policy: Document sync avoids forcing files to disk by default, decreasing I/O and improving latency
Impact
Applications upgrading to v5.0 will experience:- Faster sync operations: Reduced disk I/O overhead leads to quicker data synchronization
- Lower latency: Optimized file handling decreases sync latency across the board
- Better reconnection handling: Fewer redundant updates after temporary disconnections
- Improved efficiency: Reduced disk operations lower memory and CPU pressure during sync
Local System Observability
Gain unprecedented visibility into how Ditto operates on your devices. Query real-time metrics, inspect runtime configuration, and monitor system health directly using DQL—giving you deeper insights than ever before to debug issues, optimize performance, and understand your application’s behavior.New Virtual Collections
system:metrics- Query performance metrics and diagnostics in real-time
- Access counters, timers, and other operational metrics via DQL
- Monitor system health and performance without external tools
system:system_info- Query
peer_key,database_id, and configuration settings - Inspect runtime configuration and system parameters
- Useful for debugging and operational awareness
system:shared_statements- Inspect the query plan cache
- View cached statements and their execution plans
- Supports DELETE operations to clear specific cached statements
- Helps optimize query performance and troubleshoot query planning
Local-Only Collections: System collections are local to each peer and are not replicated across the mesh. To query these collections on remote peers, use Remote Query from the Ditto Portal.
Usage Example
Additional Improvements
Reliability & Error Handling
- Enhanced diagnostics: Improved logging when peers receive data that cannot be deserialized
- Recovery mechanisms: Additional recovery paths for document deserialization errors
- Smart log levels: Connection failures start at warning level, escalate to error only after repeated failures
- Panic messages: Filtered to remove internal Rust machinery frames for improved readability
Networking Improvements
- Graceful shutdown: Network connections close cleanly when Ditto is stopped
- Faster disconnection detection: When a peer crashes, Ditto stops attempting to connect within 15 seconds (previously up to 75 minutes)
- mDNS improvements: More reliable mDNS discovery, configurable service names, better address filtering
- BLE improvements: Fixed connection issues on Android 9 and earlier devices
- WebSocket BYOD support: Bring Your Own Discovery now supports WebSocket connections
- Connection cleanup: Fixed deadlock where devices could fail to establish new P2P connections until restarted
DQL Engine Improvements
Beyond the query performance improvements detailed above, v5 includes:- Better error messages: Improved parser error messages for invalid DQL syntax
- Transaction safety: Fixed deadlock scenarios in concurrent transactions
- Index correctness: Fixed issues where index scans could yield incorrect results on document deletion
Logging & Diagnostics
- Better disk utilization: On-disk logs resume writing to incomplete files, making better use of available space
- Compressed size limits: Log file limits now apply to compressed size, significantly increasing retention
- Explicit flushing: Logs explicitly flushed before aborting due to panic
- Virtual collections: New
system:metricsandsystem:system_infocollections for DQL access to metrics and system information
Platform Support
- Linux aarch64: Kotlin SDK now supports ARM64 Linux (Raspberry Pi, AWS Graviton, etc.)
- Swift 6: Full Swift 6 support with Sendable conformance
- 16KB alignment: React Native Android meets Google Play’s November 2025 requirement
Upgrading to v5
Terminology Updates
Ditto 5.0 updates terminology across the platform to align with industry standards and reduce confusion.Database ID (formerly App ID)
appID→databaseIDin all configuration methodsgetAppId()→getConfig().databaseIdin SDK APIs- Portal and documentation updated to use “Database ID” terminology
Ditto Server (formerly Ditto Cloud)
isConnectedToDittoCloud→isConnectedToDittoServerin presence APIs- Documentation updated to use “Ditto Server” terminology
Breaking Changes
Ditto 5.0 is a major version release that removes deprecated APIs and legacy features. For migration guidance, see Migration Guidance.Removed APIs
Legacy Query Builder (All SDKs)
All legacy query builder APIs have been removed:store.collection()→ Use DQLINSERT,UPDATE,EVICTstatementscollection.find()→ Use DQLSELECTqueriescollection.findById()→ Use DQL with_idfilter- Live queries → Use DQL observers with
store.registerObserver() - Write transactions → Use
store.transaction()with DQL
Legacy Initialization (All SDKs)
Identityclasses and all subclasses removedDitto(identity:, persistenceDirectory:)constructors removed- Use
DittoConfigfactory methods andDitto.open()instead
Sync Methods Moved
ditto.startSync()→ditto.sync.start()ditto.stopSync()→ditto.sync.stop()ditto.isSyncActive→ditto.sync.isActive
Other Removals
disableSyncWithV3()- no longer needed, v3 sync removed entirelyAttachmentToken- use dictionary variant- Transport diagnostics APIs - obsolete, removed
- Various deprecated presence properties (
queryOverlapGroup,meshRole, etc.) - Emoji log level headings - setting had no effect, removed
Behavioral Changes
Several default behaviors have changed in v5:- DQL strict mode: Now defaults to
false- no schema definitions required, automatic CRDT type inference - String literals in DQL: Double quotes now delimit strings (not identifiers) for JSON compatibility
- Subscription queries: Reject
LIMITandORDER BYunlessDQL_RESTRICT_SUBSCRIPTION=false - Observer ordering: Observers require explicit
ORDER BYclause for stable ordering - WebSocket sync: Disabled by default in new
TransportConfiginstances - must explicitly enable - Document IDs:
nullis no longer allowed as a document ID
These behavioral changes may affect existing code. Review your DQL queries and subscription logic when migrating to v5.
SDK Size Reduction
The removal of legacy APIs has reduced SDK footprint by approximately 25%, resulting in:- Smaller application binary sizes
- Reduced memory usage
- Faster SDK initialization
- Simpler maintenance and debugging
Rust Migration Guide
Upgrading to Ditto 5.0 requires updating your initialization code and migrating from legacy query APIs to DQL. The migration process involves:- Updating from
DittoIdentitytoDittoConfig-based initialization - Replacing legacy query builder operations with DQL statements
- Migrating collection observers to DQL observers
- Updating authentication patterns
Rust-Specific Changes
The Rust SDK has additional platform-specific changes in v5.0 beyond the common breaking changes.API Changes
Query Arguments:- Added
query_arguments_cbor_data()andquery_arguments_json_str()methods toSyncSubscription - Use these methods to deserialize query arguments into specific types
- Renamed
Peer::peer_key_stringtoPeer::peer_key - Renamed
Connection::peer_key_string1andConnection::peer_key_string2toConnection::peer1andConnection::peer2 - Renamed
ConnectionRequest::peer_key_string()toConnectionRequest::peer_key() - Renamed
is_connected_to_ditto_cloudtois_connected_to_ditto_server
- Added
Sync::start()as replacement forDitto::start_sync() - Removed
Ditto::start_sync()- Useditto.sync().start()instead - Added
Sync::stop()as replacement forDitto::stop_sync() - Removed
Ditto::stop_sync()- Useditto.sync().stop()instead - Added
Sync::is_active()as replacement forDitto::is_sync_active() - Removed
Ditto::is_sync_active()- Useditto.sync().is_active()instead
- Removed
Store::register_observer()- UseStore::register_observer_v2()instead - Removed
Store::register_observer_with_signal_next()- UseStore::register_observer_v2()instead
- Removed
Store::execute()- UseStore::execute_v2()instead - Removed
Store::collection_names()- Use DQL querySELECT * FROM system:collectionsinstead - Removed
Store::disk_usage()- UseDitto::disk_usage()instead
- Removed
Presence::observe()- UsePresence::register_observer()instead - Removed
Presence::exec()- UsePresence::graph()instead
- Removed
Ditto::current_transport_config()- UseDitto::transport_config()instead - Removed
Ditto::root_dir()- UseDitto::absolute_persistence_directory()instead - Removed
Ditto::data_dir()- UseDitto::absolute_persistence_directory()instead - Removed
Ditto::authenticator()- UseDitto::auth()instead - Removed
app_id()andapplication_id()- Useconfig().database_idinstead
- Removed
with_sdk_version()- Useversion()instead - Removed
disable_sync_with_v3()- Now disabled by default - Removed unused identity type “Manual”
DiskObserverContextrenamed toDiskUsageObserverDiskUsage::exec()renamed toDiskUsage::item()DiskUsageChildrenamed toDiskUsageItem
Type & Naming Changes
Database ID:AppIdis now calledDatabaseId- This is the newtype which wraps the UUID string identifying a Ditto database
- Removed
SiteIdtype alias - Use
graph().local_peer.peer_key_stringinstead
Module Reorganization
Removed from Public API:authmodule from root - Import fromidentity::authinsteaddittomodule from public exports - Use types frompreludeinsteadobservermodule from public exports - Use specific observer types insteadsubscriptionmodule from public exports - Usesync::SyncSubscriptioninsteadtypesmodule from public exports - Use DQL instead
Observertrait - Use specific observer types returned by register_observer methodsPresenceObserverstruct from legacy API - UsePresenceObserverfromPresence::register_observer()
Configuration
DittoConfig:- Updated to include missing
system_parametersfield
- Types now define
#[serde(default)]for deserializing partial objects
Logging
Custom Log Callbacks:- Added
DittoLogger.set_custom_log_callback()for handling Ditto log events with custom callback - Removed
DittoLogger::get_emoji_log_level_headings_enabled()andset_emoji_log_level_headings_enabled()
Authentication
Development Provider:- Added development provider method for online playground authentication
Migration Example
The initialization flow has changed fromIdentity-based to DittoConfig-based patterns. Here’s how to migrate:Accessing Configuration at Runtime
After initialization, you can access your Ditto configuration to retrieve settings like the database ID:Migration Path
All legacy query operations have direct DQL equivalents:Update Operations:Complete migration examples for all legacy query patterns are available in the Legacy to DQL Migration Guide.
How It Works
The key difference is whether you need to explicitly define MAP types for objects:Migration
Update your code to use the new terminology:Rust Specific Changes
Fixed:- Updated DittoConfig to include missing
system_parametersfield in the Rust SDK (#19436)
- Presence graph Peers have renamed the
is_connected_to_ditto_cloudproperty tois_connected_to_ditto_serverto clarify that it reflects a connection to any Big Peer rather than specifically those in the Ditto cloud service (#20302) AppIdis now calledDatabaseId. This is the newtype which wraps the UUID string identifying a Ditto database (#20390)- Renamed
Peer::peer_key_stringtoPeer::peer_key(#SDKS-1185) - Renamed
Connection::peer_key_string1andConnection::peer_key_string2toConnection::peer1andConnection::peer2(#SDKS-1185) - Renamed
ConnectionRequest::peer_key_string()toConnectionRequest::peer_key()(#SDKS-1185) DiskUsageChildrenamed toDiskUsageItem,DiskUsageObserverCtxrenamed toDiskUsageObserver, andDiskUsage::exec()renamed toDiskUsage::item(), for consistency with names in other Ditto SDKs and documentation (#SDKS-596)
query_arguments_cbor_dataandquery_arguments_json_strmethods toSyncSubscriptioninstances. If you want to deserialize query arguments into a specific type, then use these and deserialize things as required (#17003)TransportConfigtypes now define#[serde(default)]to make deserializing transport configs with partial objects work as expected (#20162)- Ditto log events can be handled with a custom callback using DittoLogger.set_custom_log_callback() (#20239)
- Development provider method for online playground authentication (#20254)
Sync::stop()as a replacement forDitto::stop_sync()(#SDKS-2355)Sync::start()as a replacement forDitto::start_sync()(#SDKS-2472)Sync::is_active()as a replacement forDitto::is_sync_active()(#SDKS-2473)AwdlConfigandWifiAwareConfigstructs toPeerToPeertransport configuration (#SDKS-2952)
- Collection struct. Use DQL statements instead (#17786)
- PendingCursorOperation struct. Use DQL statements instead (#17786)
- PendingIdSpecificOperation struct. Use DQL statements instead (#17786)
- PendingCollectionsOperation struct. Use DQL statements instead (#17786)
- LiveQuery struct. Use Store::register_observer_v2() instead (#17786)
- LiveQueryEvent enum. Use QueryResult from Store::register_observer_v2() instead (#17786)
- LiveQueryMove enum. Use Store::register_observer_v2() instead (#17786)
- SingleDocumentLiveQueryEvent enum. Use Store::register_observer_v2() instead (#17786)
- Subscription type alias. Use SyncSubscription from Sync::register_subscription_v2() instead (#17786)
- DittoDocument trait. Use Document type from Store::execute_v2() instead (#17786)
- DittoMutDocument trait. Use DQL statements with Store::write() instead (#17786)
- DittoCounter struct. Use DQL COUNTER type instead (#17786)
- DittoMutableCounter struct. Use DQL COUNTER type instead (#17786)
- DittoRegister struct. Use DQL REGISTER type instead (#17786)
- DittoMutableRegister struct. Use DQL REGISTER type instead (#17786)
- EventHandler trait. Use callbacks with Store::register_observer_v2() instead (#17786)
- CollectionsEvent enum. Use DQL queries instead (#17786)
- CollectionsEventHandler trait. Use DQL queries instead (#17786)
- SingleDocumentEventHandler trait. Use Store::register_observer_v2() instead (#17786)
- COrderByParam struct. Use ORDER BY in DQL queries instead (#17786)
- QuerySortDirection enum. Use ASC/DESC in DQL queries instead (#17786)
- MutableValue trait. Use DQL statements instead (#17786)
- Store::collection() method. Use DQL statements instead (#17786)
- Store::collections() method. Use DQL queries instead (#17786)
- Store::with_batched_write() method. Use Store::write() instead (#17786)
- Store::queries_hash() method. Use DQL queries instead (#17786)
- Store::queries_hash_mnemonic() method. Use DQL queries instead (#17786)
- Store::register_observer() method. Use Store::register_observer_v2() instead (#17786)
- Store::register_observer_with_signal_next() method. Use Store::register_observer_v2() instead (#17786)
- Store::execute() method. Use Store::execute_v2() instead (#17786)
- Store::collection_names() method. Use DQL query “SELECT * FROM system:collections” instead (#17786)
- Store::disk_usage() method. Use Ditto::disk_usage() instead (#17786)
- Store::start_all_live_query_webhooks() method. Live query webhooks feature has been deprecated (#17786)
- Store::start_live_query_webhook_by_id() method. Live query webhooks feature has been deprecated (#17786)
- Store::register_live_query_webhook() method. Live query webhooks feature has been deprecated (#17786)
- Store::live_query_webhook_generate_new_api_secret() method. Live query webhooks feature has been deprecated (#17786)
- Store::timeseries() method. The experimental timeseries feature has been deprecated (#17786)
- TimeSeries struct. The experimental timeseries feature has been deprecated (#17786)
- WriteStrategy enum. Use DQL INSERT statements instead (#17786)
- Presence::observe() method. Use Presence::register_observer() instead (#17786)
- Presence::exec() method. Use Presence::graph() instead (#17786)
- PresenceObserver struct from legacy API. Use PresenceObserver from Presence::register_observer() instead (#17786)
- Ditto::current_transport_config() method. Use Ditto::transport_config() instead (#17786)
- Ditto::root_dir() method. Use Ditto::absolute_persistence_directory() instead (#17786)
- Ditto::data_dir() method. Use Ditto::absolute_persistence_directory() instead (#17786)
- Ditto::authenticator() method. Use Ditto::auth() instead (#17786)
- SiteId type alias. Use graph().local_peer.peer_key_string instead (#17786)
- TransportDiagnostics struct. This unimplemented feature has been removed (#17786)
- Observer trait. Use specific observer types returned by register_observer methods instead (#17786)
- auth module from root. Import from identity::auth instead (#17786)
- ditto module from public exports. Use types from prelude instead (#17786)
- observer module from public exports. Use specific observer types instead (#17786)
- subscription module from public exports. Use sync::SyncSubscription instead (#17786)
- types module from public exports. Use DQL instead (#17786)
- Unused identity type “Manual” has been removed (#20257)
- Ditto struct no longer has app_id() or application_id() functions. Use config().database_id instead (#20259)
- with_sdk_version() method and replaced with version() method (#20298)
- disable_sync_with_v3() API. This is now disabled by default (#20325)
Ditto::stop_sync(). Useditto.sync().stop()instead (#SDKS-2355)Ditto::start_sync(). Useditto.sync().start()instead (#SDKS-2472)Ditto::is_sync_active(). Useditto.sync().is_active()instead (#SDKS-2473)DittoLogger::get_emoji_log_level_headings_enabled()andDittoLogger::set_emoji_log_level_headings_enabled()methods (#SDKS-2604)DittoAuthenticator::login_with_token_and_feedback()method. UseDittoAuthenticator::login()instead (#SDKS-2589)DittoBuilderstruct. UseDitto::open()orDitto::open_sync()withDittoConfigfor initialization instead (#SDKS-2589)Ditto::builder()method. UseDitto::open()orDitto::open_sync()withDittoConfiginstead (#SDKS-2589)Ditto::get_logging_enabled()method. UseDittoLogger::get_logging_enabled()instead (#SDKS-2589)Ditto::get_minimum_log_level()method. UseDittoLogger::get_minimum_log_level()instead (#SDKS-2589)Ditto::persistence_directory()method. UseDittoConfigto obtain persistence directory configuration (#SDKS-2589)Ditto::set_logging_enabled()method. UseDittoLogger::set_logging_enabled()instead (#SDKS-2589)Ditto::set_minimum_log_level()method. UseDittoLogger::set_minimum_log_level()instead (#SDKS-2589)ErrorKind::as_str()method. Use theDisplayimplementation forErrorKindinstead (#SDKS-2589)Identitytrait and all concrete implementations (OnlineWithAuthentication,OnlinePlayground,OfflinePlayground,SharedKey). UseDittoConfigfor all initialization scenarios instead (#SDKS-2589)Observertrait. Usedrop(observer)to stop an observer (#SDKS-2589)