Class: Sequel::JDBC::Database

Inherits:
Database show all
Defined in:
lib/sequel/adapters/jdbc.rb,
lib/sequel/adapters/jdbc/mssql.rb

Overview

JDBC Databases offer a fairly uniform interface that does not change much based on the sub adapter.

Constant Summary

Constants inherited from Database

Database::ADAPTERS, Database::AUTOINCREMENT, Database::CASCADE, Database::COMMA_SEPARATOR, Database::MSSQL_DEFAULT_RE, Database::MYSQL_TIMESTAMP_RE, Database::NOT_NULL, Database::NO_ACTION, Database::NULL, Database::POSTGRES_DEFAULT_RE, Database::PRIMARY_KEY, Database::RESTRICT, Database::SET_DEFAULT, Database::SET_NULL, Database::SQL_BEGIN, Database::SQL_COMMIT, Database::SQL_RELEASE_SAVEPOINT, Database::SQL_ROLLBACK, Database::SQL_ROLLBACK_TO_SAVEPOINT, Database::SQL_SAVEPOINT, Database::STRING_DEFAULT_RE, Database::TEMPORARY, Database::TRANSACTION_BEGIN, Database::TRANSACTION_COMMIT, Database::TRANSACTION_ROLLBACK, Database::UNDERSCORE, Database::UNIQUE, Database::UNSIGNED

Instance Attribute Summary collapse

Attributes inherited from Database

#default_schema, #log_warn_duration, #loggers, #opts, #pool, #prepared_statements

Instance Method Summary collapse

Methods inherited from Database

#<<, #[], adapter_class, adapter_scheme, #add_column, #add_index, #add_servers, #alter_table, #call, #cast_type_literal, connect, #create_or_replace_view, #create_table, #create_table!, #create_table?, #create_view, #disconnect, #drop_column, #drop_index, #drop_table, #drop_view, #dump_indexes_migration, #dump_schema_migration, #dump_table_schema, #each_server, #fetch, #from, #get, #identifier_input_method, identifier_input_method, #identifier_input_method=, identifier_input_method=, #identifier_output_method, identifier_output_method, #identifier_output_method=, identifier_output_method=, #inspect, #literal, #log_info, #log_yield, #logger=, #query, #quote_identifiers=, quote_identifiers=, #quote_identifiers?, #remove_servers, #rename_column, #rename_table, #run, #schema, #select, #serial_primary_key_options, #servers, #set_column_default, #set_column_type, single_threaded=, #single_threaded?, #supports_savepoints?, #synchronize, #table_exists?, #test_connection, #transaction, #typecast_value, #url

Methods included from Metaprogramming

#meta_def

Constructor Details

#initialize(opts) ⇒ Database

Call the DATABASE_SETUP proc directly after initialization, so the object always uses sub adapter specific code. Also, raise an error immediately if the connection doesn’t have a uri, since JDBC requires one.

Raises:



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/sequel/adapters/jdbc.rb', line 114

def initialize(opts)
  super
  @convert_types = typecast_value_boolean(@opts.fetch(:convert_types, true))
  raise(Error, "No connection string specified") unless uri
  
  resolved_uri = jndi? ? get_uri_from_jndi : uri

  if match = /\Ajdbc:([^:]+)/.match(resolved_uri) and prok = DATABASE_SETUP[match[1].to_sym]
    prok.call(self)
  end        
end

Instance Attribute Details

#convert_types ⇒ Object

Whether to convert some Java types to ruby types when retrieving rows. True by default, can be set to false to roughly double performance when fetching rows.



108
109
110
 
# File 'lib/sequel/adapters/jdbc.rb', line 108

def convert_types
  @convert_types
end

#database_type ⇒ Object (readonly)

The type of database we are connecting to



103
104
105
 
# File 'lib/sequel/adapters/jdbc.rb', line 103

def database_type
  @database_type
end

Instance Method Details

#call_sproc(name, opts = {}) ⇒ Object

Execute the given stored procedure with the give name. If a block is given, the stored procedure should return rows.



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
 
# File 'lib/sequel/adapters/jdbc.rb', line 128

def call_sproc(name, opts = {})
  args = opts[:args] || []
  sql = "{call #{name}(#{args.map{'?'}.join(',')})}"
  synchronize(opts[:server]) do |conn|
    cps = conn.prepareCall(sql)

    i = 0
    args.each{|arg| set_ps_arg(cps, arg, i+=1)}

    begin
      if block_given?
        yield log_yield(sql){cps.executeQuery}
      else
        case opts[:type]
        when :insert
          log_yield(sql){cps.executeUpdate}
          last_insert_id(conn, opts)
        else
          log_yield(sql){cps.executeUpdate}
        end
      end
    rescue NativeException, JavaSQL::SQLException => e
      raise_error(e)
    ensure
      cps.close
    end
  end
end

#connect(server) ⇒ Object

