Release Notes
3.1.1 — July 2023
Version 3.1.1 for Swift delivers the following features and enhancements:
For an overview of the latest features offered in Couchbase Lite 3.1, see New in 3.1 |
Enhancements
Issues and Resolutions
-
CBL-4581 - MutableDocument contains(key: String) returns wrong result
-
CBL-4443 - CBLCollection could be leaked if document listener token is not removed
-
CBL-4438 - Collection.addDocumentChangeListener() can fatal crash
-
CBL-4437 - Change Database removeChangeListener() deprecation message
-
CBL-4623 - Use FTS match() in the WHERE clause of LEFT OUTER JOINS Not Returning Correct Result
-
CBL-4535 - Error when saving documents with LiteCore error 17: must be called during a transaction
3.1.0 — March 2023
Version 3.1.0 for Swift delivers the following features and enhancements:
Scopes and Collections
Couchbase Mobile’s cloud-to-edge support for scopes and collections allows application developers to organize and logically isolate data.
Independent lifecycle management and fine-grained security control simplifies the deployment of multi-tenant and high-application density cloud-to-edge applications at scale.
Scopes and Collections are a first class concept, synced between Couchbase Lite and Sync Gateway, between Sync Gateways (Inter Sync Gateway Replication), between Couchbase Lite peers, as well as available offline-first on Couchbase Lite devices.
Enhancements
-
CBL-4131 - SQL : Enhance COLLATE syntax to support locales for UNICODE Collator++
-
CBL-4098 - Provide option to Save Cookie with Domain being a parent domain of the request
-
CBL-3651 - Only send port in HTTP Host header if non-standard
-
CBL-2829 - New API for specifying network interface used by the replicator
-
CBL-2691 - New Swift QuerySortOrder to avoid API ambiguous error from Xcode 13+
Issues and Resolutions
-
CBL-3866 - Fix WebSocket error 1006, "connection closed abnormally" crash
-
CBL-3626 - setDocumentExpiration hangs inside a batch transaction
-
CBL-3384 - Worker::childChangedStatus may lose child after enqueued
-
CBL-3075 - Database could be corrupted after being copied in linux platform
-
CBL-3046 - Connection Timeout is set to 15000000 Milliseconds on Non Windows Platforms
-
CBL-3013 - Continuous replicator does not push docs which are being observed
-
CBL-2948 - revpos is missing in the changed attachment body when using delta sync (Port)
-
CBL-2867 - Cannot update the same field again after reopening the database (Port Fix)
-
CBL-2826 - Losing _attachment when pushing an updated doc to SG
-
CBL-2779 - N1QL : Meta().<property> column name returned as $<num>
-
CBL-2721 - Database is closed while replicator change listener is still executing
-
CBL-2693 - LiveQuerier could be leaked as liveQuerierStopped() delegate might not be called
-
CBL-2676 - 409 retry can result in invalid remote ancestor ID
-
CBL-2637 - Replication unable to continue after termination between rev and ack
-
CBL-2614 - Fix Memory leak when rapidly restarting replicator
-
CBL-2610 - Cleanup bundle folder when creating a database fails
-
CBL-2586 - LiveQuerier is running after having been stopped, causing a crash
-
CBL-2532 - Assertion failure when stopping replicator while replicator is connecting
-
CBL-2477 - Tear down DBAccess on stopped instead of on release
-
CBL-2460 - Different C4QueryObservers share the same C4QueryEnumerator
-
CBL-2459 - A second, new Query observer should be notified immediately.
-
CBL-2458 - Changing a Query's parameters should re-notify observers
-
CBL-2374 - Slowness from reindexing the database when opening database
Deprecations
-
CBL-4316 - Replicator's getPendingDocumentIds() and isDocumentPending(String id) are deprecated
-
CBL-4315 - ReplicatorConfiguration's filters and conflict resolver properties are deprecated
-
CBL-4314 - ReplicatorConfiguration APIs with Database object are deprecated
-
CBL-4313 - MessageEndpointListenerConfiguration APIs using Database object are deprecated
-
CBL-4312 - URLEndpointListenerConfiguration APIs using Database object are deprecated
-
CBL-4311 - QueryBuilder : isNullOrMissing() and notNullOrMissing() are deprecated
-
CBL-4309 - QueryBuilder : DataSource's database() is deprecated
-
CBL-4306 - DatabaseChange and DatabaseChangeListener are deprecated
3.0.2 — August 2022
Version 3.0.2 of Couchbase Lite for Swift delivers a number of fixes and enhancements.
3.0.1 — March 2022
Version 3.0.1 of Couchbase Lite for Swift delivers a number of fixes and enhancements.
Enhancements
Couchbase Lite for Swift provides an enhancement to the Replicator Configuration API, which now allows you to specify the network interface to use for connecting to the remote target — see: Configure Network Interface.
3.0.0 — February 2022
- Quick Links
-
New Features | Enhancements | API Changes | Known Issues | Fixed Issues | Deprecated in this Release | Removed in this Release | Support Notices |
On upgrading from a 2.x release, all Couchbase Lite databases will be automatically re-indexed on initial database open. |
New Features
SQL++/N1QL Query Strings
Couchbase Lite’s SQL++ for Mobile query API vastly simplifies the integration of Couchbase Lite within hybrid/cross platform apps.
N1QL for Mobile is an implementation of the emerging SQL-for-JSON query language specification (SQL++). It provides native, hybrid and cross-platform mobile app developers with a consistent, convenient and flexible interface to query JSON documents within the embedded database using a SQL-based syntax. This means developers can reuse queries across platforms, reducing development, testing and maintenance costs.
Read More . . . SQL++ for Mobile
Enhancements
Auto-purge on Channel Access Revocation
An auto-purge feature is introduced for loss of access to channels and the documents in them. This is important for enforcement of data governance and data retention policies.
Channels are the fundamental mechanism for enforcement of access control using Sync Gateway. They guarantee that only users with access to a specific channel can access documents in that channel.
When a user loses access to a channel (and so to its documents) Couchbase Lite clients will auto purge all local documents on devices that belong to the revoked channel (during Pull or PushAndPull replication), unless the user has access to the document via some other channel.
Read More . . . Auto-purge on Channel Access Revocation
Document API Support for JSON Data
The Couchbase Lite API now offers out-of-the box support for document data in JSON format. This will make it easier for developers' applications to store, transform and manipulate JSON data in the database.
The API offers JSON support for Documents, MutableDocuments, Arrays, MutableArrays, Dictionaries, MutableDictionaries and Query Results.
Other Enhancements
-
CBL-2633 — Update support level and message note of Database’saveBlob() and getBlob() API
-
CBL-2549 — Expose BlobType, BlobContentType, BlobDigest keys in Swift
-
CBL-2483 — Change database.createQuery(String query) signature to throw CouchbaseLiteException
-
CBL-2452 — Update Swift Database.createQuery(query: String) API
-
CBL-2437 — Add note about notification when disabling autoPurge
-
CBL-2383 — Increase kOtherDBCloseTimeoutSecs to allow enough time for all db open connections to be closed
-
CBL-2379 — Improve logging message when copying database using a wrong encryption key
-
CBL-2376 — Provide note about copying encrypted database in API doc
-
CBL-2358 — Add function for creating FLMutableDict/Array from JSON
-
CBL-1941 — maxRetries should now count attempts instead of retries
-
CBL-1910 — Implement the Revised Retry Logic and Heartbeat Config API
-
CBL-1714 — Refactor POSIX error domain codes to be platform independent
-
CBL-1666 — Allow apps to trigger SQLite index optimization directly
-
CBL-1650 — CBL doesn’t purge channel removals when removal revision already exists in CBL
-
CBL-1567 — Ensure c4log_enableFatalExceptionBacktrace is called
-
CBL-1453 — Failure testDeleteWithActiveLiveQueriesAndReplicators
-
CBL-1395 — ERROR: AddressSanitizer: stack-use-after-return on address
-
CBL-1232 — Support function to change the kC4ReplicatorOptionProgressLevel
-
CBL-911 — Couchbase Lite Java replication hangs when using DEBUG console + file logging on Windows
API Changes
Removed APIs
ResetCheckpoint
`replicator.start(reset:)`
replicator.resetCheckpoint()
replicator.start()
replicator.start(true)
Database.setLogLevel
Database.log.console
Database.setLogLevel(.verbose, domain: .all)
Database.log.console.domain = .all
Database.log.console.level = .verbose
Deprecated API
Match
FullTextFunction.match(indexName:)
let index = FullTextExpression.index ("indexName")
let q = QueryBuilder.select([SelectResult.
expression(Meta.id)])
.from(DataSource.database(testdb)) +
.where(index.match("'queryString'"))
let q = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(FullTextFunction.match(indexName: "indexName", query: "'queryString'"))
isNullOrMissing and notNullOrMissing
isNotValued()
isValued()
|let q1 = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(Expression.property("missingProp").isNullOrMissing())
let q2 = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(Expression.property("notMissingProp").notNullOrMissing())
let q1 = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(Expression.property("missingProp").isNotValued())
let q2 = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(Expression.property("notMissingProp").isValued())
Updated API
Configuration
The following classes are changed to Swift struct.
-
DatabaseConfiguration
-
ReplicatorConfiguration
-
URLEndpointListenerConfiguration
// use of let won't stop from editing instance later)
let config = DatabaseConfiguration()
config.encryptionKey = EncryptionKey.password(password!)
let config = ReplicatorConfiguration(database: db, target: target)
config.continuous = true
var config = DatabaseConfiguration()
config.encryptionKey = EncryptionKey.password(password!)
var config = ReplicatorConfiguration(database: db, target: target)
config.continuous = true
ATAN2
Breaking change |
ATAN2(x, y)
now becomes ATAN2(y, x)
let p = Expression.property("number")
let q = QueryBuilder.select([SelectResult.expression(Function.atan2(x: Expression.int(90), y: p))])
.from(DataSource.database(testdb))
let q = QueryBuilder.select([SelectResult.expression(Function.atan2(y: Expression.int(90), x: p))])
.from(DataSource.database(testdb))
Fixed Issues
-
CBL-2583 — Replication unable to continue after termination between rev and ack
-
CBL-2579 — 409 retry can result in invalid remote ancestor ID
-
CBL-2478 — Tear down DBAccess on stopped instead of on release
-
CBL-2304 — CBL core fleece exception: incompatible duplicate scope
-
CBL-2192 — kHasAttachments flag may be lost in Conflict Resolver
-
CBL-2168 — Warning : Linking against a dylib which is not safe for use in application extensions
-
CBL-1920 — Crash when a query is destructed and unregistered from the database
-
CBL-1743 — [p2pseeing Network ERROR :Unexpected or unclean socket disconnect! , when server is disconnected ]
-
CBL-1722 — POSIX 32 (Broken Pipe) appears to crash application
-
CBL-1660 — Not all debug logging is compiled out of release builds
-
CBL-1438 — WSA codes not properly handled by bio_return_value
-
CBL-1362 — Harmless unused property in ReplicatorConfiguration
-
CBL-1225 — Testfest : unshare the docs does not replicate to CBL
-
CBL-862 — CBL 2.7 and later doesn’t catch Illegal top-level key like "_id"
-
CBL-708 — Conflicting revision bodies are not removed after resolution
-
CBL-462 — Continuous push attempts to replicate purged documents
-
CBL-220 — Windows cannot handle dates before 1970 with C API
Deprecated in this Release
Items (features and-or functionality) are marked as deprecated when a more current, and usually enhanced, alternative is available.
Whilst the deprecated item will remain usable, it is no longer supported, and will be removed in a future release — see also: Removed in this Release You should plan to move to an alternative, supported, solution as soon as practical.
-
The [Database.compact()] method is deprecated (as of 2.8), instead use Database.performMaintenance().