Class: Sequel::SQLite::Database

Inherits:
Database show all
Includes:
DatabaseMethods
Defined in:
lib/sequel/adapters/sqlite.rb

Overview

Database class for SQLite databases used with Sequel and the ruby-sqlite3 driver.

Constant Summary collapse

UNIX_EPOCH_TIME_FORMAT = 
/\A\d+\z/.freeze

Constants included from DatabaseMethods

Sequel::SQLite::DatabaseMethods::AUTO_VACUUM, Sequel::SQLite::DatabaseMethods::PRIMARY_KEY_INDEX_RE, Sequel::SQLite::DatabaseMethods::SYNCHRONOUS, Sequel::SQLite::DatabaseMethods::TABLES_FILTER, Sequel::SQLite::DatabaseMethods::TEMP_STORE

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_ISOLATION_LEVELS, Database::TRANSACTION_ROLLBACK, Database::UNDERSCORE, Database::UNIQUE, Database::UNSIGNED

Instance Attribute Summary

Attributes inherited from Database

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

Instance Method Summary collapse

Methods included from DatabaseMethods

#alter_table, #auto_vacuum, #auto_vacuum=, #database_type, #foreign_keys, #foreign_keys=, #indexes, #pragma_get, #pragma_set, #sqlite_version, #supports_savepoints?, #synchronous, #synchronous=, #tables, #temp_store, #temp_store=

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, #database_type, #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=, #indexes, #initialize, #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_prepared_transactions?, #supports_savepoints?, #supports_transaction_isolation_levels?, #synchronize, #table_exists?, #tables, #test_connection, #transaction, #typecast_value, #uri, #url

Methods included from Metaprogramming

#meta_def

Constructor Details

This class inherits a constructor from Sequel::Database

Instance Method Details

#connect(server) ⇒ Object

Connect to the database. Since SQLite is a file based database, the only options available are :database (to specify the database name), and :timeout, to specify how long to wait for the database to be available if it is locked, given in milliseconds (default is 5000).



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/sequel/adapters/sqlite.rb', line 33

def connect(server)
  opts = server_opts(server)
  opts[:database] = ':memory:' if blank_object?(opts[:database])
  db = ::SQLite3::Database.new(opts[:database])
  db.busy_timeout(opts.fetch(:timeout, 5000))
  db.type_translation = true
  
  connection_pragmas.each{|s| log_yield(s){db.execute_batch(s)}}
  
  # Handle datetimes with Sequel.datetime_class
  prok = proc do |t,v|
    v = Time.at(v.to_i).iso8601 if UNIX_EPOCH_TIME_FORMAT.match(v)
    Sequel.database_to_application_timestamp(v)
  end
  db.translator.add_translator("timestamp", &prok)
  db.translator.add_translator("datetime", &prok)
  
  # Handle numeric values with BigDecimal
  prok = proc{|t,v| BigDecimal.new(v) rescue v}
  db.translator.add_translator("numeric", &prok)
  db.translator.add_translator("decimal", &prok)
  db.translator.add_translator("money", &prok)
  
  # Handle floating point values with Float
  prok = proc{|t,v| Float(v) rescue v}
  db.translator.add_translator("float", &prok)
  db.translator.add_translator("real", &prok)
  db.translator.add_translator("double precision", &prok)
  
  # Handle blob values with Sequel::SQL::Blob
  db.translator.add_translator("blob"){|t,v| ::Sequel::SQL::Blob.new(v)}

  class << db
    attr_reader :prepared_statements
  end
  db.instance_variable_set(:@prepared_statements, {})
  
  db
end

#dataset(opts = nil) ⇒ Object

Return instance of Sequel::SQLite::Dataset with the given options.



74
75
76
 
# File 'lib/sequel/adapters/sqlite.rb', line 74

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

#execute(sql, opts = {}, &block) ⇒ Object

Run the given SQL with the given arguments and yield each row.



79
80
81
 
# File 'lib/sequel/adapters/sqlite.rb', line 79

def execute(sql, opts={}, &block)
  _execute(:select, sql, opts, &block)
end

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

Drop any prepared statements on the connection when executing DDL. This is because prepared statements lock the table in such a way that you can’t drop or alter the table while a prepared statement that references it still exists.



91
92
93
94
95
96
97
 
# File 'lib/sequel/adapters/sqlite.rb', line 91

def execute_ddl(sql, opts={})
  synchronize(opts[:server]) do |conn|
    conn.prepared_statements.values.each{|cps, s| cps.close}
    conn.prepared_statements.clear
    super
  end
end

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

Run the given SQL with the given arguments and return the number of changed rows.



84
85
86
 
# File 'lib/sequel/adapters/sqlite.rb', line 84

def execute_dui(sql, opts={})
  _execute(:update, sql, opts)
end

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

Run the given SQL with the given arguments and return the last inserted row id.



100
101
102
 
# File 'lib/sequel/adapters/sqlite.rb', line 100

def execute_insert(sql, opts={})
  _execute(:insert, sql, opts)
end

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

Run the given SQL with the given arguments and return the first value of the first row.



105
106
107
 
# File 'lib/sequel/adapters/sqlite.rb', line 105

def single_value(sql, opts={})
  _execute(:single_value, sql, opts)
end