Connect to the database using JavaSQL::DriverManager.getConnection.



158
159
160
161
162
163
164
165
166
167
 
# File 'lib/sequel/adapters/jdbc.rb', line 158

def connect(server)
  conn = if jndi?
    get_connection_from_jndi
  else
    args = [uri(server_opts(server))]
    args.concat([opts[:user], opts[:password]]) if opts[:user] && opts[:password]
    JavaSQL::DriverManager.getConnection(*args)
  end       
  setup_connection(conn)
end

#dataset(opts = nil) ⇒ Object

Return instances of JDBC::Dataset with the given opts.



170
171
172
 
# File 'lib/sequel/adapters/jdbc.rb', line 170

def dataset(opts = nil)
  JDBC::Dataset.new(self, opts)
end

#execute(sql, opts = {}, &block) ⇒ Object Also known as: execute_dui

Execute the given SQL. If a block is given, if should be a SELECT statement or something else that returns rows.



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/sequel/adapters/jdbc.rb', line 176

def execute(sql, opts={}, &block)
  return call_sproc(sql, opts, &block) if opts[:sproc]
  return execute_prepared_statement(sql, opts, &block) if [Symbol, Dataset].any?{|c| sql.is_a?(c)}
  synchronize(opts[:server]) do |conn|
    stmt = conn.createStatement
    begin
      if block_given?
        yield log_yield(sql){stmt.executeQuery(sql)}
      else
        case opts[:type]
        when :ddl
          log_yield(sql){stmt.execute(sql)}
        when :insert
          log_yield(sql) do
            if requires_return_generated_keys?
              stmt.executeUpdate(sql, JavaSQL::Statement.RETURN_GENERATED_KEYS)
            else
              stmt.executeUpdate(sql)
            end
          end
          last_insert_id(conn, opts.merge(:stmt=>stmt))
        else
          log_yield(sql){stmt.executeUpdate(sql)}
        end
      end
    rescue NativeException, JavaSQL::SQLException => e
      raise_error(e)
    ensure
      stmt.close
    end
  end
end

#execute_ddl(sql, opts = {}) ⇒ Object

Execute the given DDL SQL, which should not return any values or rows.



212
213
214
 
# File 'lib/sequel/adapters/jdbc.rb', line 212

def execute_ddl(sql, opts={})
  execute(sql, {:type=>:ddl}.merge(opts))
end

#execute_insert(sql, opts = {}) ⇒ Object

Execute the given INSERT SQL, returning the last inserted row id.



218
219
220
 
# File 'lib/sequel/adapters/jdbc.rb', line 218

def execute_insert(sql, opts={})
  execute(sql, {:type=>:insert}.merge(opts))
end

#indexes(table, opts = {}) ⇒ Object

Return a hash containing index information. Hash keys are index name symbols. Values are subhashes with two keys, :columns and :unique. The value of :columns is an array of symbols of column names. The value of :unique is true or false depending on if the index is unique.



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/sequel/adapters/jdbc.rb', line 226

def indexes(table, opts={})
  m = output_identifier_meth
  im = input_identifier_meth
  schema, table = schema_and_table(table)
  schema ||= opts[:schema]
  schema = im.call(schema) if schema
  table = im.call(table)
  indexes = {}
  metadata(:getIndexInfo, nil, schema, table, false, true) do |r|
    next unless name = r[:column_name]
    next if respond_to?(:primary_key_index_re, true) and r[:index_name] =~ primary_key_index_re 
    i = indexes[m.call(r[:index_name])] ||= {:columns=>[], :unique=>[false, 0].include?(r[:non_unique])}
    i[:columns] << m.call(name)
  end
  indexes
end

#jndi? ⇒ Boolean

Whether or not JNDI is being used for this connection.

Returns:

  • (Boolean) 


262
263
264
 
# File 'lib/sequel/adapters/jdbc.rb', line 262

def jndi?
  !!(uri =~ JNDI_URI_REGEXP)
end

#tables(opts = {}) ⇒ Object

All tables in this database



244
245
246
247
248
249
 
# File 'lib/sequel/adapters/jdbc.rb', line 244

def tables(opts={})
  ts = []
  m = output_identifier_meth
  metadata(:getTables, nil, nil, nil, ['TABLE'].to_java(:string)){|h| ts << m.call(h[:table_name])}
  ts
end

#uri(opts = {}) ⇒ Object

The uri for this connection. You can specify the uri using the :uri, :url, or :database options. You don’t need to worry about this if you use Sequel.connect with the JDBC connectrion strings.



255
256
257
258
259
 
# File 'lib/sequel/adapters/jdbc.rb', line 255

def uri(opts={})
  opts = @opts.merge(opts)
  ur = opts[:uri] || opts[:url] || opts[:database]
  ur =~ /^\Ajdbc:/ ? ur : "jdbc:#{ur}"
end