Changelog

couchbeam NEWS

version 2.0.0 / 2026-01-21

Breaking Changes

• OTP 27+ required: Uses the new json module from OTP stdlib instead of jsx/jiffy
• All JSON now represented as maps: Documents, view results, and all API responses now use Erlang maps instead of proplists ({Key, Value} lists)
• Removed jsx/jiffy dependencies: No external JSON libraries required
• Simplified streaming architecture: Uses hackney's process-per-connection model with spawned linked processes instead of gen_server-based stream modules

Removed Modules

The following modules have been removed as part of the architecture simplification:

• gen_changes - behavior for changes handlers
• couchbeam_changes_stream - gen_server for changes streaming
• couchbeam_changes_sup - supervisor for changes streams
• couchbeam_view_stream - gen_server for view streaming
• couchbeam_view_sup - supervisor for view streams

New Features

• Added json_stream_parse module for incremental JSON parsing of streaming responses
• Streaming now uses simple linked processes with monitors for automatic cleanup

API Changes

• couchbeam_doc functions now work with maps instead of proplists
• View and changes results are returned as maps
• Document IDs and revisions are accessed via maps:get/2,3 instead of proplists functions

Dependencies

• hackney 2.0.1 (process-per-connection model)
• OTP 27+ (for stdlib json module)

Migration

See doc/MIGRATION.md for detailed migration instructions from 1.x.

version 1.7.1 / 2025-07-24

• update hackney depdendency to 1.25.0

version 1.7.0 / 2025-05-28

• fix resource leaks and race conditions in stream modules
• fix unclosed hackney connections on error paths
• add proper cleanup for monitor references using try-finally
• fix ETS table race conditions by checking process liveness
• improve stream initialization order to prevent races
• add error handling for hackney operations to prevent leaks
• fix changes stream registration race condition by registering before parent notification

version 1.6.0 / 2025-01-26

• add support for CouchDB _find endpoint
• add ability to query _show functions
• add option for disabling view_stream usage (enabled by default)
• fix error handling in gen_changes callback handling
• fix resource cleanup in stream modules to prevent connection leaks
• improve replication test reliability and timeout handling
• update hackney dependency to 1.23
• update jsx dependency
• add GitHub Actions for CouchDB testing
• fix dialyzer complaints and pattern matching issues
• OTP 27 compatibility improvements

version 1.5.4 / 2025-02-20

• bump hackney 1.22.0

version 1.5.3 / 2024-08-20

• fix packaging

version 1.5.1 / 2024-11-07

• fix pattern matching

version 1.5.1 / 2024-11-07

• fix: handle condition that may cause persistent CLOSE-WAIT sockets

version 1.5.0 / 2023-10-11

• use hackney 1.20.0
• fix compatibility with couchdb 3
• fix compatibility with Erlang >= 23

version 1.4.1 / 2016-09-26

• maintainance update

version 1.4.0 / 2016-09-22

• maintainance update.

version 1.3.1 / 2016-07-01

