Class: Sequel::Database

Inherits:
Object show all
Defined in:
lib/sequel/database.rb,
lib/sequel/database/misc.rb,
lib/sequel/database/query.rb,
lib/sequel/database/dataset.rb,
lib/sequel/database/logging.rb,
lib/sequel/database/features.rb,
lib/sequel/database/connecting.rb,
lib/sequel/database/transactions.rb,
lib/sequel/database/schema_methods.rb,
lib/sequel/database/dataset_defaults.rb

Overview

A Database object represents a virtual connection to a database. The Database class is meant to be subclassed by database adapters in order to provide the functionality needed for executing queries.

Defined Under Namespace

Modules: FromBlock, ResetIdentifierMangling, SplitAlterTable

Constant Summary

OPTS =
Sequel::OPTS
EXTENSIONS =

Hash of extension name symbols to callable objects to load the extension into the Database object (usually by extending it with a module defined in the extension).

{}
DEFAULT_STRING_COLUMN_SIZE =

The general default size for string columns for all Sequel::Database instances.

255
DEFAULT_DATABASE_ERROR_REGEXPS =

Empty exception regexp to class map, used by default if Sequel doesn't have specific support for the database in use.

{}.freeze
SCHEMA_TYPE_CLASSES =

Mapping of schema type symbols to class or arrays of classes for that symbol.

{:string=>String, :integer=>Integer, :date=>Date, :datetime=>[Time, DateTime].freeze,
:time=>Sequel::SQLTime, :boolean=>[TrueClass, FalseClass].freeze, :float=>Float, :decimal=>BigDecimal,
:blob=>Sequel::SQL::Blob}.freeze
STRING_DEFAULT_RE =

:section: 1 - Methods that execute queries and/or return results This methods generally execute SQL code on the database server.


/\A'(.*)'\z/
CURRENT_TIMESTAMP_RE =
/now|today|CURRENT|getdate|\ADate\(\)\z/io
COLUMN_SCHEMA_DATETIME_TYPES =
[:date, :datetime]
COLUMN_SCHEMA_STRING_TYPES =
[:string, :blob, :date, :datetime, :time, :enum, :set, :interval]
ADAPTERS =

Array of supported database adapters

%w'ado amalgalite cubrid db2 dbi do firebird ibmdb informix jdbc mock mysql mysql2 odbc openbase oracle postgres sqlanywhere sqlite swift tinytds'.collect{|x| x.to_sym}
SQL_BEGIN =

:section: 8 - Methods related to database transactions Database transactions make multiple queries atomic, so that either all of the queries take effect or none of them do.


'BEGIN'.freeze
SQL_COMMIT =
'COMMIT'.freeze
SQL_RELEASE_SAVEPOINT =
'RELEASE SAVEPOINT autopoint_%d'.freeze
SQL_ROLLBACK =
'ROLLBACK'.freeze
SQL_ROLLBACK_TO_SAVEPOINT =
'ROLLBACK TO SAVEPOINT autopoint_%d'.freeze
SQL_SAVEPOINT =
'SAVEPOINT autopoint_%d'.freeze
TRANSACTION_BEGIN =
'Transaction.begin'.freeze
TRANSACTION_COMMIT =
'Transaction.commit'.freeze
TRANSACTION_ROLLBACK =
'Transaction.rollback'.freeze
TRANSACTION_ISOLATION_LEVELS =
{:uncommitted=>'READ UNCOMMITTED'.freeze,
:committed=>'READ COMMITTED'.freeze,
:repeatable=>'REPEATABLE READ'.freeze,
:serializable=>'SERIALIZABLE'.freeze}
AUTOINCREMENT =

:section: 2 - Methods that modify the database schema These methods execute code on the database that modifies the database's schema.


'AUTOINCREMENT'.freeze
COMMA_SEPARATOR =
', '.freeze
NOT_NULL =
' NOT NULL'.freeze
NULL =
' NULL'.freeze
PRIMARY_KEY =
' PRIMARY KEY'.freeze
TEMPORARY =
'TEMPORARY '.freeze
UNDERSCORE =
'_'.freeze
UNIQUE =
' UNIQUE'.freeze
UNSIGNED =
' UNSIGNED'.freeze
COLUMN_DEFINITION_ORDER =

The order of column modifiers to use when defining a column.

[:collate, :default, :null, :unique, :primary_key, :auto_increment, :references]
DEFAULT_JOIN_TABLE_COLUMN_OPTIONS =

The default options for join table columns.

{:null=>false}
COMBINABLE_ALTER_TABLE_OPS =

The alter table operations that are combinable.

[:add_column, :drop_column, :rename_column,
:set_column_type, :set_column_default, :set_column_null,
:add_constraint, :drop_constraint]
DatasetClass =

The default class to use for datasets

Sequel::Dataset

Class Attribute Summary (collapse)

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Database) initialize(opts = OPTS, &block)

Constructs a new instance of a database connection with the specified options hash.

Accepts the following options:

:default_string_column_size

The default size of string columns, 255 by default.

:identifier_input_method

A string method symbol to call on identifiers going into the database

:identifier_output_method

A string method symbol to call on identifiers coming from the database

:logger

A specific logger to use

:loggers

An array of loggers to use

:quote_identifiers

Whether to quote identifiers

:servers

A hash specifying a server/shard specific options, keyed by shard symbol

:single_threaded

Whether to use a single-threaded connection pool

:sql_log_level

Method to use to log SQL to a logger, :info by default.

All options given are also passed to the connection pool.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/sequel/database/misc.rb', line 113

def initialize(opts = OPTS, &block)
  @opts ||= opts
  @opts = connection_pool_default_options.merge(@opts)
  @loggers = Array(@opts[:logger]) + Array(@opts[:loggers])
  self.log_warn_duration = @opts[:log_warn_duration]
  block ||= proc{|server| connect(server)}
  @opts[:servers] = {} if @opts[:servers].is_a?(String)
  @opts[:adapter_class] = self.class
  
  @opts[:single_threaded] = @single_threaded = typecast_value_boolean(@opts.fetch(:single_threaded, Database.single_threaded))
  @schemas = {}
  @default_string_column_size = @opts[:default_string_column_size] || DEFAULT_STRING_COLUMN_SIZE
  @prepared_statements = {}
  @transactions = {}
  @identifier_input_method = nil
  @identifier_output_method = nil
  @quote_identifiers = nil
  @timezone = nil
  @dataset_class = dataset_class_default
  @cache_schema = typecast_value_boolean(@opts.fetch(:cache_schema, true))
  @dataset_modules = []
  @schema_type_classes = SCHEMA_TYPE_CLASSES.dup
  self.sql_log_level = @opts[:sql_log_level] ? @opts[:sql_log_level].to_sym : :info
  @pool = ConnectionPool.get_pool(self, @opts)

  reset_identifier_mangling
  adapter_initialize

  unless typecast_value_boolean(@opts[:keep_reference]) == false
    Sequel.synchronize{::Sequel::DATABASES.push(self)}
  end
  Sequel::Database.run_after_initialize(self)
end

Class Attribute Details

+ (Object) identifier_input_method

The identifier input method to use by default for all databases (default: adapter default)



17
18
19
# File 'lib/sequel/database/dataset_defaults.rb', line 17

def identifier_input_method
  @identifier_input_method
end

+ (Object) identifier_output_method

The identifier output method to use by default for all databases (default: adapter default)



20
21
22
# File 'lib/sequel/database/dataset_defaults.rb', line 20

def identifier_output_method
  @identifier_output_method
