Module: DBI

Classes and Modules

Module DBI::SQL
Module DBI::Type
Module DBI::Utils
Class DBI::BaseDatabase
Class DBI::BaseDriver
Class DBI::BaseStatement
Class DBI::Binary
Class DBI::ColumnInfo
Class DBI::DataError
Class DBI::DatabaseError
Class DBI::DatabaseHandle
Class DBI::Date
Class DBI::DriverHandle
Class DBI::Error
Class DBI::Handle
Class DBI::HandleTracer
Class DBI::IntegrityError
Class DBI::InterfaceError
Class DBI::InternalError
Class DBI::NotImplementedError
Class DBI::NotSupportedError
Class DBI::OperationalError
Class DBI::ProgrammingError
Class DBI::Row
Class DBI::StatementHandle
Class DBI::Time
Class DBI::Timestamp
Class DBI::TypeUtil
Class DBI::Warning

Constants

 "0.4.3"
 Module functions (of DBI)
 STDERR
 Constants for fetch_scroll
 SQL_FETCH_PRIOR
 SQL_FETCH_FIRST
 SQL_FETCH_LAST
 SQL_FETCH_ABSOLUTE
 SQL_FETCH_RELATIVE
 SQL type constants
 SQL_NUMERIC
 SQL_DECIMAL
 SQL_INTEGER
 SQL_SMALLINT
 SQL_FLOAT
 SQL_REAL
 SQL_DOUBLE
 SQL_DATE
 SQL_TIME
 SQL_TIMESTAMP
 SQL_VARCHAR
 SQL_BOOLEAN
 -1
 -2
 -3
 -4
 -5
 -6
 -7
  TODO
 Find types for these (XOPEN?)


SQL_ARRAY =
 -11
 SQL_DISTINCT = SQL_OBJECT = SQL_NULL =
 SQL_REF = SQL_STRUCT =

Public Class methods

available_drivers()

Returns a list (of String) of the currently available drivers on your system in ‘dbi:driver:’ format.

This currently does not work for rubygems installations, please see DBI.collect_drivers for reasons.

[Source]

     # File lib/dbi.rb, line 203
203:         def available_drivers
204:             drivers = []
205:             collect_drivers.each do |key, value|
206:                 drivers.push("dbi:#{key}:")
207:             end 
208:             return drivers
209:         end

collect_drivers()

Return a list (of String) of the available drivers.

NOTE:

This is non-functional for gem installations, due to the nature of how it currently works. A better solution for this will be provided in DBI 0.6.0.

[Source]

     # File lib/dbi.rb, line 184
184:         def collect_drivers
185:             drivers = { }
186:             # FIXME rewrite this to leverage require and be more intelligent
187:             path = File.join(File.dirname(__FILE__), "dbd", "*.rb")
188:             Dir[path].each do |f|
189:                 if File.file?(f)
190:                     driver = File.basename(f, ".rb")
191:                     drivers[driver] = f
192:                 end
193:             end
194: 
195:             return drivers
196:         end

connect(driver_url, user=nil, auth=nil, params=nil, &p)

Establish a database connection.

Format goes as such: "dbi:Driver:database_conn_args"

"dbi" is the literal string "dbi". Case is unimportant.
"Driver" is the case-dependent name of your database driver class. The file "dbd/#{Driver}" will be required. If you are using rubygems to control your DBDs and DBI, you must make the gem‘s file path available via the "gem" command before this will work.
database_conn_args can be:
- The database name.
- A more complex key/value association (to indicate host, etc). This is driver dependent; you should consult your DBD documentation.

[Source]

     # File lib/dbi.rb, line 144
144:         def connect(driver_url, user=nil, auth=nil, params=nil, &p)
145:             dr, db_args = _get_full_driver(driver_url)
146:             dh = dr[0] # driver-handle
147:             dh.convert_types = @@convert_types
148:             @@last_connection = dh.connect(db_args, user, auth, params, &p)
149:         end

convert_types()

Return the current status of type conversion at this level. This status will be propogated to any new DatabaseHandles created.

[Source]

     # File lib/dbi.rb, line 119
119:     def self.convert_types
120:         @@convert_types
121:     end

convert_types=(bool)

Set the current status of type conversion at this level. This status will be propogated to any new DatabaseHandles created.

[Source]

     # File lib/dbi.rb, line 125
125:     def self.convert_types=(bool)
126:         @@convert_types = bool
127:     end

data_sources(driver)

Attempt to collect the available data sources to the driver, specified in DBI.connect format.

The result is heavily dependent on the driver‘s ability to enumerate these sources, and results will vary.

[Source]

     # File lib/dbi.rb, line 216
216:         def data_sources(driver)
217:             db_driver, = parse_url(driver)
218:             db_driver = load_driver(db_driver)
219:             dh = @@driver_map[db_driver][0]
220:             dh.data_sources
221:         end

disconnect_all( driver = nil )

Attempt to disconnect all database handles. If a driver is provided, disconnections will happen under that scope. Otherwise, all loaded drivers (and their handles) will be attempted.

[Source]

     # File lib/dbi.rb, line 228
228:         def disconnect_all( driver = nil )
229:             if driver.nil?
230:                 @@driver_map.each {|k,v| v[0].disconnect_all}
231:             else
232:                 db_driver, = parse_url(driver)
233:                 @@driver_map[db_driver][0].disconnect_all
234:             end
235:         end

last_connection()

Return the last connection attempted.

[Source]

     # File lib/dbi.rb, line 113
113:     def self.last_connection
114:         @@last_connection
115:     end

trace(mode=nil, output=nil)

Enable tracing mode. Requires that ‘dbi/trace’ be required before it does anything.

As of 0.4.0, this mode does not do anything either way, so this currently just throws an InterfaceError. This issue is expected to be resolved in the next release.

[Source]

     # File lib/dbi.rb, line 171
171:         def trace(mode=nil, output=nil)
172:             # FIXME trace
173:             raise InterfaceError, "the trace module has been removed until it actually works."
174:             @@trace_mode   = mode   || @@trace_mode   || DBI::DEFAULT_TRACE_MODE
175:             @@trace_output = output || @@trace_output || DBI::DEFAULT_TRACE_OUTPUT
176:         end

Methods

Classes and Modules

Constants

Public Class methods