• fix: accept 202 status in couchbeam:save_doc/4 function (#144)
• fix: spec syntax to build with Erlang 19 (#145)

version 1.3.0 / 2016-03-22

• add couchbeam:all_dbs/2
• add couchbeam:view_cleanup/1
• add couchbeam:design_info/2
• add post_decode function to view stream
• add Elixir mix support
• fix: handle http errors in view stream (#140)
• fix: build with latest rebar3

version 1.2.1 / 2015/11/04

• also support hackney 1.4.4 for rebar2.
• fix hex.pm release to really use 1.4.4

version 1.2.0 / 2015/11/04

• move to eunit for tests.
• hex.pm support
• mix & rebar3 build tools support
• bump hackney to 1.4.4
• bump jsx to 2.2.8

Breaking change

erlang-oauth is now optionnal and won't be installed by default.

version 1.1.8 / 2015-08-27

• use latest stable branch of hackney

version 1.1.7 / 2015-03-11

• bump hackney to 1.1.0
• fix Conten-Type header ehen posting doc IDS in changes #126
• fix documentation

version 1.1.6 / 2015-01-02

• fix included_applications (#122)

version 1.1.5 / 2014-12-09

• improvement: do not force connections options to nodelay
• update to Hackney 1.0.4 fix #120
• fix: retry fecthing UUIDS on error (#121)

version 1.1.4 / 2014-12-01

• update to Hackney 1.0.1: more SSL certificate authority handling.
• fix: changes stream

version 1.1.3 / 2014-11-30

• update to Hackney 1.0.0

version 1.1.2 / 2014-11-15

• remove spurious prints

version 1.1.1 / 2014-11-11

• update to hackney 0.15.0, improving performances and concurrency
• fix couchbeam:doc_exists/2(#116)
• fix couchbeam:reply_att/1 (#114) version 1.1.0 / 2014-10-28 -------------------------- - update to [hackney 0.14.3](https://github.com/benoitc/hackney/releases) - fix memory leaks - correctly close sockets - fix streaming issue: don't wait the stream timeout to report the initial error. - update JSX dependency to version 2.1.1 version 1.0.7 / 2014-07-08 -------------------------- - bump to [hackney 0.13.0](https://github.com/benoitc/hackney/releases/tag/0.13.0) version 1.0.6 / 2014-04-18 -------------------------- - bump to [hackney 0.12.1](https://github.com/benoitc/hackney/releases/tag/0.12.2) version 1.0.5 / 2014-04-18 -------------------------- - improve connections with HTTP proxies - improve content-types detection of attachments - improve URL encoding normalzation, useful when connecting to an international domain/URI - URL resolving is faster - bump to [hackney 0.12.0](https://github.com/benoitc/hackney/releases/tag/0.12.0) version 1.0.4 / 2014-04-15 -------------------------- - remove spurious print version 1.0.3 / 2014-04-15 -------------------------- - add support for thenew_editsoption in bulk doc API. - improvement: send a doc as multipart that already contains attachments - bump [hackney](http://github.com/benoitc/hackney) to 0.11.2 - fix path encoding version 1.0.2 / 2014-01-03 -------------------------- - fix: send a doc as multipart that already contains attachments version 1.0.1 / 2013-12-30 -------------------------- - fix connection reusing in changes and view streams - bump hackney version to 0.10.1 version 1.0.0 / 2013-12-21 -------------------------- **First stable release**. This is a supported release. - send a doc and its attachments efficiently using the [multipart API](http://docs.couchdb.org/en/latest/api/document/common.html#creating-multiple-attachments). - addcouchbeam:get_config/{1,2,3},couchbeam:set_config/{4,5}andcouchbeam:delete_config/{3,4}to use the [config API](http://docs.couchdb.org/en/latest/api/server/configuration.html). - addcouchbeam_uuids:random/0andcouchbeam_uuids:utc_random/0to generate UUIDS in your app instead of reusing the UUID generated on the node. By default couchbeam is fetching from the node, which is - add{error, forbidden}and{error, unauthenticated}as possible results of a reply. better if you want to use UUID based on the node time. - fix accept header handling version 0.10.0 / 2013-12-21 --------------------------- - addcouchbeam:copy_doc/{2,3}to support the COPY API - addcouchbeam:get_missing_revs/2to get the list of missing revisions - add support of the [multipart API](http://docs.couchdb.org/en/latest/api/document/common.html#efficient-multiple-attachments-retrieving) when fetching a doc: This change makecouchbeam:open_doc/3return a multipart response{ok, {multipart, Stream}}when using the settingattachments=trueoption. A new option {accept. <<"multipart/mixed">>}" can also be used with the options open_revs or revs to fetch the response as a multipart.
• bump the hackney version to 0.9.1 .

With this change you can now efficiently retrieve a doc with all of its attachments or a doc wit all its revisions. master

version 0.9.3 / 2013-12-07

• fix: couchbeam:open_or_create_db/2' version 0.9.2 / 2013-12-07 -------------------------- - bump hackney version to 0.8.3 version 0.9.1 / 2013-12-05 -------------------------- - fix design docid encoding version 0.9.0 / 2013-12-05 -------------------------- This is a major release pre-1.0. API is now frozen and won't change much until the version 1.0. - replaced the use ofibrowsebyhackneyto handle HTTP connections - new [streaming API](https://github.com/benoitc/couchbeam#stream-view-results) in view - breaking change: remobe - breaking change: remove deprecated view API. Everything is now managed in the [couch_view](https://github.com/benoitc/couchbeam/blob/master/doc/couchbeam_view.md) module. - replacecouchbeam_changes:streamandcouchbeam_changes:fetchfunctions bycouchbeam_changes/followandcouchbeam_changes:follow_once. - breaking change: new attachment API - new: JSX a pure erlang JSON encoder/decoder is now the default. Jiffy can be set at the compilation by definingWITH_JIFFY` in the Erlang options. - removed mochiweb dependency. version 0.7.0 / 2011-07-05 -------------------------- This release contains backwards incompatible changes. - New and more efficient couchbeam_changes API, we now parse json stream instead of the try catch steps we used before. - New and more efficient couchbeam_view API. we now parse json stream instead of getting all results. New couchbeam_view:stream and couchbeam_view fetch functions have been added. We also don't use any more a view record in other functions - HTTP functions have been moved to couchbeam_httpc modules - gen_changes behaviour has been updated to use the couchbeam_changes API. It's also abble to restart a lost connection for longpoll and continuous feeds. Breaking Changes: - couchbeam:view and couchbeam:all_docs have been deprecated. Old views functions using the #view{} record from these functions have been moved in couchbeam_oldview module. - couchbeam:wait_changes, couchbeam:wait_changes_once, couchbeam:changes functions have been deprecated and are now replaced by couchbeam_changes:stream and couchbeam_changes:fetch functions.