Class: ROM::SQL::Gateway

Inherits:
Gateway
  • Object
show all
Extended by:
Notifications
Includes:
Dry::Core::Constants, Migration
Defined in:
lib/rom/sql/gateway.rb

Overview

SQL gateway

Constant Summary collapse

CONNECTION_EXTENSIONS = 
{
  postgres: %i[pg_array pg_json pg_enum]
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri) ⇒ SQL::Gateway #initialize(uri, options) ⇒ SQL::Gateway #initialize(connection) ⇒ SQL::Gateway

Initialize an SQL gateway

Gateways are typically initialized via ROM::Configuration object, gateway constructor arguments such as URI and options are passed directly to this constructor

Overloads:

  • #initialize(uri) ⇒ SQL::Gateway

    Connects to a database via URI

    Examples:

    ROM.container(:sql, 'postgres://localhost/db_name')

    Parameters:

    • uri (String, Symbol) —

      connection URI

  • #initialize(uri, options) ⇒ SQL::Gateway

    Connects to a database via URI and options

    Examples:

    ROM.container(:sql, 'postgres://localhost/db_name', extensions: %w[pg_enum])

    Parameters:

    • uri (String, Symbol) —

      connection URI

    • options (Hash) —

      connection options

    Options Hash (options):

    • :extensions (Array<Symbol>) —

      A list of connection extensions supported by Sequel

    • :user (String) —

      Database username

    • :password (String) —

      Database password

  • #initialize(connection) ⇒ SQL::Gateway

    Creates a gateway from an existing database connection. This works with Sequel connections exclusively.

    Examples:

    ROM.container(:sql, Sequel.connect(:sqlite))

    Parameters:

    • connection (Sequel::Database) —

      a connection instance

See Also:



85
86
87
88
89
90
91
92
93
 
# File 'lib/rom/sql/gateway.rb', line 85

def initialize(uri, options = EMPTY_HASH)
  @connection = connect(uri, options)
  load_extensions(Array(options[:extensions]))
  notifications.trigger("sql.gateway.connected", connection: @connection)

  @options = options

  super
end

Instance Attribute Details

#logger ⇒ Object (readonly) 



35
36
37
 
# File 'lib/rom/sql/gateway.rb', line 35

def logger
  @logger
end

#migrator ⇒ Object (readonly) Originally defined in module Migration

Returns the value of attribute migrator.

#options ⇒ Object (readonly) 



39
40
41
 
# File 'lib/rom/sql/gateway.rb', line 39

def options
  @options
end

Instance Method Details

#[](name) ⇒ Dataset

Return dataset with the given name

This returns a raw Sequel database

Parameters:

  • name (String, Symbol) —

    The dataset name

Returns:

  • (Dataset) 


116
117
118
 
# File 'lib/rom/sql/gateway.rb', line 116

def [](name)
  connection[name]
end

#auto_migrate!(setup, options = EMPTY_HASH) ⇒ Object Originally defined in module Migration

#call(function, *args) ⇒ Object

Call a SQL function

Examples:

gateway.(:upper, 'John Doe') # => "JOHN DOE"

Parameters:

  • function (Symbol) —

    Function name

  • args (Array<Object>) —

    Function arguments

Returns:

  • (Object) 


204
205
206
 
# File 'lib/rom/sql/gateway.rb', line 204

def call(function, *args)
  connection[Sequel.function(function, *args)].first.values.first
end

#command(klass, relation:, **opts) ⇒ Command

Build an SQL-specific command

Returns:

  • (Command) 


222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/rom/sql/gateway.rb', line 222

def command(klass, relation:, **opts)
  return super unless relation.dataset.db.database_type == :postgres

  ext =
    if klass < Commands::Create
      Postgres::Commands::Create
    elsif klass < Commands::Update
      Postgres::Commands::Update
    end

  klass.include(ext) if ext

  super
end

#create_table ⇒ Object

Create a table using the configured connection



164
165
166
 
# File 'lib/rom/sql/gateway.rb', line 164

def create_table(...)
  connection.create_table(...)
end

#database_type ⇒ Symbol

Underlying database type

Returns:

  • (Symbol) 


189
190
191
 
# File 'lib/rom/sql/gateway.rb', line 189

def database_type
  @database_type ||= connection.database_type.to_sym
end

#dataset(name) ⇒ Dataset

Return dataset with the given name

Parameters:

  • name (String) —

    a dataset name

Returns:

  • (Dataset) 


148
149
150
 
# File 'lib/rom/sql/gateway.rb', line 148

def dataset(name)
  connection[name]
end

#dataset?(name) ⇒ Boolean

Check if a dataset exists

Parameters:

  • name (String) —

    dataset name

Returns:

  • (Boolean) 


157
158
159
 
# File 'lib/rom/sql/gateway.rb', line 157

def dataset?(name)
  schema.include?(name)
end

#disconnect ⇒ Object

Disconnect from the gateway's database



103
104
105
 
# File 'lib/rom/sql/gateway.rb', line 103

def disconnect
  connection.disconnect
end

#drop_table ⇒ Object

Drops a table



171
172
173
 
# File 'lib/rom/sql/gateway.rb', line 171

def drop_table(...)
  connection.drop_table(...)
end

#migration(&block) ⇒ Object Originally defined in module Migration

Migration DSL

See Also:

#notifications ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



96
97
98
 
# File 'lib/rom/sql/gateway.rb', line 96

def notifications
  @notifications ||= Notifications.event_bus(:sql)
end

#pending_migrations? ⇒ Boolean Originally defined in module Migration

Check if there are any pending migrations

Returns:

  • (Boolean)

See Also:

  • pending?

#run(statement) ⇒ Object

Execute a statement

Parameters:

  • statement (String) 


213
214
215
 
# File 'lib/rom/sql/gateway.rb', line 213

def run(statement)
  connection.run(statement)
end

#run_migrations(options = {}) ⇒ Object Originally defined in module Migration

Run migrations

Examples:

rom = ROM.container(:sql, ['sqlite::memory'])
rom.gateways[:default].run_migrations

Parameters:

  • options (Hash) (defaults to: {}) —

    The options used by Sequel migrator

#schema ⇒ Array

Returns a list of datasets inferred from table names

Returns:

  • (Array) —

    array with table names



180
181
182
 
# File 'lib/rom/sql/gateway.rb', line 180

def schema
  @schema ||= connection.tables
end

#use_logger(logger) ⇒ Object

Setup a logger

Examples:

set a logger during configuration process

rom = ROM.container(:sql, 'sqlite::memory') do |config|
  config.gateways[:default].use_logger(Logger.new($stdout))
end

set logger after gateway has been established

rom = ROM.container(:sql, 'sqlite::memory')
rom.gateways[:default].use_logger(Logger.new($stdout))

Parameters:

  • logger (Object)

See Also:

  • Sequel::Database#loggers


136
137
138
139
 
# File 'lib/rom/sql/gateway.rb', line 136

def use_logger(logger)
  @logger = logger
  connection.loggers << logger
end