end

+ (Object) quote_identifiers

Whether to quote identifiers (columns and tables) by default for all databases (default: adapter default)



23
24
25
# File 'lib/sequel/database/dataset_defaults.rb', line 23

def quote_identifiers
  @quote_identifiers
end

+ (Object) single_threaded

Whether to use the single threaded connection pool by default



15
16
17
# File 'lib/sequel/database/connecting.rb', line 15

def single_threaded
  @single_threaded
end

Instance Attribute Details

- (Object) cache_schema

Whether the schema should be cached for this database. True by default for performance, can be set to false to always issue a database query to get the schema.



19
20
21
# File 'lib/sequel/database/query.rb', line 19

def cache_schema
  @cache_schema
end

- (Object) dataset_class

The class to use for creating datasets. Should respond to new with the Database argument as the first argument, and an optional options hash.



39
40
41
# File 'lib/sequel/database/dataset_defaults.rb', line 39

def dataset_class
  @dataset_class
end

- (Object) default_string_column_size

The specific default size of string columns for this Sequel::Database, usually 255 by default.



96
97
98
# File 'lib/sequel/database/misc.rb', line 96

def default_string_column_size
  @default_string_column_size
end

- (Object) identifier_input_method

The identifier input method to use by default for this database (default: adapter default)



42
43
44
# File 'lib/sequel/database/dataset_defaults.rb', line 42

def identifier_input_method
  @identifier_input_method
end

- (Object) identifier_output_method

The identifier output method to use by default for this database (default: adapter default)



45
46
47
# File 'lib/sequel/database/dataset_defaults.rb', line 45

def identifier_output_method
  @identifier_output_method
end

- (Object) log_warn_duration

Numeric specifying the duration beyond which queries are logged at warn level instead of info level.



10
11
12
# File 'lib/sequel/database/logging.rb', line 10

def log_warn_duration
  @log_warn_duration
end

- (Object) loggers

Array of SQL loggers to use for this database.



13
14
15
# File 'lib/sequel/database/logging.rb', line 13

def loggers
  @loggers
end

- (Object) opts (readonly)

The options hash for this database



90
91
92
# File 'lib/sequel/database/misc.rb', line 90

def opts
  @opts
end

- (Object) pool (readonly)

The connection pool for this Database instance. All Database instances have their own connection pools.



113
114
115
# File 'lib/sequel/database/connecting.rb', line 113

def pool
  @pool
end

- (Object) prepared_statements (readonly)

The prepared statement object hash for this database, keyed by name symbol



14
15
16
# File 'lib/sequel/database/query.rb', line 14

def prepared_statements
  @prepared_statements
end

- (Object) sql_log_level

Log level at which to log SQL queries. This is actually the method sent to the logger, so it should be the method name symbol. The default is :info, it can be set to :debug to log at DEBUG level.



18
19
20
# File 'lib/sequel/database/logging.rb', line 18

def sql_log_level
  @sql_log_level
end

- (Object) timezone

The timezone to use for this database, defaulting to Sequel.database_timezone.



268
269
270
# File 'lib/sequel/database/misc.rb', line 268

def timezone
  @timezone || Sequel.database_timezone
end

- (Object) transaction_isolation_level

The default transaction isolation level for this database, used for all future transactions. For MSSQL, this should be set to something if you ever plan to use the :isolation option to Database#transaction, as on MSSQL if affects all future transactions on the same connection.



31
32
33
# File 'lib/sequel/database/transactions.rb', line 31

def transaction_isolation_level
  @transaction_isolation_level
end

Class Method Details

+ (Object) adapter_class(scheme)

The Database subclass for the given adapter scheme. Raises Sequel::AdapterNotFound if the adapter could not be loaded.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'lib/sequel/database/connecting.rb', line 21

def self.adapter_class(scheme)
  return scheme if scheme.is_a?(Class)

  scheme = scheme.to_s.gsub('-', '_').to_sym
  
  unless klass = ADAPTER_MAP[scheme]
    # attempt to load the adapter file
    begin
      require "sequel/adapters/#{scheme}"
    rescue LoadError => e
      raise Sequel.convert_exception_class(e, AdapterNotFound)
    end
    
    # make sure we actually loaded the adapter
    unless klass = ADAPTER_MAP[scheme]
      raise AdapterNotFound, "Could not load #{scheme} adapter: adapter class not registered in ADAPTER_MAP"
    end
  end
  klass
end

+ (Object) adapter_scheme

Returns the scheme symbol for the Database class.



43
44
45
# File 'lib/sequel/database/connecting.rb', line 43

def self.adapter_scheme
  @scheme
end

+ (Object) after_initialize(&block)

Register a hook that will be run when a new Database is instantiated. It is called with the new database handle.

Raises:



40
41
42
43
44
45
46
47
48
49
# File 'lib/sequel/database/misc.rb', line 40

def self.after_initialize(&block)
  raise Error, "must provide block to after_initialize" unless block
  Sequel.synchronize do
    previous = @initialize_hook
    @initialize_hook = Proc.new do |db|
      previous.call(db)
      block.call(db)
    end
  end
end

+ (Object) connect(conn_string, opts = OPTS)

Connects to a database. See Sequel.connect.



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/sequel/database/connecting.rb', line 48

def self.connect(conn_string, opts = OPTS)
  case conn_string
  when String
    if match = /\A(jdbc|do):/o.match(conn_string)
      c = adapter_class(match[1].to_sym)
      opts = opts.merge(:orig_opts=>opts.dup)
      opts = {:uri=>conn_string}.merge(opts)
    else
      uri = URI.parse(conn_string)
      scheme = uri.scheme
      scheme = :dbi if scheme =~ /\Adbi-/
      c = adapter_class(scheme)
      uri_options = c.send(:uri_to_options, uri)
      uri.query.split('&').collect{|s| s.split('=')}.each{|k,v| uri_options[k.to_sym] = v if k && !k.empty?} unless uri.query.to_s.strip.empty?
      uri_options.to_a.each{|k,v| uri_options[k] = (defined?(URI::DEFAULT_PARSER) ? URI::DEFAULT_PARSER : URI).unescape(v) if v.is_a?(String)}
      opts = uri_options.merge(opts).merge!(:orig_opts=>opts.dup, :uri=>conn_string, :adapter=>scheme)
    end
  when Hash
    opts = conn_string.merge(opts)
    opts = opts.merge(:orig_opts=>opts.dup)
    c = adapter_class(opts[:adapter_class] || opts[:adapter] || opts['adapter'])
  else
    raise Error, "Sequel::Database.connect takes either a Hash or a String, given: #{conn_string.inspect}"
  end
  # process opts a bit
  opts = opts.inject({}) do |m, (k,v)|
    k = :user if k.to_s == 'username'
    m[k.to_sym] = v
    m
  end
  begin
    db = c.new(opts)
    db.test_connection if opts[:test] && db.send(:typecast_value_boolean, opts[:test])
    if block_given?
      return yield(db)
    end
  ensure
    if block_given?
      db.disconnect if db
      Sequel.synchronize{::Sequel::DATABASES.delete(db)}
    end
  end
  db
end

+ (Object) extension(*extensions)

Apply an extension to all Database objects created in the future.



52
53
54
# File 'lib/sequel/database/misc.rb', line 52

def self.extension(*extensions)
  after_initialize{|db| db.extension(*extensions)}
end

+ (Object) register_extension(ext, mod = nil, &block)

Register an extension callback for Database objects. ext should be the extension name symbol, and mod should either be a Module that the database is extended with, or a callable object called with the database object. If mod is not provided, a block can be provided and is treated as the mod object.



