message-db 1.1.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bc627b7bad9a6122e64aa93d12df909506c991bbc817dff8b16ebd0fe07797f
-  data.tar.gz: e3184892e11278cb3f80b004bd57a58c163481e82b876a9f329fe4be3cad3be9
+  metadata.gz: 8924f72521c7d2dfaad3524a3fc2f4be0d4f19ff8a8329ef59c2516e12f3e780
+  data.tar.gz: db54d8ee1604d9dd21f021d76ca7908efae849c1ae743c3089576f56fb55198c
 SHA512:
-  metadata.gz: b687d1d6fe9f177fb8bf39ab7c495bf326270a7869842ad622c4df61ce17990fa925d4e2a275ff5aa759106ba9e3c638bce1fa1e72c86fe1f94ee7737b6d39fd
-  data.tar.gz: 29a73a12d4aa9564185cb8f033cf33536bb4ed2028153cdbaabf65669f0f9c465c25d22ab480a693d110367b98678b36eafcc934e2b2d3327c8354ee738e8171
+  metadata.gz: f179f2d80ffb5a6768bab8cdedda241e6d27e81bfb91eff00bf976c91e7e3996e93998cf3e1542082269c2db225dda9abfb2ba5fe0e0228098f76ae2dbd0d751
+  data.tar.gz: '0378119403ae556f6fd26066dd4cac23dcf1093480087eb289f03fa6ae261d45cee9caf66981f990a4e57e486af45186f4f31269b8c2853b457cf0b8cd02d646'

data/database/VERSION.txt

@@ -1 +1 @@
-1.1.1
+1.1.6

data/database/extensions/pgcrypto.sql

@@ -1 +1 @@
-CREATE EXTENSION IF NOT EXISTS pgcrypto SCHEMA message_store;
+CREATE EXTENSION IF NOT EXISTS pgcrypto;

data/database/functions/message-store-version.sql

@@ -2,7 +2,7 @@ CREATE OR REPLACE FUNCTION message_store.message_store_version()
 RETURNS varchar
 AS $$
 BEGIN
-  RETURN '1.1.1';
+  RETURN '1.1.6';
 END;
 $$ LANGUAGE plpgsql
 VOLATILE;

data/database/install.sh

