Class: ROM::SQL::Gateway

Inherits:
Gateway
  • Object
show all
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 pg_hstore)
}.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):

    • :inferrable_relations (Array<Symbol>) —

      A list of dataset names that should be inferred. If this is set explicitly to an empty array relations won’t be inferred at all

    • :not_inferrable_relations (Array<Symbol>) —

      A list of dataset names that should NOT be inferred

    • :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:



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

def initialize(uri, options = EMPTY_HASH)
  @connection = connect(uri, options)
  load_extensions(Array(options[:extensions]))

  @options = options

  super
end

Instance Attribute Details

#logger ⇒ Object (readonly) 



28
29
30
 
# File 'lib/rom/sql/gateway.rb', line 28

def logger
  @logger
end

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

Returns the value of attribute migrator.

#options ⇒ Object (readonly) 



32
33
34
 
# File 'lib/rom/sql/gateway.rb', line 32

def options
  @options
end

Instance Method Details

#[](name) ⇒ Dataset

Return dataset with the given name

Thsi returns a raw Sequel database

Parameters:

  • name (String, Symbol) —

    The dataset name

Returns:

  • (Dataset) 


111
112
113
 
# File 'lib/rom/sql/gateway.rb', line 111

def [](name)
  connection[name]
end

#create_table(*args, &block) ⇒ Object

Create a table using the configured connection



184
185
186
 
# File 'lib/rom/sql/gateway.rb', line 184

def create_table(*args, &block)
  connection.create_table(*args, &block)
end

#dataset(name) ⇒ Dataset

Return dataset with the given name

Parameters:

  • name (String) —

    a dataset name

Returns:

  • (Dataset) 


143
144
145
 
# File 'lib/rom/sql/gateway.rb', line 143

def dataset(name)
  connection[name]
end

#dataset?(name) ⇒ Boolean

Check if a dataset exists

Parameters:

  • name (String) —

    dataset name

Returns:

  • (Boolean) 


152
153
154
 
# File 'lib/rom/sql/gateway.rb', line 152

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

#disconnect ⇒ Object

Disconnect from the gateway’s database



98
99
100
 
# File 'lib/rom/sql/gateway.rb', line 98

def disconnect
  connection.disconnect
end

#drop_table(*args, &block) ⇒ Object

Drops a table



191
192
193
 
# File 'lib/rom/sql/gateway.rb', line 191

def drop_table(*args, &block)
  connection.drop_table(*args, &block)
end

#extend_command_class(klass, dataset) ⇒ Object

Extend the command class with database-specific behavior

Note: Currently, only postgres is supported.

Parameters:

  • klass (Class) —

    Command class

  • dataset (Sequel::Dataset) —

    A dataset that will be used



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/rom/sql/gateway.rb', line 164

def extend_command_class(klass, dataset)
  type = dataset.db.database_type

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

    klass.send(:include, ext) if ext
  end

  klass
end

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

Migration DSL

See Also:

#pending_migrations? ⇒ Boolean Originally defined in module Migration

Check if there are any pending migrations

Returns:

  • (Boolean)

See Also:

  • pending?

#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



200
201
202
 
# File 'lib/rom/sql/gateway.rb', line 200

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


131
132
133
134
 
# File 'lib/rom/sql/gateway.rb', line 131

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