61
62
63
64
65
66
67
68
69
70
71
# File 'lib/sequel/database/misc.rb', line 61

def self.register_extension(ext, mod=nil, &block)
  if mod
    raise(Error, "cannot provide both mod and block to Database.register_extension") if block
    if mod.is_a?(Module)
      block = proc{|db| db.extend(mod)}
    else
      block = mod
    end
  end
  Sequel.synchronize{EXTENSIONS[ext] = block}
end

+ (Object) run_after_initialize(instance)

Run the after_initialize hook for the given instance.



74
75
76
# File 'lib/sequel/database/misc.rb', line 74

def self.run_after_initialize(instance)
  @initialize_hook.call(instance)
end

+ (Object) set_adapter_scheme(scheme)

Sets the adapter scheme for the Database class. Call this method in descendants of Database to allow connection using a URL. For example the following:

class Sequel::MyDB::Database < Sequel::Database
  set_adapter_scheme :mydb
  ...
end

would allow connection using:

Sequel.connect('mydb://user:password@dbserver/mydb')


105
106
107
108
# File 'lib/sequel/database/connecting.rb', line 105

def self.set_adapter_scheme(scheme) # :nodoc:
  @scheme = scheme
  ADAPTER_MAP[scheme] = self
end

+ (Object) uri_to_options(uri)

Converts a uri to an options hash. These options are then passed to a newly created database object.



80
81
82
83
84
85
86
# File 'lib/sequel/database/misc.rb', line 80

def self.uri_to_options(uri)
  { :user => uri.user,
    :password => uri.password,
    :host => uri.host,
    :port => uri.port,
    :database => (m = /\/(.*)/.match(uri.path)) && (m[1]) }
end

Instance Method Details

- (Object) <<(sql)

Runs the supplied SQL statement string on the database server. Returns self so it can be safely chained:

DB << "UPDATE albums SET artist_id = NULL" << "DROP TABLE artists"


25
26
27
28
# File 'lib/sequel/database/query.rb', line 25

def <<(sql)
  run(sql)
  self
end

- (Object) [](*args)

Returns a dataset for the database. If the first argument is a string, the method acts as an alias for Database#fetch, returning a dataset for arbitrary SQL, with or without placeholders:

DB['SELECT * FROM items'].all
DB['SELECT * FROM items WHERE name = ?', my_name].all

Otherwise, acts as an alias for Database#from, setting the primary table for the dataset:

DB[:items].sql #=> "SELECT * FROM items"


19
20
21
# File 'lib/sequel/database/dataset.rb', line 19

def [](*args)
  args.first.is_a?(String) ? fetch(*args) : from(*args)
end

- (Object) adapter_scheme

Returns the scheme symbol for this instance's class, which reflects which adapter is being used. In some cases, this can be the same as the database_type (for native adapters), in others (i.e. adapters with subadapters), it will be different.

Sequel.connect('jdbc:postgres://...').adapter_scheme # => :jdbc


121
122
123
# File 'lib/sequel/database/connecting.rb', line 121

def adapter_scheme
  self.class.adapter_scheme
end

- (Object) add_column(table, *args)

Adds a column to the specified table. This method expects a column name, a datatype and optionally a hash with additional constraints and options:

DB.add_column :items, :name, :text, :unique => true, :null => false
DB.add_column :items, :category, :text, :default => 'ruby'

See alter_table.



36
37
38
# File 'lib/sequel/database/schema_methods.rb', line 36

def add_column(table, *args)
  alter_table(table) {add_column(*args)}
end

- (Object) add_index(table, columns, options = OPTS)

Adds an index to a table for the given columns:

DB.add_index :posts, :title
DB.add_index :posts, [:author, :title], :unique => true

Options:

:ignore_errors

Ignore any DatabaseErrors that are raised

:name

Name to use for index instead of default

See alter_table.



50
51
52
53
54
55
56
57
# File 'lib/sequel/database/schema_methods.rb', line 50

def add_index(table, columns, options=OPTS)
  e = options[:ignore_errors]
  begin
    alter_table(table){add_index(columns, options)}
  rescue DatabaseError
    raise unless e
  end
end

- (Object) add_servers(servers)

Dynamically add new servers or modify server options at runtime. Also adds new servers to the connection pool. Intended for use with master/slave or shard configurations where it is useful to add new server hosts at runtime.

servers argument should be a hash with server name symbol keys and hash or proc values. If a servers key is already in use, it's value is overridden with the value provided.

DB.add_servers(:f=>{:host=>"hash_host_f"})


134
135
136
137
138
139
# File 'lib/sequel/database/connecting.rb', line 134

def add_servers(servers)
  if h = @opts[:servers]
    Sequel.synchronize{h.merge!(servers)}
    @pool.add_servers(servers.keys)
  end
end

- (Object) after_commit(opts = OPTS, &block)

If a transaction is not currently in process, yield to the block immediately. Otherwise, add the block to the list of blocks to call after the currently in progress transaction commits (and only if it commits). Options:

:server

The server/shard to use.

Raises:



152
153
154
155
156
157
158
159
160
161
162
# File 'lib/sequel/database/misc.rb', line 152

def after_commit(opts=OPTS, &block)
  raise Error, "must provide block to after_commit" unless block
  synchronize(opts[:server]) do |conn|
    if h = _trans(conn)
      raise Error, "cannot call after_commit in a prepared transaction" if h[:prepare]
      (h[:after_commit] ||= []) << block
    else
      yield
    end
  end
end

- (Object) after_rollback(opts = OPTS, &block)

If a transaction is not currently in progress, ignore the block. Otherwise, add the block to the list of the blocks to call after the currently in progress transaction rolls back (and only if it rolls back). Options:

:server

The server/shard to use.

Raises:



169
170
171
172
173
174
175
176
177
# File 'lib/sequel/database/misc.rb', line 169

def after_rollback(opts=OPTS, &block)
  raise Error, "must provide block to after_rollback" unless block
  synchronize(opts[:server]) do |conn|
    if h = _trans(conn)
      raise Error, "cannot call after_rollback in a prepared transaction" if h[:prepare]
      (h[:after_rollback] ||= []) << block
    end
  end
end

- (Object) alter_table(name, generator = nil, &block)

Alters the given table with the specified block. Example:

DB.alter_table :items do
  add_column :category, :text, :default => 'ruby'
  drop_column :category
  rename_column :cntr, :counter
  set_column_type :value, :float
  set_column_default :value, :float
  add_index [:group, :category]
  drop_index [:group, :category]
end

Note that add_column accepts all the options available for column definitions using create_table, and add_index accepts all the options available for index definition.

See Schema::AlterTableGenerator and the “Migrations and Schema Modification” guide.



76
77
78
79
80
81
# File 'lib/sequel/database/schema_methods.rb', line 76

def alter_table(name, generator=nil, &block)
  generator ||= alter_table_generator(&block)
  remove_cached_schema(name)
  apply_alter_table_generator(name, generator)
  nil
end

- (Object) alter_table_generator(&block)

Return a new Schema::AlterTableGenerator instance with the receiver as the database and the given block.



85
86
87
# File 'lib/sequel/database/schema_methods.rb', line 85

def alter_table_generator(&block)
  alter_table_generator_class.new(self, &block)
end

- (Object) call(ps_name, hash = {}, &block)

Call the prepared statement with the given name with the given hash of arguments.

DB[:items].filter(:id=>1).prepare(:first, :sa)
DB.call(:sa) # SELECT * FROM items WHERE id = 1