@@ -30,7 +30,7 @@ function create-user {
   base=$(script_dir)
 
   echo "» message_store role"
-  psql -q -f $base/roles/message-store.sql
+  psql postgres -q -f $base/roles/message-store.sql
 }
 
 function create-database {

data/database/privileges/functions.sql

@@ -1,14 +1,15 @@
+GRANT EXECUTE ON FUNCTION gen_random_uuid() TO message_store;
+GRANT EXECUTE ON FUNCTION md5(text) TO message_store;
+
 GRANT EXECUTE ON FUNCTION message_store.acquire_lock(varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.cardinal_id(varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.category(varchar) TO message_store;
-GRANT EXECUTE ON FUNCTION message_store.gen_random_uuid() TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.get_category_messages(varchar, bigint, bigint, varchar, bigint, bigint, varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.get_last_stream_message(varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.get_stream_messages(varchar, bigint, bigint, varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.hash_64(varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.id(varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.is_category(varchar) TO message_store;
-GRANT EXECUTE ON FUNCTION md5(text) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.message_store_version() TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.stream_version(varchar) TO message_store;
 GRANT EXECUTE ON FUNCTION message_store.write_message(varchar, varchar, varchar, jsonb, jsonb, bigint) TO message_store;

data/database/tables/messages.sql

@@ -1,5 +1,5 @@
 CREATE TABLE IF NOT EXISTS message_store.messages (
-  id UUID NOT NULL DEFAULT message_store.gen_random_uuid(),
+  id UUID NOT NULL DEFAULT gen_random_uuid(),
   stream_name text NOT NULL,
   type text NOT NULL,
   position bigint NOT NULL,

data/database/uninstall.sh

@@ -28,13 +28,13 @@ fi
 
 function delete-user {
   echo "» message_store user"
-  psql -P pager=off -q -c "DROP OWNED BY message_store;"
-  psql -P pager=off -q -c "DROP ROLE IF EXISTS message_store;"
+  psql postgres -P pager=off -q -c "DROP OWNED BY message_store;"
+  psql postgres -P pager=off -q -c "DROP ROLE IF EXISTS message_store;"
 }
 
 function delete-database {
   echo "» $database database"
-  psql -P pager=off -q -c "DROP DATABASE IF EXISTS $database;"
+  psql postgres -P pager=off -q -c "DROP DATABASE IF EXISTS $database;"
 }
 
 echo "Deleting database"

data/database/update.sh

@@ -2,170 +2,17 @@
 
 set -e
 
-function script_dir {
-  val="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-  echo "$val"
-}
-
-base=$(script_dir)
-
-echo
-echo "Updating Database"
-echo "Version: $(cat $base/VERSION.txt)"
-echo "= = ="
-
-if [ -z ${DATABASE_NAME+x} ]; then
-  echo "(DATABASE_NAME is not set. Default will be used.)"
-  database=message_store
-  export DATABASE_NAME=$database
-else
-  database=$DATABASE_NAME
-fi
-echo
-
-if [ -z ${PGOPTIONS+x} ]; then
-  export PGOPTIONS='-c client_min_messages=warning'
-fi
-
-function delete-extensions {
-  echo "» pgcrypto extension"
-  psql $database -q -c "DROP EXTENSION IF EXISTS pgcrypto";
-}
-
-function delete-indexes {
-  echo "» messages_id_uniq_idx index"
-  psql $database -q -c "DROP INDEX IF EXISTS messages_id_uniq_idx CASCADE";
-
-  echo "» messages_stream_name_position_uniq_idx index"
-  psql $database -q -c "DROP INDEX IF EXISTS messages_stream_name_position_uniq_idx";
-
-  echo "» messages_category_global_position_idx index"
-  psql $database -q -c "DROP INDEX IF EXISTS messages_category_global_position_idx";
-}
-
-function delete-views {
-  echo "» stream_summary view"
-  psql $database -q -c "DROP VIEW IF EXISTS stream_summary CASCADE";
-
-  echo "» type_summary view"
-  psql $database -q -c "DROP VIEW IF EXISTS type_summary CASCADE";
-
-  echo "» stream_type_summary view"
-  psql $database -q -c "DROP VIEW IF EXISTS stream_type_summary CASCADE";
-
-  echo "» type_stream_summary view"
-  psql $database -q -c "DROP VIEW IF EXISTS type_stream_summary CASCADE";
-
-  echo "» category_type_summary view"
-  psql $database -q -c "DROP VIEW IF EXISTS category_type_summary CASCADE";
-
-  echo "» type_category_summary view"
-  psql $database -q -c "DROP VIEW IF EXISTS type_category_summary CASCADE";
-}
-
-function delete-functions {
-  echo "» hash_64 function"
-  psql $database -q -c "DROP FUNCTION IF EXISTS hash_64 CASCADE";
-
-  echo "» category function"
-  psql $database -q -c "DROP FUNCTION IF EXISTS category CASCADE";
-
-  echo "» stream_version function"
-  psql $database -q -c "DROP FUNCTION IF EXISTS stream_version CASCADE";
-
-  echo "» write_message function"
-  psql $database -q -c "DROP FUNCTION IF EXISTS write_message CASCADE";
-
-  echo "» get_stream_messages function"
-  psql $database -q -c "DROP FUNCTION IF EXISTS get_stream_messages CASCADE";
-
-  echo "» get_category_messages function"
-  psql $database -q -c "DROP FUNCTION IF EXISTS get_category_messages CASCADE";
-
-  echo "» get_last_message function"
-  psql $database -q -c "DROP FUNCTION IF EXISTS get_last_message CASCADE";
-}
-
-function delete-extensions {
-  echo "» pgcrypto extension"
-  psql $database -q -c "DROP EXTENSION IF EXISTS pgcrypto CASCADE";
-}
-
-function create-schema {
-  echo "» message_store schema"
-  psql $database -q -f $base/schema/message-store.sql
-}
-
-function add-table-to-schema {
-  echo "» messages table"
-  psql $database -q -c "ALTER TABLE messages SET SCHEMA message_store";
-}
-
-function create-extensions {
-  base=$(script_dir)
-
-  echo "» pgcrypto extension"
-  psql $database -q -f $base/extensions/pgcrypto.sql
-}
-
-function set-default-value {
-  echo "» id column"
-  psql $database -q -c "ALTER TABLE message_store.messages ALTER COLUMN id SET DEFAULT message_store.gen_random_uuid()";
-}
-
-echo "Deleting Views"
-echo "- - -"
-delete-views
-echo
-
-echo "Deleting Indexes"
-echo "- - -"
-delete-indexes
-echo
-
-echo "Deleting Functions"
-echo "- - -"
-delete-functions
-echo
-
-echo "Deleting Extensions"
-echo "- - -"
-delete-extensions
 echo
-
-echo "Creating Schema"
-echo "- - -"
-create-schema
+echo "WARNING: OBSOLETE"
 echo
-
-echo "Creating Extensions"
-echo "- - -"
-create-extensions
+echo "The ${BASH_SOURCE[0]} has been deprecated"
+echo "See the database/update directory for current update scripts"
 echo
 
-echo "Adding Table to Schema"
-echo "- - -"
-add-table-to-schema
-echo
-
-echo "Set Default Value for ID Column"
-echo "- - -"
-set-default-value
-echo
-
-# Install functions
-source $base/install-functions.sh
-
-# Install indexes
-source $base/install-indexes.sh
-
-# Install views
-source $base/install-views.sh
+current_directory="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+update_directory="$current_directory/update"
 
-# Install privileges
-source $base/install-privileges.sh
+echo "Contents of $update_directory"
+ls -1 $update_directory
 
-echo "= = ="
-echo "Done Updating Database"
-echo "Version: $(cat $base/VERSION.txt)"
 echo

data/database/update/1.0.0.md

@@ -0,0 +1,26 @@
+# 1.0.0 Update
+
+Note: Formerly, `postgres-message-store`.
+
+The following changes are made by the 1.0.0.sh update script:
+
+- **Note: There are no changes to the `messages` table, and no data migration is necessary**
+- The executables named `evt-pg-*` are renamed to `mdb-*`
+- **[breaking change]** The `get_category_messages` server function supports pub/sub directly by receiving a `correlation` argument and composing the correlation metadata query condition directly in the server function ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-messages-from-a-stream](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-messages-from-a-stream))
+- **[breaking change]** The message_store database and its objects are contained in a Postgres schema named `message_store`
+- **[breaking change]** The `get_category_messages` server function supports consumer groups via the `consumer_group_member` and `consumer_group_size` parameters ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-messages-from-a-category](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-messages-from-a-category))
+- The retrieval server functions provide debugging output that is activated via the Postgres setting, `message_store.debug_get` ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#debugging-output](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#debugging-output))
+- The write server function provides debugging output that is activated via the Postgres setting, `message_store.debug_write` ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#debugging-output](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#debugging-output))
+- The `message_store.debug` Postgres setting activates both the retrieval and write debug output ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#debugging-output](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#debugging-output))
+- `id` stream parsing function ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-the-id-from-a-stream-name](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-the-id-from-a-stream-name))
+- `cardinal_id` stream parsing function ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-the-cardinal-id-from-a-stream-name](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-the-cardinal-id-from-a-stream-name))
+- `acquire_lock` function encapsulates the application of the advisory lock used by the `write_message` function ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-message-store-database-schema-version](http://docs.eventide-project.org/user-guide/message-store/server-functions.html#get-message-store-database-schema-version))
+- Database management tool output is clarified
+- **[breaking change]** All server function parameter names are no longer named with underscore prefixes ([http://docs.eventide-project.org/user-guide/message-store/server-functions.html](http://docs.eventide-project.org/user-guide/message-store/server-functions.html))
+- Indexes are no longer built with the `CONCURRENTLY` option ([http://docs.eventide-project.org/user-guide/message-store/anatomy.html#source-code](http://docs.eventide-project.org/user-guide/message-store/anatomy.html#source-code))
+- **[breaking change]** The `messages_category_global_position_idx` is removed and replaced with the `messages_category` index, which now indexes correlation metadata
+- **[breaking change]** The `messages_stream_name_position_uniq_idx` is removed and replaced with the `messages_stream` index, which now indexes correlation metadata
+- **[breaking change]** The `messages_id_uniq_idx` is removed and replaced with the `messages_id` index
+- Message DB RubyGem: [https://github.com/message-db/ruby-gem](https://github.com/message-db/ruby-gem)
+- Message DB NPM Module: [https://github.com/message-db/npm-module](https://github.com/message-db/npm-module)
+- Improvements to interactive tests ([https://github.com/eventide-project/postgres-message-store/tree/master/test](https://github.com/eventide-project/postgres-message-store/tree/master/test))

data/database/update/1.0.0.sh

@@ -0,0 +1,187 @@
+#!/usr/bin/env bash
+
+set -e
+
+echo
+echo "Message DB"
+echo
+echo "Update the message_store database"
+echo
+echo "WARNING:"
+echo "This script updates a pre-v1 message_store database to Message DB v1.x"
+echo "Do not run this script on a Message DB v1 database"
+echo
+echo "Fore more information about the changes made to the message store by"
+echo "this update, see: https://github.com/message-db/message-db/blob/master/database/update/1.0.0.md"
+echo
+echo "- Press CTRL+C to stop this script from running"
+echo "- Press RETURN to allow the script to proceed"
+echo
+read
+
+function script_dir {
+  val="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+  echo "$val"
+}
+
+base="$(script_dir)/.."
+echo $base
+
+echo
+echo "Updating Database"
+echo "Version: $(cat $base/VERSION.txt)"
+echo "= = ="
+
+if [ -z ${DATABASE_NAME+x} ]; then
+  echo "(DATABASE_NAME is not set. Default will be used.)"
+  database=message_store
+  export DATABASE_NAME=$database
+else
+  database=$DATABASE_NAME
+fi
+echo
+
+if [ -z ${PGOPTIONS+x} ]; then
+  export PGOPTIONS='-c client_min_messages=warning'
+fi
+
+function delete-extensions {
+  echo "» pgcrypto extension"
+  psql $database -q -c "DROP EXTENSION IF EXISTS pgcrypto";
+}
+
+function delete-indexes {
+  echo "» messages_id_uniq_idx index"
+  psql $database -q -c "DROP INDEX IF EXISTS messages_id_uniq_idx CASCADE";
+
+  echo "» messages_stream_name_position_uniq_idx index"
+  psql $database -q -c "DROP INDEX IF EXISTS messages_stream_name_position_uniq_idx";
+
+  echo "» messages_category_global_position_idx index"
+  psql $database -q -c "DROP INDEX IF EXISTS messages_category_global_position_idx";
+}
+
+function delete-views {
+  echo "» stream_summary view"
+  psql $database -q -c "DROP VIEW IF EXISTS stream_summary CASCADE";
+
+  echo "» type_summary view"
+  psql $database -q -c "DROP VIEW IF EXISTS type_summary CASCADE";
+
+  echo "» stream_type_summary view"
+  psql $database -q -c "DROP VIEW IF EXISTS stream_type_summary CASCADE";
+
+  echo "» type_stream_summary view"
+  psql $database -q -c "DROP VIEW IF EXISTS type_stream_summary CASCADE";
+
+  echo "» category_type_summary view"
+  psql $database -q -c "DROP VIEW IF EXISTS category_type_summary CASCADE";
+
+  echo "» type_category_summary view"
+  psql $database -q -c "DROP VIEW IF EXISTS type_category_summary CASCADE";
+}
+
+function delete-functions {
+  echo "» hash_64 function"
+  psql $database -q -c "DROP FUNCTION IF EXISTS hash_64 CASCADE";
+
+  echo "» category function"
+  psql $database -q -c "DROP FUNCTION IF EXISTS category CASCADE";
+
+  echo "» stream_version function"
+  psql $database -q -c "DROP FUNCTION IF EXISTS stream_version CASCADE";
+
+  echo "» write_message function"
+  psql $database -q -c "DROP FUNCTION IF EXISTS write_message CASCADE";
+
+  echo "» get_stream_messages function"
+  psql $database -q -c "DROP FUNCTION IF EXISTS get_stream_messages CASCADE";
+
+  echo "» get_category_messages function"
+  psql $database -q -c "DROP FUNCTION IF EXISTS get_category_messages CASCADE";
+
+  echo "» get_last_message function"
+  psql $database -q -c "DROP FUNCTION IF EXISTS get_last_message CASCADE";
+}
+
+function delete-extensions {
+  echo "» pgcrypto extension"
+  psql $database -q -c "DROP EXTENSION IF EXISTS pgcrypto CASCADE";
+}
+
+function create-schema {
+  echo "» message_store schema"
+  psql $database -q -f $base/schema/message-store.sql
+}
+
+function add-table-to-schema {
+  echo "» messages table"
+  psql $database -q -c "ALTER TABLE messages SET SCHEMA message_store";
+}
+
+function create-extensions {
+  echo "» pgcrypto extension"
+  psql $database -q -f $base/extensions/pgcrypto.sql
+}
+
+function set-default-value {
+  echo "» id column"
+  psql $database -q -c "ALTER TABLE message_store.messages ALTER COLUMN id SET DEFAULT gen_random_uuid()";
+}
+
+echo "Deleting Views"
+echo "- - -"
+delete-views
+echo
+
+echo "Deleting Indexes"
+echo "- - -"
+delete-indexes
+echo
+
+echo "Deleting Functions"
+echo "- - -"
+delete-functions
+echo
+
+echo "Deleting Extensions"
+echo "- - -"
+delete-extensions
+echo
+
+echo "Creating Schema"
+echo "- - -"
+create-schema
+echo
+
+echo "Creating Extensions"
+echo "- - -"
+create-extensions
+echo
+
+echo "Adding Table to Schema"
+echo "- - -"
+add-table-to-schema
+echo
+
+echo "Set Default Value for ID Column"
+echo "- - -"
+set-default-value
+echo
+
+# Install functions
+source $base/install-functions.sh
+
+# Install indexes
+source $base/install-indexes.sh
+
+# Install views
+source $base/install-views.sh
+
+# Install privileges
+source $base/install-privileges.sh
+
+echo "= = ="
+echo "Done Updating Database"
+echo "Version: $(cat $base/VERSION.txt)"
+echo

data/scripts/{mdb-open-database-scripts-dir → mdb-print-database-scripts-dir}

@@ -2,4 +2,4 @@
 
 root = File.expand_path '../database', __dir__
 
-system `open #{root}`
+puts root

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message-db
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.2
 platform: ruby
 authors:
 - The Eventide Project
 autorequire: 
 bindir: scripts
 cert_chain: []
-date: 2019-12-18 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies: []
 description: " "
 email: opensource@eventide-project.org
@@ -18,15 +18,14 @@ executables:
 - mdb-print-type-category-summary
 - mdb-install-views
 - mdb-delete-db
-- mdb-update-db
 - mdb-print-type-summary
 - mdb-print-stream-type-summary
 - mdb-install-privileges
 - mdb-recreate-db
 - mdb-print-messages
 - mdb-print-message-store-version
+- mdb-print-database-scripts-dir
 - mdb-print-type-stream-summary
-- mdb-open-database-scripts-dir
 - mdb-write-test-message
 - mdb-install-indexes
 - mdb-install-functions
@@ -80,6 +79,8 @@ files:
 - database/types/message.sql
 - database/uninstall.sh
 - database/update.sh
+- database/update/1.0.0.md
+- database/update/1.0.0.sh
 - database/views/category-type-summary.sql
 - database/views/stream-summary.sql
 - database/views/stream-type-summary.sql
@@ -94,8 +95,8 @@ files:
 - scripts/mdb-install-indexes
 - scripts/mdb-install-privileges
 - scripts/mdb-install-views
-- scripts/mdb-open-database-scripts-dir
 - scripts/mdb-print-category-type-summary
+- scripts/mdb-print-database-scripts-dir
 - scripts/mdb-print-message-store-version
 - scripts/mdb-print-messages
 - scripts/mdb-print-stream-summary
@@ -104,7 +105,6 @@ files:
 - scripts/mdb-print-type-stream-summary
 - scripts/mdb-print-type-summary
 - scripts/mdb-recreate-db
-- scripts/mdb-update-db
 - scripts/mdb-write-test-message
 homepage: https://github.com/message-db/message-db
 licenses:

data/scripts/mdb-update-db

@@ -1,7 +0,0 @@
-#!/usr/bin/env ruby
-
-root = File.expand_path '../database', __dir__
-script_filename = 'update.sh'
-script_filepath = File.join root, script_filename
-
-system script_filepath