Class: MessageStore::Postgres::Session

Inherits:
Object
  • Object
show all
Includes:
Log::Dependency, Settings::Setting
Defined in:
lib/message_store/postgres/session.rb

Defined Under Namespace

Modules: LogText

Constant Summary collapse

Error = 
Class.new(RuntimeError)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#connection ⇒ Object

Returns the value of attribute connection.



18
19
20
 
# File 'lib/message_store/postgres/session.rb', line 18

def connection
  @connection
end

Class Method Details

.build(settings: nil) ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/message_store/postgres/session.rb', line 20

def self.build(settings: nil)
  new.tap do |instance|
    settings ||= Settings.instance
    settings.set(instance)
  end
end

.build_connection(instance) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/message_store/postgres/session.rb', line 57

def self.build_connection(instance)
  settings = instance.settings
  logger.trace { "Building new connection to database (Settings: #{LogText.settings(settings).inspect})" }

  connection = PG::Connection.open(settings)
  connection.type_map_for_results = PG::BasicTypeMapForResults.new(connection)

  logger.trace { "Built new connection to database (Settings: #{LogText.settings(settings).inspect})" }

  connection
end

.configure(receiver, session: nil, settings: nil, attr_name: nil) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/message_store/postgres/session.rb', line 27

def self.configure(receiver, session: nil, settings: nil, attr_name: nil)
  attr_name ||= :session

  if session != nil && settings != nil
    raise Error, "Session configured with both settings and session arguments. Use one or the other, but not both."
  end

  instance = session || build(settings: settings)
  receiver.public_send "#{attr_name}=", instance
  instance
end

.logger ⇒ Object 



120
121
122
 
# File 'lib/message_store/postgres/session.rb', line 120

def self.logger
  @logger ||= Log.get self
end

.settings ⇒ Object 



10
11
12
 
# File 'lib/message_store/postgres/session.rb', line 10

def self.settings
  Settings.names
end

Instance Method Details

#close ⇒ Object 



74
75
76
77
 
# File 'lib/message_store/postgres/session.rb', line 74

def close
  connection.close
  connection = nil
end

#connected? ⇒ Boolean Also known as: open?

Returns:

  • (Boolean) 


69
70
71
 
# File 'lib/message_store/postgres/session.rb', line 69

def connected?
  !connection.nil? && connection.status == PG::CONNECTION_OK
end

#execute(sql_command, params = nil) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/message_store/postgres/session.rb', line 92

def execute(sql_command, params=nil)
  logger.trace { "Executing SQL command" }
  logger.trace(tag: :sql) { sql_command }
  logger.trace(tag: :data) { params.pretty_inspect }

  unless connected?
    connect
  end

  if params.nil?
    connection.exec(sql_command).tap do
      logger.debug { "Executed SQL command (no params)" }
    end
  else
    connection.exec_params(sql_command, params).tap do
      logger.debug { "Executed SQL command with params" }
    end
  end
end

#open ⇒ Object Also known as: connect 



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/message_store/postgres/session.rb', line 39

def open
  logger.trace { "Connecting to database" }

  if connected?
    logger.debug { "Already connected. A new connection will not be built." }
    return connection
  end

  logger.debug { "Not connected. A new connection will be built." }
  connection = self.class.build_connection(self)
  self.connection = connection

  logger.debug { "Connected to database" }

  connection
end

#reset ⇒ Object 



79
80
81
 
# File 'lib/message_store/postgres/session.rb', line 79

def reset
  connection.reset
end

#settings ⇒ Object 



83
84
85
86
87
88
89
90
 
# File 'lib/message_store/postgres/session.rb', line 83

def settings
  settings = {}
  self.class.settings.each do |s|
    val = public_send(s)
    settings[s] = val unless val.nil?
  end
  settings
end

#transaction(&blk) ⇒ Object 



112
113
114
115
116
117
118
 
# File 'lib/message_store/postgres/session.rb', line 112

def transaction(&blk)
  unless connected?
    connect
  end

  connection.transaction(&blk)
end