35
36
37
# File 'lib/sequel/database/query.rb', line 35

def call(ps_name, hash={}, &block)
  prepared_statement(ps_name).call(hash, &block)
end

- (Object) cast_type_literal(type)

Cast the given type to a literal type

DB.cast_type_literal(Float) # double precision
DB.cast_type_literal(:foo) # foo


183
184
185
# File 'lib/sequel/database/misc.rb', line 183

def cast_type_literal(type)
  type_literal(:type=>type)
end

- (Object) create_join_table(hash, options = OPTS)

Create a join table using a hash of foreign keys to referenced table names. Example:

create_join_table(:cat_id=>:cats, :dog_id=>:dogs)
# CREATE TABLE cats_dogs (
#  cat_id integer NOT NULL REFERENCES cats,
#  dog_id integer NOT NULL REFERENCES dogs,
#  PRIMARY KEY (cat_id, dog_id)
# )
# CREATE INDEX cats_dogs_dog_id_cat_id_index ON cats_dogs(dog_id, cat_id)

The primary key and index are used so that almost all operations on the table can benefit from one of the two indexes, and the primary key ensures that entries in the table are unique, which is the typical desire for a join table.

You can provide column options by making the values in the hash be option hashes, so long as the option hashes have a :table entry giving the table referenced:

create_join_table(:cat_id=>{:table=>:cats, :type=>Bignum}, :dog_id=>:dogs)

You can provide a second argument which is a table options hash:

create_join_table({:cat_id=>:cats, :dog_id=>:dogs}, :temp=>true)

Some table options are handled specially:

:index_options

The options to pass to the index

:name

The name of the table to create

:no_index

Set to true not to create the second index.

:no_primary_key

Set to true to not create the primary key.



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/sequel/database/schema_methods.rb', line 121

def create_join_table(hash, options=OPTS)
  keys = hash.keys.sort_by{|k| k.to_s}
  create_table(join_table_name(hash, options), options) do
    keys.each do |key|
      v = hash[key]
      unless v.is_a?(Hash)
        v = {:table=>v}
      end
      v = DEFAULT_JOIN_TABLE_COLUMN_OPTIONS.merge(v)
      foreign_key(key, v)
    end
    primary_key(keys) unless options[:no_primary_key]
    index(keys.reverse, options[:index_options] || {}) unless options[:no_index]
  end
end

- (Object) create_join_table!(hash, options = OPTS)

Forcibly create a join table, attempting to drop it if it already exists, then creating it.



138
139
140
141
# File 'lib/sequel/database/schema_methods.rb', line 138

def create_join_table!(hash, options=OPTS)
  drop_table?(join_table_name(hash, options))
  create_join_table(hash, options)
end

- (Boolean) create_join_table?(hash, options = OPTS)

Creates the join table unless it already exists.



144
145
146
147
148
149
150
# File 'lib/sequel/database/schema_methods.rb', line 144

def create_join_table?(hash, options=OPTS)
  if supports_create_table_if_not_exists?
    create_join_table(hash, options.merge(:if_not_exists=>true))
  elsif !table_exists?(join_table_name(hash, options))
    create_join_table(hash, options)
  end
end

- (Object) create_or_replace_view(name, source, options = OPTS)

Creates a view, replacing a view with the same name if one already exists.

DB.create_or_replace_view(:some_items, "SELECT * FROM items WHERE price < 100")
DB.create_or_replace_view(:some_items, DB[:items].filter(:category => 'ruby'))

For databases where replacing a view is not natively supported, support is emulated by dropping a view with the same name before creating the view.



231
232
233
234
235
236
237
238
239
# File 'lib/sequel/database/schema_methods.rb', line 231

def create_or_replace_view(name, source, options = OPTS)
  if supports_create_or_replace_view?
    options = options.merge(:replace=>true)
  else
    drop_view(name) rescue nil
  end

  create_view(name, source, options)
end

- (Object) create_table(name, options = OPTS, &block)

Creates a table with the columns given in the provided block:

DB.create_table :posts do
  primary_key :id
  column :title, :text
  String :content
  index :title
end

General options:

:as

Create the table using the value, which should be either a dataset or a literal SQL string. If this option is used, a block should not be given to the method.

:ignore_index_errors

Ignore any errors when creating indexes.

:temp

Create the table as a temporary table.

MySQL specific options:

:charset

The character set to use for the table.

:collate

The collation to use for the table.

:engine

The table engine to use for the table.

PostgreSQL specific options:

:on_commit

Either :preserve_rows (default), :drop or :delete_rows.

:unlogged

Create the table as an unlogged table.

:inherits

Inherit from a different tables. An array can be specified to inherit from multiple tables.

See Schema::Generator and the “Schema Modification” guide.



180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/sequel/database/schema_methods.rb', line 180

def create_table(name, options=OPTS, &block)
  remove_cached_schema(name)
  options = {:generator=>options} if options.is_a?(Schema::CreateTableGenerator)
  if sql = options[:as]
    raise(Error, "can't provide both :as option and block to create_table") if block
    create_table_as(name, sql, options)
  else
    generator = options[:generator] || create_table_generator(&block)
    create_table_from_generator(name, generator, options)
    create_table_indexes_from_generator(name, generator, options)
    nil
  end
end

- (Object) create_table!(name, options = OPTS, &block)

Forcibly create a table, attempting to drop it if it already exists, then creating it.

DB.create_table!(:a){Integer :a} 
# SELECT NULL FROM a LIMIT 1 -- check existence
# DROP TABLE a -- drop table if already exists
# CREATE TABLE a (a integer)


200
201
202
203
# File 'lib/sequel/database/schema_methods.rb', line 200

def create_table!(name, options=OPTS, &block)
  drop_table?(name)
  create_table(name, options, &block)
end

- (Boolean) create_table?(name, options = OPTS, &block)

Creates the table unless the table already exists.

DB.create_table?(:a){Integer :a} 
# SELECT NULL FROM a LIMIT 1 -- check existence
# CREATE TABLE a (a integer) -- if it doesn't already exist


210
211
212
213
214
215
216
# File 'lib/sequel/database/schema_methods.rb', line 210

def create_table?(name, options=OPTS, &block)
  if supports_create_table_if_not_exists?
    create_table(name, options.merge(:if_not_exists=>true), &block)
  elsif !table_exists?(name)
    create_table(name, options, &block)
  end
end

- (Object) create_table_generator(&block)

Return a new Schema::CreateTableGenerator instance with the receiver as the database and the given block.



220
221
222
# File 'lib/sequel/database/schema_methods.rb', line 220

def create_table_generator(&block)
  create_table_generator_class.new(self, &block)
end

- (Object) create_view(name, source, options = OPTS)

Creates a view based on a dataset or an SQL string:

DB.create_view(:cheap_items, "SELECT * FROM items WHERE price < 100")
DB.create_view(:ruby_items, DB[:items].filter(:category => 'ruby'))

Options:

:columns

The column names to use for the view. If not given, automatically determined based on the input dataset.

PostgreSQL/SQLite specific option:

:temp

Create a temporary view, automatically dropped on disconnect.

PostgreSQL specific option:

:materialized

Creates a materialized view, similar to a regular view, but backed by a physical table.

:recursive

Creates a recursive view. As columns must be specified for recursive views, you can also set them as the value of this option. Since a recursive view requires a union that isn't in a subquery, if you are providing a Dataset as the source argument, if should probably call the union method with the :all=>true and :from_self=>false options.



