Release Notes
- reference
Release notes for the Couchbase PHP Client.
These pages cover the 4.x versions of the Couchbase PHP SDK.
For download instructions, see the installation page.
PHP SDK 4.1 Releases
We always recommend using the latest version of the SDK — it contains all of the latest security patches and support for new and upcoming features. All patch releases for each dot minor release should be API compatible, and safe to upgrade; any changes to expected behavior are noted in the release notes that follow.
Version 4.1.5 (21 August 2023)
Source |
|
Checksum |
Enhancements
-
PCBC-939: Added support for query with Read from Replica (#118).
-
PCBC-945: Expiry options for increment/decrement are now exposed, as they were before 4.0.0 (#120).
-
PCBC-937: Fixed
removeMulti
, which now correctly removes documents (#123). -
PCBC-938: Override exception constructor in PHP Extension, which allows to initialize context in derived classes (#117).
-
PCBC-940: Added support for subdoc Read from Replica (#121).
-
PCBC-884: Added support for Native KV range scans (#122, #127).
Underlying C++ SDK Core
-
CXXCBC-333: Fixed parsing 'resolv.conf' on Linux (#416).
-
The library might not ignore trailing characters when reading nameserver address from the file.
-
-
CXXCBC-335: now logging connection options for visibility (#417).
-
CXXCBC-343: Continue bootsrap if DNS-SRV resolution fails (#422).
-
CXXCBC-242: SDK Support for Native KV Range Scans (#419, #423, #424, #426, #428, #431, #432, #433, #434).
-
CXXCBC-339: Disable older TLS protocols (#418).
Version 4.1.4 (26 May 2023)
API documentation: https://docs.couchbase.com/sdk-api/couchbase-php-client-4.1.4
Source |
|
Checksum |
Underlying C++ SDK Core
-
CXXCBC-327: Bundled Mozilla certificates with the library (#405, #408). Source: https://curl.se/docs/caextract.html. Use the
disable_mozilla_ca_certificates
connection string option to disable the bundled certificates. -
CXXCBC-324: Port and network name now checked on session restart, improving performance during rebalance (#401).
-
CXXCBC-323:
bootstrap_timeout
andresolve_timeout
can now be used in the connection string (#400). -
Introduced
dump_configuration
option for debugging. (#398) It logs cluster configuration at trace level.
Version 4.1.3 (13 April 2023)
API documentation: https://docs.couchbase.com/sdk-api/couchbase-php-client-4.1.3
Source |
|
Checksum |
Underlying C++ SDK Core
-
CXXCBC-31: Allow the use of schemaless connection strings (e.g.
"cb1.example.com,cb2.example.com"
) (#394). -
CXXCBC-318: Always try TCP if UDP fails in DNS-SRV resolver (#390).
-
CXXCBC-320: Negative expiry in atr was leaving docs in a stuck state — this has been fixed, with expiry atr now becoming an
int32_t
(#393). -
CXXCBC-310: Improved shutdown of the
LostTxnCleanup
thread (#389).
Version 4.1.2 (20 March 2023)
API documentation: https://docs.couchbase.com/sdk-api/couchbase-php-client-4.1.2
Source |
|
Checksum |
Underlying C++ SDK Core
-
CXXCBC-144: Search query on collections no longer requires you to pass in the scope name — it is inferred from the index (#379).
-
CXXCBC-145: Search query request, raw option added (#380).
-
CXXCBC-194: The SDK now supports the
ExtThreadSafe
transaction extension (#374, #376). -
CXXCBC-316: When a document is removed in a transaction, and then a call made to
get_optional
, we expect to just get an empty optional. However, the handling was raising atransaction_operation_failed
This has been fixed, and anempty optional
will now be returned (#385). -
CXXCBC-310: Fixed race condition in transaction_context state machine (#386, #378).
Version 4.1.1 (22 February 2023)
API documentation: https://docs.couchbase.com/sdk-api/couchbase-php-client-4.1.1
Source |
|
Checksum |
Fixes
Notable Changes in C++ SDK 1.0.0-dp.4
-
CXXCBC-275: Update implementation query context fields passed to the server. In future versions of the server versions it will become mandatory to specify context of the statement (bucket, scope and collection). This change ensures that both future and current server releases supported transparently.
-
CXXCBC-296: Force PLAIN SASL auth if TLS enabled. Using SCRAM SASL mechanisms over TLS protocol is unnecesary complication, that slows down initial connection bootstrap and potentially limits server ability to improve security and evolve credentials management.
-
CXXCBC-295: The
get with projections
opration should not fail if one of the the paths is missing in the document, because the semantics is "get the partial document" and not "get individual fields" like inlookup_in
operation. -
CXXCBC-294: In the Public API, if
get
operation requested to return expiry time, zero expiry should not be interpreted as absolute expiry timestamp (zero seconds from UNIX epoch), but rather as absense of the expiry. -
CXXCBC-291: Allow to disable mutation tokens for Key/Value mutations (use
enable_mutation_tokens
in connection string). -
Resource management and performance improvements:
-
Fix tracer and meter ref-counting (#370)
-
Replace
minstd_rand
withmt19937_64
, as it gives less collisions (#356) -
CXXCBC-285: Write to sockets from IO threads, to eliminate potential race conditions. (#348)
-
Eliminate looping transform in
mcbp_parser::next
(#347) -
CXXCBC-205: Use thread-local UUID generator (#340)
-
CXXCBC-293: Performance improvements:
-
-
Build system fixes:
-
Enhancements:
Version 4.1.0 (20 January 2023)
Version 4.1.0 brings a number of improvements related to internal connection behavior.
API documentation: https://docs.couchbase.com/sdk-api/couchbase-php-client-4.1.0
Source |
|
Checksum |
Fixes
-
PCBC-889: Fixed behaviour of 'skip' SearchOption.
-
Bug fixes: logger and build improvements
Caveats
There are no pre-built binaries for the Windows platform of PHP SDK 4.1.0. But there are steps in WINDOWS.md, that describe how to build an extension along with PHP interpreter.
PHP SDK 4.0 Releases
Version 4.0.0 (11 May 2022)
Version 4.0.0 is the first major release of the next generation PHP SDK, built on the Couchbase++ library — featuring multi-document distributed ACID transactions, and bringing a number of improvements related to internal connection behavior.
API documentation: https://docs.couchbase.com/sdk-api/couchbase-php-client-4.0.0
Source |
|
Checksum |
Caveats
There are no pre-built binaries for the Windows platform of PHP SDK 4.0.0. But there are steps in WINDOWS.md, that describe how to build an extension along with PHP interpreter.
Older Releases
See:
-
Although no longer supported, documentation for older releases continues to be available in our docs archive.