Ottoman ODM Release Notes and Archives

      +
      Release notes, installation instructions, and download archive for the Ottoman ODM.

      These pages cover the 2.x versions of the Ottoman ODM.

      The Ottoman ODM will run on any supported LTS version of Node.js.

      Version 2.4.0 (23 January 2024)

      Version 2.4.0 is a minor release of the Ottoman ODM. This release adds support for Full Text Search, fixes an issues listed below, and upgrades several underlying dependencies.

      $ npm install ottoman@2.4.0

      New Features

      Fixed Issues

      • #742: Fixed depopulating for nested objects.

      Version 2.3.4 (1 August 2023)

      Version 2.3.4 is a patch release of the Ottoman ODM. This release upgrades several underlying dependencies and fixes a number of issues listed below.

      $ npm install ottoman@2.3.4

      Fixed Issues

      • #724: Added undefined to stringType Validator.

      • #726: Updated Merge Doc Behavior.

      • #728: Fixed query while using arrays indexes, e.g. array[-1] (last element).

      Version 2.3.3 (4 April 2023)

      Version 2.3.3 is a patch release of the Ottoman ODM. This release fixes an issue with the ArrayType options to prevent them from being set to undefined.

      $ npm install ottoman@2.3.3

      Fixed Issues

      • ArrayType not handling options correctly.

      Version 2.3.2 (2 March 2023)

      Version 2.3.2 is a patch release of the Ottoman ODM. This release adds fixes and dependency upgrades. Ottoman can now be used by TypeScript users without setting the skipLibCheck flag. This release also adds documentation for automatic UUID generation.

      $ npm install ottoman@2.3.2

      Fixed Issues

      • TypeScript no longer needs skipLibCheck flag.

      Version 2.3.1 (2 March 2023)

      Please do not use version 2.3.1.

      Version 2.3.0 (19 December 2022)

      Version 2.3.0 is a minor release of the Ottoman ODM. This release adds fixes and dependency upgrades, including a major version upgrade to the couchbase dependency.

      $ npm install ottoman@2.3.0

      Fixed Issues

      • Bumped couchbase dependency to v4.2.0.

      Important Configuration Change

      • This release includes a major version bump to the Couchbase dependency, and with it a specific change to handling SSL/TLS connections. If you were previously skipping certificate checking with the parameter ?ssl=no_verify in your connection string, you’ll need to update it to ?tls_verify=none. More information can be found in this article.

      Version 2.2.2 (9 November 2022)

      Version 2.2.2 is a patch release of the Ottoman ODM. This release adds minor fixes and dependency upgrades, including a patch version upgrade to the couchbase dependency.

      $ npm install ottoman@2.2.2

      Fixed Issues

      • Bumped couchbase dependency to v3.2.6.

      Version 2.2.1 (22 June 2022)

      Version 2.2.1 is a patch release of the Ottoman ODM. This release adds minor fixes, and a number of dependency upgrades.

      $ npm install ottoman@2.2.1

      Fixed Issues

      • Updated index naming to include the model’s name.

      • options.strict is now set to true by default.

      • A DocumentNotFound error is thrown for documents with a different model.

      • Updated regex to ensure a clean index name.

      Version 2.2.0 (29 March 2022)

      Version 2.2.0 is a minor release of the Ottoman ODM. This release adds two new features, and a number of dependency upgrades.

      $ npm install ottoman@2.2.0

      New Features

      • Ottoman: added support to allow modelKey to be a nested field.

      • Hooks: trigger embed schema hooks.

      Version 2.1.0 (7 Feb 2022)

      Version 2.1.0 is a minor release of the Ottoman Object Document Mapper(ODM) library, bringing a number of improvements, and support for Couchbase Node.js SDK 3.2.4.

      $ npm install ottoman@2.1.0

      New Features

      • Added ability to set keyGeneratorDelimiter to an empty string to use ID as key with no delimiter.

      • Updated Couchbase Node.js SDK to version 3.2.4.

      Fixed Issues

      • Fixed model inconsistency in find method.

      • Bumped shelljs and follow-redirects dependencies.

      Documentation Fixes

      • Reword v1 docs note.

      Version 2.0.0 (30 Sept 2021)

      This is the first GA release of the Ottoman Object Document Mapper(ODM) library.

      $ npm install ottoman@2.0.0

      New Features

      • Exposed various SDK types to use directly from Ottoman.

      • Added start option ignoreWatchIndexes. The start() function will wait for indexes by default, but this can be disabled by setting ignoreWatchIndexes to true.

      • Enforced referenced document option.

      • Ottoman now returns the document id reference if it doesn’t exist.

      • Added event to listen for index readiness.

      • Added examples for find methods and bulk operations.

      • Improved from clause value escape behavior in the QueryBuilder.

      • Upgraded embedded Couchbase SDK to version 3.2.2.

      Fixed Issues

      • Refactored lean and populate code.

      • Fixed broken links.

      • Fixed model links for statics methods.

      Documentation Fixes

      • Fixed typo in the major word.

      • Updated quickstart example.

      • Updated getting started example.

      • Updated docs for async connect function.

      • Added metrics to Ottoman vs NodeJS SDK documentation.

      • Updated FAQ benefits section.

      • Fixed broken links to new sdk docs.

      • Downgraded typedoc.

      • Added api documentation for namespace.

      • Update FAQ page.