262
263
264
265
266
# File 'lib/sequel/database/schema_methods.rb', line 262

def create_view(name, source, options = OPTS)
  execute_ddl(create_view_sql(name, source, options))
  remove_cached_schema(name)
  nil
end

- (Object) database_type

The database type for this database object, the same as the adapter scheme by default. Should be overridden in adapters (especially shared adapters) to be the correct type, so that even if two separate Database objects are using different adapters you can tell that they are using the same database type. Even better, you can tell that two Database objects that are using the same adapter are connecting to different database types (think JDBC or DataObjects).

Sequel.connect('jdbc:postgres://...').database_type # => :postgres


150
151
152
# File 'lib/sequel/database/connecting.rb', line 150

def database_type
  adapter_scheme
end

- (Object) dataset

Returns a blank dataset for this database.

DB.dataset # SELECT *
DB.dataset.from(:items) # SELECT * FROM items


27
28
29
# File 'lib/sequel/database/dataset.rb', line 27

def dataset
  @dataset_class.new(self)
end

- (Object) disconnect(opts = OPTS)

Disconnects all available connections from the connection pool. Any connections currently in use will not be disconnected. Options:

:servers

Should be a symbol specifing the server to disconnect from, or an array of symbols to specify multiple servers.

Example:

DB.disconnect # All servers
DB.disconnect(:servers=>:server1) # Single server
DB.disconnect(:servers=>[:server1, :server2]) # Multiple servers


164
165
166
# File 'lib/sequel/database/connecting.rb', line 164

def disconnect(opts = OPTS)
  pool.disconnect(opts)
end

- (Object) disconnect_connection(conn)

Should only be called by the connection pool code to disconnect a connection. By default, calls the close method on the connection object, since most adapters use that, but should be overwritten on other adapters.



171
172
173
# File 'lib/sequel/database/connecting.rb', line 171

def disconnect_connection(conn)
  conn.close
end

- (Object) drop_column(table, *args)

Removes a column from the specified table:

DB.drop_column :items, :category

See alter_table.



273
274
275
# File 'lib/sequel/database/schema_methods.rb', line 273

def drop_column(table, *args)
  alter_table(table) {drop_column(*args)}
end

- (Object) drop_index(table, columns, options = OPTS)

Removes an index for the given table and column/s:

DB.drop_index :posts, :title
DB.drop_index :posts, [:author, :title]

See alter_table.



283
284
285
# File 'lib/sequel/database/schema_methods.rb', line 283

def drop_index(table, columns, options=OPTS)
  alter_table(table){drop_index(columns, options)}
end

- (Object) drop_join_table(hash, options = OPTS)

Drop the join table that would have been created with the same arguments to create_join_table:

drop_join_table(:cat_id=>:cats, :dog_id=>:dogs)
# DROP TABLE cats_dogs


292
293
294
# File 'lib/sequel/database/schema_methods.rb', line 292

def drop_join_table(hash, options=OPTS)
  drop_table(join_table_name(hash, options), options)
end

- (Object) drop_table(*names)

Drops one or more tables corresponding to the given names:

DB.drop_table(:posts) # DROP TABLE posts
DB.drop_table(:posts, :comments)
DB.drop_table(:posts, :comments, :cascade=>true)


301
302
303
304
305
306
307
308
# File 'lib/sequel/database/schema_methods.rb', line 301

def drop_table(*names)
  options = names.last.is_a?(Hash) ? names.pop : {}
  names.each do |n|
    execute_ddl(drop_table_sql(n, options))
    remove_cached_schema(n)
  end
  nil
end

- (Boolean) drop_table?(*names)

Drops the table if it already exists. If it doesn't exist, does nothing.

DB.drop_table?(:a)
# SELECT NULL FROM a LIMIT 1 -- check existence
# DROP TABLE a -- if it already exists


316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/sequel/database/schema_methods.rb', line 316

def drop_table?(*names)
  options = names.last.is_a?(Hash) ? names.pop : {}
  if supports_drop_table_if_exists?
    options = options.merge(:if_exists=>true)
    names.each do |name|
      drop_table(name, options)
    end
  else
    names.each do |name|
      drop_table(name, options) if table_exists?(name)
    end
  end
end

- (Object) drop_view(*names)

Drops one or more views corresponding to the given names:

DB.drop_view(:cheap_items)
DB.drop_view(:cheap_items, :pricey_items)
DB.drop_view(:cheap_items, :pricey_items, :cascade=>true)

Options:

:cascade

Also drop objects depending on this view.

PostgreSQL specific options:

:if_exists

Do not raise an error if the view does not exist.

:materialized

Drop a materialized view.



342
343
344
345
346
347
348
349
# File 'lib/sequel/database/schema_methods.rb', line 342

def drop_view(*names)
  options = names.last.is_a?(Hash) ? names.pop : {}
  names.each do |n|
    execute_ddl(drop_view_sql(n, options))
    remove_cached_schema(n)
  end
  nil
end

- (Object) each_server(&block)

Yield a new Database instance for every server in the connection pool. Intended for use in sharded environments where there is a need to make schema modifications (DDL queries) on each shard.

DB.each_server{|db| db.create_table(:users){primary_key :id; String :name}}

Raises:



180
181
182
183
# File 'lib/sequel/database/connecting.rb', line 180

def each_server(&block)
  raise(Error, "Database#each_server must be passed a block") unless block
  servers.each{|s| self.class.connect(server_opts(s), &block)}
end

- (Object) execute_ddl(sql, opts = OPTS, &block)

Method that should be used when submitting any DDL (Data Definition Language) SQL, such as create_table. By default, calls execute_dui. This method should not be called directly by user code.



42
43
44
# File 'lib/sequel/database/query.rb', line 42

def execute_ddl(sql, opts=OPTS, &block)
  execute_dui(sql, opts, &block)
end

- (Object) execute_dui(sql, opts = OPTS, &block)

Method that should be used when issuing a DELETE, UPDATE, or INSERT statement. By default, calls execute. This method should not be called directly by user code.



49
50
51
# File 'lib/sequel/database/query.rb', line 49

def execute_dui(sql, opts=OPTS, &block)
  execute(sql, opts, &block)
end

- (Object) execute_insert(sql, opts = OPTS, &block)

Method that should be used when issuing a INSERT statement. By default, calls execute_dui. This method should not be called directly by user code.



56
57
58
# File 'lib/sequel/database/query.rb', line 56

def execute_insert(sql, opts=OPTS, &block)
  execute_dui(sql, opts, &block)
end

- (Object) extend_datasets(mod = nil, &block)

Equivalent to extending all datasets produced by the database with a module. What it actually does is use a subclass of the current dataset_class as the new dataset_class, and include the module in the subclass. Instead of a module, you can provide a block that is used to create an anonymous module.

This allows you to override any of the dataset methods even if they are defined directly on the dataset class that this Database object uses.

Examples:

# Introspec columns for all of DB's datasets
DB.extend_datasets(Sequel::ColumnsIntrospection)

# Trace all SELECT queries by printing the SQL and the full backtrace
DB.extend_datasets do
  def fetch_rows(sql)
    puts sql
    puts caller
    super
  end
end

Raises:



81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/sequel/database/dataset_defaults.rb', line 81

def extend_datasets(mod=nil, &block)
  raise(Error, "must provide either mod or block, not both") if mod && block
  mod = Module.new(&block) if block
  if @dataset_modules.empty?
   @dataset_modules = [mod]
   @dataset_class = Class.new(@dataset_class)
  else
   @dataset_modules << mod
  end
  @dataset_class.send(:include, mod)
  reset_default_dataset
