Eventide

# Settings

The connection initialization data are provided through the capabilities of the MessageStore::Postgres::Settings class.

By default, the connection data is stored in a settings file, but settings data can also be provided by a hash, or by directly manipulating an instance's attributes.

# Example

settings = MessageStore::Postgres::Settings.build
# => #<MessageStore::Postgres::Settings:0x...
 @data=
  {"dbname"=>"message_store",
   "host"=>"localhost",
   "hostaddr"=>"127.0.0.1",
   "port"=>5432,
   "user"=>"message_store"}>

# Settings Facts

  • Settings data can be provided by a json settings file or by a hash
  • A Session instance gets its connection data from a Settings instance
  • The message store's Settings class is an instance of Eventide's Settings (opens new window) class

# MessageStore::Postgres::Settings Class

The Settings class is a concrete class from the MessageStore::Postgres library and namespace.

The Settings class provides:

  • An attribute for each setting
  • The names class method that lists the names of the settings attributes
  • The build class method that constructs a settings instance from connection data in the default settings file location
  • The initializer that receives a hash of raw settings data

# Settings Attributes

The Settings class provides the following settings attributes for controlling the database connection:

  • host
  • hostaddr
  • port
  • dbname
  • user
  • password
  • passfile
  • channel_binding
  • connect_timeout
  • client_encoding
  • options
  • application_name
  • fallback_application_name
  • keepalives
  • keepalives_idle
  • keepalives_interval
  • keepalives_count
  • tcp_user_timeout
  • replication
  • database
  • gssencmode
  • sslmode
  • requiressl
  • sslcompression
  • sslcert
  • sslkey
  • sslpassword
  • sslrootcert
  • sslcrl
  • sslcrldir
  • sslsni
  • requirepeer
  • ssl_min_protocol_version
  • ssl_max_protocol_version
  • krbsrvname
  • gsslib
  • service
  • target_session_attrs

For more information on Postgres connection options, see Postgres' connection documentation: https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-PARAMKEYWORDS (opens new window)

The settings attributes reflect the attributes of the PG library's Connection class. For more details, see: https://deveiate.org/code/pg/PG/Connection.html#method-c-new (opens new window).

# Settings File

WARNING

The settings file has no effect on the Message DB installation tools or administrative tools. It is for the runtime configuration of an applicative connection to the message store. Message DB installation and administrative tools leverage standard Postgres tools (opens new window) and their own connection configuration environment variables (opens new window) and optional password files (opens new window). These are completely independent of Eventide, and have no bearing on Eventide's own runtime database connection settings.

By default, the connection data is stored in a file located at {component_root}/settings/message_store_postgres.json

{
  "dbname": "message_store",
  "host": "localhost",
  "hostaddr": "127.0.0.1",
  "port": 5432,
  "user": "message_store"
  "password": "********"
}

# Overriding the Settings File Location

By default, the settings file is located at {component_root}/settings/message_store_postgres.json.

The location of the settings file path can be overridden by setting the MESSAGE_STORE_SETTINGS_PATH environment variable.

MESSAGE_STORE_SETTINGS_PATH=some-other-directory/settings.json start_service.sh

# Constructing a Settings

Settings can be constructed in one of two ways

  • Via the initializer
  • Via the constructor

# Via the Initializer

Settings.new(data)

Returns

Instance of the Settings class.

Parameters

Name Description Type
data A hash of key/value pairs that correspond to the settings attributes Hash
settings = Settings.new({
  :dbname => "message_store",
  :host => "localhost",
  :user => "message_store"
})

# Via the Constructor

self.build(source='./settings/message_store_postgres.json')

The constructor not only instantiates the Settings, but also constructs either a file data source or a hash data source depending on the source argument's type. When no argument is sent, a file data source using the default settings file path is used.

The default settings file path is ./settings/message_store_postgres.json.

Returns

Instance of the Settings class.

Parameters

Name Description Type
source A file system path or a hash of key/value pairs that correspond to the settings attributes String or Hash
# Raw settings data
settings = Settings.build({
  :dbname => "message_store",
  :host => "localhost",
  :user => "message_store"
})

# Default settings file
settings = Settings.build() # Uses ./settings/message_store_postgres.json

# Specific settings file
settings = Settings.build('some_settings_file.json')

# Constructing Settings and a Session from Memory Variables

In cases where reading settings from a file is impractical, such as a cloud environment where connection data is provided by environment variables, a settings object can be constructed directly using a hash.

database = ENV['database']
host = ENV['host']
username = ENV['username']

data = {
  dbname: database,
  host: host,
  user: username
}

settings = Settings.new(data)

# Log Tags

The following tags are applied to log messages recorded by an instance of Settings:

Tag Description
settings Applied to all log messages recorded by a Settings

See the logging user guide for more on log tags.