message-db 1.1.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a59e21d708924019e01007e57fd6ec70e56e8414bbed5c6383e4e31a4b82d9c
-  data.tar.gz: 8972744da6ef9f35e809f1e2da16337dac6c938c340a80b7d4240c651c735654
+  metadata.gz: 49621caad583b64239cbd8f169e5e4ce4542e8c3fb34e919feb29f2ea7e0b482
+  data.tar.gz: 6b18052ddcb2099b3deeaf0be0594fbc15c452b6a5e4db2f9ac86431cddc8742
 SHA512:
-  metadata.gz: 24751890afbea5a17a81c88f4a1cdb3bdf9c29db74ad294ea0ad4ec7372c85412869139ee8ea9ac2766f132e6bac3ccda4aae409613d8c46ea03c4ba849e4183
-  data.tar.gz: 9cbcaf795cefc68261da3f204c9ad5d754a7e28a520b9d3437d37b55d08a3bef4d534a3d847e5d5fdac0dfee120a2c3686013306e20c2d058ba3ae8e423cc310
+  metadata.gz: 9d35a1ab074508046fa3c5c664687ddcc6b27e223841902175b2ddc9b5bd764926d9c016234448fd56edb1e839d066ea53fa8c50804b1c4d0ac09de44c9b8dc3
+  data.tar.gz: efc1c0ece0763d8939e5459ab733b54fe132a9a90d55ce2fc587345f8729c6ced5067913cba3abe8d474fd8e0d95e5aab82df756eed2eca01d65a5bbd82bfebb

data/database/VERSION.txt

@@ -1 +1 @@
-1.1.0
+1.1.5

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.0';
+  RETURN '1.1.5';
 END;
 $$ LANGUAGE plpgsql
 VOLATILE;

data/database/functions/write-message.sql

@@ -12,8 +12,6 @@ DECLARE
   _message_id uuid;
   _stream_version bigint;
   _next_position bigint;
-  _category varchar;
-  _category_name_hash bigint;
 BEGIN
   PERFORM acquire_lock(write_message.stream_name);
 
@@ -65,8 +63,6 @@ BEGIN
     RAISE NOTICE 'data ($4): %', write_message.data;
     RAISE NOTICE 'metadata ($5): %', write_message.metadata;
     RAISE NOTICE 'expected_version ($6): %', write_message.expected_version;
-    RAISE NOTICE '_category: %', _category;
-    RAISE NOTICE '_category_name_hash: %', _category_name_hash;
     RAISE NOTICE '_stream_version: %', _stream_version;
     RAISE NOTICE '_next_position: %', _next_position;
   END IF;

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/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.0
+  version: 2.0.1
 platform: ruby
 authors:
 - The Eventide Project
 autorequire: 
 bindir: scripts
 cert_chain: []
-date: 2019-12-12 00:00:00.000000000 Z
+date: 2019-12-21 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