end

- (Object) extension(*exts)

Load an extension into the receiver. In addition to requiring the extension file, this also modifies the database to work with the extension (usually extending it with a module defined in the extension file). If no related extension file exists or the extension does not have specific support for Database objects, an Error will be raised. Returns self.



192
193
194
195
196
197
198
199
200
201
202
# File 'lib/sequel/database/misc.rb', line 192

def extension(*exts)
  Sequel.extension(*exts)
  exts.each do |ext|
    if pr = Sequel.synchronize{EXTENSIONS[ext]}
      pr.call(self)
    else
      raise(Error, "Extension #{ext} does not have specific support handling individual databases")
    end
  end
  self
end

- (Object) fetch(sql, *args, &block)

Fetches records for an arbitrary SQL statement. If a block is given, it is used to iterate over the records:

DB.fetch('SELECT * FROM items'){|r| p r}

The fetch method returns a dataset instance:

DB.fetch('SELECT * FROM items').all

fetch can also perform parameterized queries for protection against SQL injection:

DB.fetch('SELECT * FROM items WHERE name = ?', my_name).all


44
45
46
47
48
# File 'lib/sequel/database/dataset.rb', line 44

def fetch(sql, *args, &block)
  ds = @default_dataset.with_sql(sql, *args)
  ds.each(&block) if block
  ds
end

- (Object) from(*args, &block)

Returns a new dataset with the from method invoked. If a block is given, it is used as a filter on the dataset.

DB.from(:items) # SELECT * FROM items
DB.from(:items){id > 2} # SELECT * FROM items WHERE (id > 2)


55
56
57
58
# File 'lib/sequel/database/dataset.rb', line 55

def from(*args, &block)
  ds = @default_dataset.from(*args)
  block ? ds.filter(&block) : ds
end

- (Object) from_application_timestamp(v)

Convert the given timestamp from the application's timezone, to the databases's timezone or the default database timezone if the database does not have a timezone.



207
208
209
# File 'lib/sequel/database/misc.rb', line 207

def from_application_timestamp(v)
  Sequel.convert_output_timestamp(v, timezone)
end

- (Object) get(*args, &block)

Returns a single value from the database, e.g.:

DB.get(1) # SELECT 1
# => 1
DB.get{server_version{}} # SELECT server_version()


65
66
67
# File 'lib/sequel/database/query.rb', line 65

def get(*args, &block)
  @default_dataset.get(*args, &block)
end

- (Boolean) global_index_namespace?

Whether the database uses a global namespace for the index. If false, the indexes are going to be namespaced per table.



11
12
13
# File 'lib/sequel/database/features.rb', line 11

def global_index_namespace?
  true
end

- (Boolean) in_transaction?(opts = OPTS)

Return true if already in a transaction given the options, false otherwise. Respects the :server option for selecting a shard.



214
215
216
# File 'lib/sequel/database/misc.rb', line 214

def in_transaction?(opts=OPTS)
  synchronize(opts[:server]){|conn| !!_trans(conn)}
end

- (Object) inspect

Returns a string representation of the database object including the class name and connection URI and options used when connecting (if any).



220
221
222
223
224
225
226
227
# File 'lib/sequel/database/misc.rb', line 220

def inspect
  a = []
  a << uri.inspect if uri
  if (oo = opts[:orig_opts]) && !oo.empty?
    a << oo.inspect
  end
  "#<#{self.class}: #{a.join(' ')}>"
end

- (Object) literal(v)

Proxy the literal call to the dataset.

DB.literal(1) # 1
DB.literal(:a) # a
DB.literal('a') # 'a'


234
235
236
# File 'lib/sequel/database/misc.rb', line 234

def literal(v)
  schema_utility_dataset.literal(v)
end

- (Object) log_exception(exception, message)

Log a message at error level, with information about the exception.



21
22
23
# File 'lib/sequel/database/logging.rb', line 21

def log_exception(exception, message)
  log_each(:error, "#{exception.class}: #{exception.message.strip if exception.message}: #{message}")
end

- (Object) log_info(message, args = nil)

Log a message at level info to all loggers.



26
27
28
# File 'lib/sequel/database/logging.rb', line 26

def log_info(message, args=nil)
  log_each(:info, args ? "#{message}; #{args.inspect}" : message)
end

- (Object) log_yield(sql, args = nil)

Yield to the block, logging any errors at error level to all loggers, and all other queries with the duration at warn or info level.



32
33
34
35
36
37
38
39
40
41
42
43
44
# File 'lib/sequel/database/logging.rb', line 32

def log_yield(sql, args=nil)
  return yield if @loggers.empty?
  sql = "#{sql}; #{args.inspect}" if args
  start = Time.now
  begin
    yield
  rescue => e
    log_exception(e, sql)
    raise
  ensure
    log_duration(Time.now - start, sql) unless e
  end
end

- (Object) logger=(logger)

Remove any existing loggers and just use the given logger:

DB.logger = Logger.new($stdout)


49
50
51
# File 'lib/sequel/database/logging.rb', line 49

def logger=(logger)
  @loggers = Array(logger)
end

- (Object) prepared_statement(name)

Synchronize access to the prepared statements cache.



239
240
241
# File 'lib/sequel/database/misc.rb', line 239

def prepared_statement(name)
  Sequel.synchronize{prepared_statements[name]}
end

- (Object) quote_identifier(v)

Proxy the quote_identifier method to the dataset, useful for quoting unqualified identifiers for use outside of datasets.



246
247
248
# File 'lib/sequel/database/misc.rb', line 246

def quote_identifier(v)
  schema_utility_dataset.quote_identifier(v)
end

- (Object) quote_identifiers=(v)

Set whether to quote identifiers (columns and tables) for this database:

DB[:items] # SELECT * FROM items
DB.quote_identifiers = true
DB[:items] # SELECT * FROM "items"


119
120
121
122
# File 'lib/sequel/database/dataset_defaults.rb', line 119

def quote_identifiers=(v)
  reset_default_dataset
  @quote_identifiers = v
end

- (Boolean) quote_identifiers?

Returns true if the database quotes identifiers.



125
126
127
# File 'lib/sequel/database/dataset_defaults.rb', line 125

def quote_identifiers?
  @quote_identifiers
end

- (Object) remove_servers(*servers)

Dynamically remove existing servers from the connection pool. Intended for use with master/slave or shard configurations where it is useful to remove existing server hosts at runtime.

servers should be symbols or arrays of symbols. If a nonexistent server is specified, it is ignored. If no servers have been specified for this database, no changes are made. If you attempt to remove the :default server, an error will be raised.

DB.remove_servers(:f1, :f2)


195
196
197
198
199
200
# File 'lib/sequel/database/connecting.rb', line 195

def remove_servers(*servers)
  if h = @opts[:servers]
    servers.flatten.each{|s| Sequel.synchronize{h.delete(s)}}
    @pool.remove_servers(servers)
  end
end

- (Object) rename_column(table, *args)

Renames a column in the specified table. This method expects the current column name and the new column name:

DB.rename_column :items, :cntr, :counter

See alter_table.



368
369
370
# File 'lib/sequel/database/schema_methods.rb', line 368

def rename_column(table, *args)
  alter_table(table) {rename_column(*args)}
end

- (Object) rename_table(name, new_name)

Renames a table:

DB.tables #=> [:items]
DB.rename_table :items, :old_items
DB.tables #=> [:old_items]


