The SQLite adapter works with both the 2.x and 3.x series of SQLite with the sqlite-ruby drivers (available both as gems and from rubyforge.org/projects/sqlite-ruby/).

Options:

  • :database - Path to the database file.
Methods
C
D
E
L
N
R
S
T
V
Classes and Modules
Class Public methods
new(connection, logger, config)

Source: show | on GitHub 

    # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 77
77:       def initialize(connection, logger, config)
78:         super(connection, logger)
79:         @statements = StatementPool.new(@connection,
80:                                         config.fetch(:statement_limit) { 1000 })
81:         @config = config
82: 
83:         if config.fetch(:prepared_statements) { true }
84:           @visitor = Arel::Visitors::SQLite.new self
85:         else
86:           @visitor = BindSubstitution.new self
87:         end
88:       end
Instance Public methods
change_column_null(table_name, column_name, null, default = nil)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 432
432:       def change_column_null(table_name, column_name, null, default = nil)
433:         unless null || default.nil?
434:           exec_query("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL")
435:         end
436:         alter_table(table_name) do |definition|
437:           definition[column_name].null = null
438:         end
439:       end
clear_cache!()

Clears the prepared statements cache.

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 143
143:       def clear_cache!
144:         @statements.clear
145:       end
create_savepoint()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 301
301:       def create_savepoint
302:         execute("SAVEPOINT #{current_savepoint_name}")
303:       end
disconnect!()

Disconnects from the database if already connected. Otherwise, this method does nothing.

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 136
136:       def disconnect!
137:         super
138:         clear_cache!
139:         @connection.close rescue nil
140:       end
empty_insert_statement_value()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 462
462:       def empty_insert_statement_value
463:         "VALUES(NULL)"
464:       end
exec_delete(sql, name = 'SQL', binds = [])
This method is also aliased as exec_update

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 267
267:       def exec_delete(sql, name = 'SQL', binds = [])
268:         exec_query(sql, name, binds)
269:         @connection.changes
270:       end
exec_query(sql, name = nil, binds = [])

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 241
241:       def exec_query(sql, name = nil, binds = [])
242:         log(sql, name, binds) do
243: 
244:           # Don't cache statements without bind values
245:           if binds.empty?
246:             stmt    = @connection.prepare(sql)
247:             cols    = stmt.columns
248:             records = stmt.to_a
249:             stmt.close
250:             stmt = records
251:           else
252:             cache = @statements[sql] ||= {
253:               :stmt => @connection.prepare(sql)
254:             }
255:             stmt = cache[:stmt]
256:             cols = cache[:cols] ||= stmt.columns
257:             stmt.reset!
258:             stmt.bind_params binds.map { |col, val|
259:               type_cast(val, col)
260:             }
261:           end
262: 
263:           ActiveRecord::Result.new(cols, stmt.to_a)
264:         end
265:       end
exec_update(sql, name = 'SQL', binds = [])

Alias for exec_delete

explain(arel, binds = [])

DATABASE STATEMENTS ======================================

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 222
222:       def explain(arel, binds = [])
223:         sql = "EXPLAIN QUERY PLAN #{to_sql(arel, binds)}"
224:         ExplainPrettyPrinter.new.pp(exec_query(sql, 'EXPLAIN', binds))
225:       end
last_inserted_id(result)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 273
273:       def last_inserted_id(result)
274:         @connection.last_insert_row_id
275:       end
release_savepoint()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 309
309:       def release_savepoint
310:         execute("RELEASE SAVEPOINT #{current_savepoint_name}")
311:       end
rename_table(name, new_name)

Renames a table.

Example: 

  rename_table('octopuses', 'octopi')

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 389
389:       def rename_table(name, new_name)
390:         exec_query "ALTER TABLE #{quote_table_name(name)} RENAME TO #{quote_table_name(new_name)}"
391:       end
requires_reloading?()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 125
125:       def requires_reloading?
126:         true
127:       end
rollback_to_savepoint()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 305
305:       def rollback_to_savepoint
306:         execute("ROLLBACK TO SAVEPOINT #{current_savepoint_name}")
307:       end
select_rows(sql, name = nil)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 297
297:       def select_rows(sql, name = nil)
298:         exec_query(sql, name).rows
299:       end
supports_add_column?()

Returns true if SQLite version is ‘3.1.6’ or greater, false otherwise.

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 130
130:       def supports_add_column?
131:         sqlite_version >= '3.1.6'
132:       end
supports_ddl_transactions?()

Returns true if SQLite version is ‘2.0.0’ or greater, false otherwise.

Source: show | on GitHub 

    # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 95
95:       def supports_ddl_transactions?
96:         sqlite_version >= '2.0.0'
97:       end
supports_explain?()

Returns true.

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 121
121:       def supports_explain?
122:         true
123:       end
supports_index_sort_order?()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 157
157:       def supports_index_sort_order?
158:         sqlite_version >= '3.3.0'
159:       end
supports_savepoints?()

Returns true if SQLite version is ‘3.6.8’ or greater, false otherwise.

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 100
100:       def supports_savepoints?
101:         sqlite_version >= '3.6.8'
102:       end
supports_statement_cache?()

Returns true, since this connection adapter supports prepared statement caching.

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 106
106:       def supports_statement_cache?
107:         true
108:       end
table_exists?(name)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 341
341:       def table_exists?(name)
342:         name && tables('SCHEMA', name).any?
343:       end
valid_alter_table_options( type, options)

See: www.sqlite.org/lang_altertable.html SQLite has an additional restriction on the ALTER TABLE statement

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 395
395:       def valid_alter_table_options( type, options)
396:         type.to_sym != :primary_key
397:       end
Instance Protected methods
default_primary_key_type()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 561
561:         def default_primary_key_type
562:           if supports_autoincrement?
563:             'INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL'
564:           else
565:             'INTEGER PRIMARY KEY NOT NULL'
566:           end
567:         end
sqlite_version()

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 557
557:         def sqlite_version
558:           @sqlite_version ||= SQLiteAdapter::Version.new(select_value('select sqlite_version(*)'))
559:         end
table_structure(table_name)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 471
471:         def table_structure(table_name)
472:           structure = exec_query("PRAGMA table_info(#{quote_table_name(table_name)})", 'SCHEMA').to_hash
473:           raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if structure.empty?
474:           structure
475:         end
translate_exception(exception, message)

Source: show | on GitHub 

     # File activerecord/lib/active_record/connection_adapters/sqlite_adapter.rb, line 569
569:         def translate_exception(exception, message)
570:           case exception.message
571:           when /column(s)? .* (is|are) not unique/
572:             RecordNotUnique.new(message, exception)
573:           else
574:             super
575:           end
576:         end