From 0446275a3479fc3ecab1545c29ce743367b57ccc Mon Sep 17 00:00:00 2001 From: wesone Date: Wed, 16 Jun 2021 14:49:14 +0200 Subject: [PATCH] updated docs and changelog --- CHANGELOG.md | 3 +++ docs/ReadModelStoreAdapter.md | 1 + package.json | 3 ++- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index fa25bad..af1cc37 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Bug where idempotency in read model store fails for multiple inserts/updates per event - Bug where projections handle events in a wrong order during a replay +### Added +- New option `index` for ReadModelStore.defineTable scheme, to allow B-Tree and FULLTEXT indexing of fields + ## [1.1.2] - 2021-05-05 ### Changed - Renamed workflow property `currentEvent` to `event` diff --git a/docs/ReadModelStoreAdapter.md b/docs/ReadModelStoreAdapter.md index d9e114b..9c917d8 100644 --- a/docs/ReadModelStoreAdapter.md +++ b/docs/ReadModelStoreAdapter.md @@ -50,6 +50,7 @@ Property | Type | Attribute | Description type | string | | The fields data type. Can be one of the following:
`boolean` true or false
`date` Dates like JavaScript Date objects
`json` Objects that can be JSON serialized
`number` Positive or negative float or integer
`string` Strings with a max length of 512 characters
`text` Strings of indefinite length
`uuid` Strings with 36 characters primaryKey | boolean | optional | Sets the field as Primary key unique | boolean | optional | Sets the field to be unique across all entries +index | boolean \| string | optional | Adds an index to the field. If index is `true`, B-Tree indexing is used, other values are:
`btree` B-Tree indexing
`fulltext` FULLTEXT indexing ## options Property | Type | Attribute | Description diff --git a/package.json b/package.json index fa2a71f..cc1b820 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,8 @@ "main": "src/index.js", "scripts": { "test": "jest --testMatch=**/test/**/*.test.js --verbose --passWithNoTests", - "coverage": "jest --coverage" + "coverage": "jest --coverage", + "docs": "npx docsify serve docs" }, "repository": { "type": "git",