356
357
358
359
360
# File 'lib/sequel/database/schema_methods.rb', line 356

def rename_table(name, new_name)
  execute_ddl(rename_table_sql(name, new_name))
  remove_cached_schema(name)
  nil
end

- (Object) run(sql, opts = OPTS)

Runs the supplied SQL statement string on the database server. Returns nil. Options:

:server

The server to run the SQL on.

DB.run("SET some_server_variable = 42")


74
75
76
77
78
# File 'lib/sequel/database/query.rb', line 74

def run(sql, opts=OPTS)
  sql = literal(sql) if sql.is_a?(SQL::PlaceholderLiteralString)
  execute_ddl(sql, opts)
  nil
end

- (Object) schema(table, opts = OPTS)

Returns the schema for the given table as an array with all members being arrays of length 2, the first member being the column name, and the second member being a hash of column information. The table argument can also be a dataset, as long as it only has one table. Available options are:

:reload

Ignore any cached results, and get fresh information from the database.

:schema

An explicit schema to use. It may also be implicitly provided via the table name.

If schema parsing is supported by the database, the column information should hash at least contain the following entries:

:allow_null

Whether NULL is an allowed value for the column.

:db_type

The database type for the column, as a database specific string.

:default

The database default for the column, as a database specific string.

:primary_key

Whether the columns is a primary key column. If this column is not present, it means that primary key information is unavailable, not that the column is not a primary key.

:ruby_default

The database default for the column, as a ruby object. In many cases, complex database defaults cannot be parsed into ruby objects, in which case nil will be used as the value.

:type

A symbol specifying the type, such as :integer or :string.

Example:

DB.schema(:artists)
# [[:id,
#   {:type=>:integer,
#    :primary_key=>true,
#    :default=>"nextval('artist_id_seq'::regclass)",
#    :ruby_default=>nil,
#    :db_type=>"integer",
#    :allow_null=>false}],
#  [:name,
#   {:type=>:string,
#    :primary_key=>false,
#    :default=>nil,
#    :ruby_default=>nil,
#    :db_type=>"text",
#    :allow_null=>false}]]

Raises:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/sequel/database/query.rb', line 120

def schema(table, opts=OPTS)
  raise(Error, 'schema parsing is not implemented on this database') unless supports_schema_parsing?

  opts = opts.dup
  tab = if table.is_a?(Dataset)
    o = table.opts
    from = o[:from]
    raise(Error, "can only parse the schema for a dataset with a single from table") unless from && from.length == 1 && !o.include?(:join) && !o.include?(:sql)
    table.first_source_table
  else
    table
  end

  qualifiers = split_qualifiers(tab)
  table_name = qualifiers.pop
  sch = qualifiers.pop
  information_schema_schema = case qualifiers.length
  when 1
    Sequel.identifier(*qualifiers)
  when 2
    Sequel.qualify(*qualifiers)
  end

  if table.is_a?(Dataset)
    quoted_name = table.literal(tab)
    opts[:dataset] = table
  else
    quoted_name = schema_utility_dataset.literal(table)
  end

  opts[:schema] = sch if sch && !opts.include?(:schema)
  opts[:information_schema_schema] = information_schema_schema if information_schema_schema && !opts.include?(:information_schema_schema)

  Sequel.synchronize{@schemas.delete(quoted_name)} if opts[:reload]
  if v = Sequel.synchronize{@schemas[quoted_name]}
    return v
  end

  cols = schema_parse_table(table_name, opts)
  raise(Error, 'schema parsing returned no columns, table probably doesn\'t exist') if cols.nil? || cols.empty?
  cols.each{|_,c| c[:ruby_default] = column_schema_to_ruby_default(c[:default], c[:type])}
  Sequel.synchronize{@schemas[quoted_name] = cols} if cache_schema
  cols
end

- (Object) schema_type_class(type)

Return ruby class or array of classes for the given type symbol.



251
252
253
# File 'lib/sequel/database/misc.rb', line 251

def schema_type_class(type)
  @schema_type_classes[type]
end

- (Object) select(*args, &block)

Returns a new dataset with the select method invoked.

DB.select(1) # SELECT 1
DB.select{server_version{}} # SELECT server_version()
DB.select(:id).from(:items) # SELECT id FROM items


65
66
67
# File 'lib/sequel/database/dataset.rb', line 65

def select(*args, &block)
  @default_dataset.select(*args, &block)
end

- (Object) serial_primary_key_options

Default serial primary key options, used by the table creation code.



257
258
259
# File 'lib/sequel/database/misc.rb', line 257

def serial_primary_key_options
  {:primary_key => true, :type => Integer, :auto_increment => true}
end

- (Object) servers

An array of servers/shards for this Database object.

DB.servers # Unsharded: => [:default]
DB.servers # Sharded:   => [:default, :server1, :server2]


206
207
208
# File 'lib/sequel/database/connecting.rb', line 206

def servers
  pool.servers
end

- (Object) set_column_default(table, *args)

Sets the default value for the given column in the given table:

DB.set_column_default :items, :category, 'perl!'

See alter_table.



377
378
379
# File 'lib/sequel/database/schema_methods.rb', line 377

def set_column_default(table, *args)
  alter_table(table) {set_column_default(*args)}
end

- (Object) set_column_type(table, *args)

Set the data type for the given column in the given table:

DB.set_column_type :items, :price, :float

See alter_table.



386
387
388
# File 'lib/sequel/database/schema_methods.rb', line 386

def set_column_type(table, *args)
  alter_table(table) {set_column_type(*args)}
end

- (Object) set_prepared_statement(name, ps)

Cache the prepared statement object at the given name.



262
263
264
265
# File 'lib/sequel/database/misc.rb', line 262

def set_prepared_statement(name, ps)
  ps.prepared_sql
  Sequel.synchronize{prepared_statements[name] = ps}
end

- (Boolean) single_threaded?

Returns true if the database is using a single-threaded connection pool.



211
212
213
# File 'lib/sequel/database/connecting.rb', line 211

def single_threaded?
  @single_threaded
end

- (Boolean) supports_create_table_if_not_exists?

Whether the database supports CREATE TABLE IF NOT EXISTS syntax, false by default.



17
18
19
# File 'lib/sequel/database/features.rb', line 17

def supports_create_table_if_not_exists?
  false
end

- (Boolean) supports_deferrable_constraints?

Whether the database supports deferrable constraints, false by default as few databases do.



23
24
25
# File 'lib/sequel/database/features.rb', line 23

def supports_deferrable_constraints?
  false
end

- (Boolean) supports_deferrable_foreign_key_constraints?

Whether the database supports deferrable foreign key constraints, false by default as few databases do.



29
30
31
# File 'lib/sequel/database/features.rb', line 29

def supports_deferrable_foreign_key_constraints?
  supports_deferrable_constraints?
end

- (Boolean) supports_drop_table_if_exists?

Whether the database supports DROP TABLE IF EXISTS syntax, default is the same as #supports_create_table_if_not_exists?.



35
36
37
# File 'lib/sequel/database/features.rb', line 35

def supports_drop_table_if_exists?
  supports_create_table_if_not_exists?
end

- (Boolean) supports_foreign_key_parsing?

Whether the database supports Database#foreign_key_list for parsing foreign keys.



41
42
43
# File 'lib/sequel/database/features.rb', line 41

def supports_foreign_key_parsing?
  respond_to?(:foreign_key_list)
end

- (Boolean) supports_index_parsing?

Whether the database supports Database#indexes for parsing indexes.



46
47
48
# File 'lib/sequel/database/features.rb', line 46

