Release Notes
3.0.15 — November 2023
Version 3.0.15 for Android delivers the following features and enhancements:
3.0.12 — June 2023
Version 3.0.12 for Android delivers the following features and enhancements:
Enhancements
-
CBL-4531 - Update PublicKey+Apple to use non deprecated keychain APIs
-
CBL-4167 - SQL++ : COLLATE does not have a way to specify locale for UNICODE
-
CBL-4024 - Change BuiltInWebSocket to do preemptive auth instead of challenge auth by default (Port)
-
CBL-3903 - Assertion failure when stopping replicator while replicator is connecting
-
CBL-4134 - Fix empty identity error when building LiteCoreCppTests&C4Tests using XCode 14
-
CBL-3993 - FTS index table not have to be qualified by data source alias in query
Issues and Resolutions
-
CBL-3671 - Fix slowdowns and storage overhead caused by document revision history not being pruned
-
CBL-4529 - Error when saving documents with LiteCore error 17: must be called during a transaction
-
CBL-4450 - Stop replicator could cause 'database is locked' error when saving a document
-
CBL-4448 - Replicator may get stuck when there is an error of "Invalid delta"
-
CBL-4388 - The URL Scheme the HTTP Message is incorrect when using proxy
-
CBL-4325 - Opening the upgraded database from 2.8 to 3.0.2 is slow
-
CBL-4570 - URLEndpointListener.getURLs returns an empty list on Android v>=11
3.0.5 — November 2022
Version 3.0.5 for Android delivers the following features and enhancements:
3.0.2 — August 2022
Version 3.0.2 of Couchbase Lite for Android delivers a number of fixes and enhancements.
Issues and Resolutions
Fixed Issues
-
CBL-3301 — FullTextIndex.setLanguage() should accept null parameter
-
CBL-3074 — Database could be corrupted after being copied in linux platform
-
CBL-3000 — c4DbChanges in AbstractDatabase.postDatabaseChanged may contain nulls
-
CBL-2998 — Replicator stopped with WebSocket 1008 / SocketTimeoutException when disable Wi-Fi
-
CBL-2996 — Several bad tests in ReplicatorLocal2LocalTest suite
-
CBL-2995 — Cookies set in Headers are replaced with Session Authenticator’s cookies
-
CBL-2884 — evpos is missing in the changed attachment body when using delta sync
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
Kotlin Support in Android
Couchbase Lite for Android delivers an idiomatic Kotlin API out-of-the-box. This enables seamless integration with Android apps developed in Kotlin without the need for custom extensions.
Kotlin developers can now build apps using common Kotlin Patterns and use familiar Kotlin features such as:
-
Nullability annotations
-
Named parameters
-
Kotlin Flows
Java support and functionality continues for Android. You can choose whether to use the Kotlin extensions API or continue using the Java api.
Read More . . . Couchbase Lite for Kotlin
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-2634 — Update support level and message note of Database’saveBlob() and getBlob() API
-
CBL-2481 — Change database.createQuery(String query) signature to throw CouchbaseLiteException
-
CBL-2456 — Update Database’s createQuery() to return an error or throw CouchbaseLiteException (Beta 3)
-
CBL-2439 — 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-2358 — Add function for creating FLMutableDict/Array from JSON
-
CBL-2319 — Confusing copyDatabase API when used with encryptionKey
-
CBL-1941 — maxRetries should now count attempts instead of retries
-
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-1359 — Remove deprecated Replicator.resetCheckpoint() and de-deprecate Replicator.start()
-
CBL-1358 — Remove deprecated LogDomain.ALL (replaced by LogDomain.ALL_DOMAINS)
-
CBL-1356 — Remove deprecated constructor BasicAuthenticator(String, String)
-
CBL-1308 — Allow to remove query listener or any listeners directly from token
-
CBL-1232 — Support function to change the kC4ReplicatorOptionProgressLevel
API Changes
This content introduces the changes made to the Couchbase Lite for Android API for release 3.0.0.
Removed
ResetCheckpoint
The method Replicator.resetCheckpoint() has been removed.
Instead, use Replicator.resetCheckpoint(boolean reset).
replicator.resetCheckpoint()
replicator.start()
replicator.start(true)
Database.setLogLevel
The method Database.setLogLevel()
has been removed.
Instead:
-
Set the logging levels for loggers, individually
-
Set the domains to be logged by the console logger, explicitly.
Database.setLogLevel(LogDomain.ALL, LogLevel.VERBOSE)
Database.log.getConsole().setDomains(LogDomain.ALL_DOMAINS)
Database.log.getConsole().setLevel(LogLevel.VERBOSE)
Database.log.getFile().setDomains(LogLevel.DEBUG)
Database.compact
The Database.compact() method has been removed.
It is replaced by the new Database.performMaintenance(MaintenanceType) method, and the maintenance operations represented in the enum MaintenanceType
try testdb.compact()
testdb.performMaintenance(MaintenanceType.COMPACT)
Deprecated in the API
MATCH
The class, FullTextExpression
has been deprecated.
Use FullTextFunction instead.
FullTextExpression index = FullTextExpression.index("indexName")
Query q = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(index.match(queryString))
Query q = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(FullTextFunction.match("indexName", queryString))
isNullOrMissing/notNullOrMissing
The functions Expression.isNullOrMissing and Expression.notNullOrMissing have been deprecated.
Use isNotValued()
and-or isValued()
instead.
Query q =
QueryBuilder
.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(
Expression.property("missingProp").isNullOrMissing())
Query q =
QueryBuilder
.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(Expression.property("notMissingProp").notNullOrMissing())
Query q = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(Expression.property("missingProp").isNotValued())
Query q = QueryBuilder.select([SelectResult.expression(Meta.id)])
.from(DataSource.database(testdb))
.where(Expression.property("notMissingProp").isValued())
AbstractReplicatorConfiguration
The enum AbstractReplicatorConfiguration.ReplicatorType
and the methods
ReplicatorConfiguration.setReplicatorType
and
ReplicatorConfiguration.getReplicatorType
have all been deprecated.
Instead, use the methods ReplicatorConfiguration.setType
and ReplicatorConfiguration.getType
, and the top level enum ReplicatorType
.
ReplicatorConfiguration config =
new ReplicatorConfiguration().setReplicatorType(ReplicatorConfiguration.ReplicatorType.PUSH_AND_PULL);
ReplicatorConfiguration config =
new ReplicatorConfiguration().setType(ReplicatorType.PUSH_AND_PULL);
Moved in the API
The enum AbstractReplicator.ActivityLevel and the classes AbstractReplicator.Progress and AbstractReplicator.Status have all been moved to be top level definitions.
They are replaced by these definitions:
ListenerToken token =
replicator.addChangeListener(
testSerialExecutor,
change -> {
final AbstractReplicator.Status status = change.getStatus()
if (status.getActivityLevel() == AbstractReplicator.ActivityLevel.BUSY)
{ AbstractReplicator.Progress progress =
status.getProgress(); Logger.log("Progress: " + progress.completed + "/" progress.total);
}
});
ListenerToken token =
replicator.addChangeListener(
testSerialExecutor,
change -> {
final ReplicatorStatus status = change.getStatus()
if (status.getActivityLevel() == ReplicatorActivityLevel.BUSY)
{ ReplicatorProgress progress =
status.getProgress(); Logger.log("Progress: " + progress.completed + "/" progress.total);
}
});
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-2436 — Lithium beta 2: Confirm LiteCore request for close, before connection is opened.
-
CBL-2304 — CBL core fleece exception: incompatible duplicate scope
-
CBL-1748 — X509TrustManager.checkServerTrusted with X509TrustManagerExtensions.checkServerTrusted
-
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-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.
-
CBL-1727 — Improved naming for AbstractReplicatorConfiguration.ReplicatorType
-
The [Database.compact()] method is deprecated (as of 2.8), instead use Database.performMaintenance().