def supports_index_parsing?
  respond_to?(:indexes)
end

- (Boolean) supports_partial_indexes?

Whether the database supports partial indexes (indexes on a subset of a table).



51
52
53
# File 'lib/sequel/database/features.rb', line 51

def supports_partial_indexes?
  false
end

- (Boolean) supports_prepared_transactions?

Whether the database and adapter support prepared transactions (two-phase commit), false by default.



57
58
59
# File 'lib/sequel/database/features.rb', line 57

def supports_prepared_transactions?
  false
end

- (Boolean) supports_savepoints?

Whether the database and adapter support savepoints, false by default.



62
63
64
# File 'lib/sequel/database/features.rb', line 62

def supports_savepoints?
  false
end

- (Boolean) supports_savepoints_in_prepared_transactions?

Whether the database and adapter support savepoints inside prepared transactions (two-phase commit), default is false.



68
69
70
# File 'lib/sequel/database/features.rb', line 68

def supports_savepoints_in_prepared_transactions?
  supports_prepared_transactions? && supports_savepoints?
end

- (Boolean) supports_schema_parsing?

Whether the database supports schema parsing via Database#schema.



73
74
75
# File 'lib/sequel/database/features.rb', line 73

def supports_schema_parsing?
  respond_to?(:schema_parse_table, true)
end

- (Boolean) supports_table_listing?

Whether the database supports Database#tables for getting list of tables.



78
79
80
# File 'lib/sequel/database/features.rb', line 78

def supports_table_listing?
  respond_to?(:tables)
end

- (Boolean) supports_transaction_isolation_levels?

Whether the database and adapter support transaction isolation levels, false by default.



88
89
90
# File 'lib/sequel/database/features.rb', line 88

def supports_transaction_isolation_levels?
  false
end

- (Boolean) supports_transactional_ddl?

Whether DDL statements work correctly in transactions, false by default.



93
94
95
# File 'lib/sequel/database/features.rb', line 93

def supports_transactional_ddl?
  false
end

- (Boolean) supports_view_listing?

Whether the database supports Database#views for getting list of views.



83
84
85
# File 'lib/sequel/database/features.rb', line 83

def supports_view_listing?
  respond_to?(:views)
end

- (Object) synchronize(server = nil, &block)

:nocov:



228
229
230
# File 'lib/sequel/database/connecting.rb', line 228

def synchronize(server=nil)
  @pool.hold(server || :default){|conn| yield conn}
end

- (Boolean) table_exists?(name)

Returns true if a table with the given name exists. This requires a query to the database.

DB.table_exists?(:foo) # => false
# SELECT NULL FROM foo LIMIT 1

Note that since this does a SELECT from the table, it can give false negatives if you don't have permission to SELECT from the table.



173
174
175
176
177
178
179
180
# File 'lib/sequel/database/query.rb', line 173

def table_exists?(name)
  sch, table_name = schema_and_table(name)
  name = SQL::QualifiedIdentifier.new(sch, table_name) if sch
  _table_exists?(from(name))
  true
rescue DatabaseError
  false
end

- (Object) test_connection(server = nil)

Attempts to acquire a database connection. Returns true if successful. Will probably raise an Error if unsuccessful. If a server argument is given, attempts to acquire a database connection to the given server/shard.



243
244
245
246
# File 'lib/sequel/database/connecting.rb', line 243

def test_connection(server=nil)
  synchronize(server){|conn|}
  true
end

- (Object) to_application_timestamp(v)

Convert the given timestamp to the application's timezone, from the databases's timezone or the default database timezone if the database does not have a timezone.



275
276
277
# File 'lib/sequel/database/misc.rb', line 275

def to_application_timestamp(v)
  Sequel.convert_timestamp(v, timezone)
end

- (Object) transaction(opts = OPTS, &block)

Starts a database transaction. When a database transaction is used, either all statements are successful or none of the statements are successful. Note that MySQL MyISAM tables do not support transactions.

The following general options are respected:

:isolation

The transaction isolation level to use for this transaction, should be :uncommitted, :committed, :repeatable, or :serializable, used if given and the database/adapter supports customizable transaction isolation levels.

:num_retries

The number of times to retry if the :retry_on option is used. The default is 5 times. Can be set to nil to retry indefinitely, but that is not recommended.

:prepare

A string to use as the transaction identifier for a prepared transaction (two-phase commit), if the database/adapter supports prepared transactions.

:retry_on

An exception class or array of exception classes for which to automatically retry the transaction. Can only be set if not inside an existing transaction. Note that this should not be used unless the entire transaction block is idempotent, as otherwise it can cause non-idempotent behavior to execute multiple times.

:rollback

Can the set to :reraise to reraise any Sequel::Rollback exceptions raised, or :always to always rollback even if no exceptions occur (useful for testing).

:server

The server to use for the transaction.

:savepoint

Whether to create a new savepoint for this transaction, only respected if the database/adapter supports savepoints. By default Sequel will reuse an existing transaction, so if you want to use a savepoint you must use this option.

PostgreSQL specific options:

:deferrable

(9.1+) If present, set to DEFERRABLE if true or NOT DEFERRABLE if false.

:read_only

If present, set to READ ONLY if true or READ WRITE if false.

:synchronous

if non-nil, set synchronous_commit appropriately. Valid values true, :on, false, :off, :local (9.1+), and :remote_write (9.2+).



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/sequel/database/transactions.rb', line 71

def transaction(opts=OPTS, &block)
  if retry_on = opts[:retry_on]
    num_retries = opts.fetch(:num_retries, 5)
    begin
      transaction(opts.merge(:retry_on=>nil, :retrying=>true), &block)
    rescue *retry_on
      if num_retries
        num_retries -= 1
        retry if num_retries >= 0
      else
        retry
      end
      raise
    end
  else
    synchronize(opts[:server]) do |conn|
      if already_in_transaction?(conn, opts)
        if opts[:retrying]
          raise Sequel::Error, "cannot set :retry_on options if you are already inside a transaction"
        end
        return yield(conn)
      end
      _transaction(conn, opts, &block)
    end
  end
end

- (Object) typecast_value(column_type, value)

Typecast the value to the given column_type. Calls typecast_value_#column_type if the method exists, otherwise returns the value. This method should raise Sequel::InvalidValue if assigned value is invalid.



284
285
286
287
288
289
290
291
292
# File 'lib/sequel/database/misc.rb', line 284

def typecast_value(column_type, value)
  return nil if value.nil?
  meth = "typecast_value_#{column_type}"
  begin
    respond_to?(meth, true) ? send(meth, value) : value
  rescue ArgumentError, TypeError => e
    raise Sequel.convert_exception_class(e, InvalidValue)
  end
end

- (Object) uri

Returns the URI use to connect to the database. If a URI was not used when connecting, returns nil.



296
297
298
# File 'lib/sequel/database/misc.rb', line 296

def uri
  opts[:uri]
end

- (Object) url

Explicit alias of uri for easier subclassing.



301
302
303
# File 'lib/sequel/database/misc.rb', line 301

def url
  uri
end

- (Boolean) valid_connection?(conn)

Check whether the given connection is currently valid, by running a query against it. If the query fails, the connection should probably be removed from the connection pool.



252
253
254
255
256
257
258
259
260
261
# File 'lib/sequel/database/connecting.rb', line 252

def valid_connection?(conn)
  sql = valid_connection_sql
  begin
    log_connection_execute(conn, sql)
  rescue Sequel::DatabaseError, *database_error_classes
    false
  else
    true
  end
end