Class: Sequel::Amalgalite::Database

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

Overview

Database class for SQLite databases used with Sequel and the amalgalite driver.

Constant Summary

Constant Summary

Constants included from SQLite::DatabaseMethods

SQLite::DatabaseMethods::AUTO_VACUUM, SQLite::DatabaseMethods::PRIMARY_KEY_INDEX_RE, SQLite::DatabaseMethods::SYNCHRONOUS, SQLite::DatabaseMethods::TABLES_FILTER, SQLite::DatabaseMethods::TEMP_STORE, SQLite::DatabaseMethods::TRANSACTION_MODE, SQLite::DatabaseMethods::VIEWS_FILTER

Constants inherited from Database

Database::ADAPTERS, Database::AUTOINCREMENT, Database::COLUMN_DEFINITION_ORDER, Database::COLUMN_SCHEMA_DATETIME_TYPES, Database::COLUMN_SCHEMA_STRING_TYPES, Database::COMBINABLE_ALTER_TABLE_OPS, Database::COMMA_SEPARATOR, Database::CURRENT_TIMESTAMP_RE, Database::DEFAULT_DATABASE_ERROR_REGEXPS, Database::DEFAULT_JOIN_TABLE_COLUMN_OPTIONS, Database::DEFAULT_STRING_COLUMN_SIZE, Database::DatasetClass, Database::EXTENSIONS, Database::NOT_NULL, Database::NULL, Database::OPTS, Database::PRIMARY_KEY, Database::SCHEMA_TYPE_CLASSES, 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 included from SQLite::DatabaseMethods

#integer_booleans, #transaction_mode, #use_timestamp_timezones

Attributes inherited from Database

#cache_schema, #dataset_class, #default_string_column_size, #identifier_input_method, #identifier_output_method, #log_warn_duration, #loggers, #opts, #pool, #prepared_statements, #sql_log_level, #timezone, #transaction_isolation_level

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from SQLite::DatabaseMethods

#auto_vacuum, #auto_vacuum=, #case_sensitive_like=, #foreign_key_list, #foreign_keys, #foreign_keys=, #indexes, #pragma_get, #pragma_set, #set_integer_booleans, #sqlite_version, #supports_create_table_if_not_exists?, #supports_deferrable_foreign_key_constraints?, #supports_partial_indexes?, #supports_savepoints?, #synchronous, #synchronous=, #tables, #temp_store, #temp_store=, #use_timestamp_timezones?, #views

Methods included from Database::ResetIdentifierMangling

#extended

Methods inherited from Database

#<<, #[], adapter_class, adapter_scheme, #adapter_scheme, #add_column, #add_index, #add_servers, #after_commit, after_initialize, #after_rollback, #alter_table, #alter_table_generator, #call, #cast_type_literal, connect, #create_join_table, #create_join_table!, #create_join_table?, #create_or_replace_view, #create_table, #create_table!, #create_table?, #create_table_generator, #create_view, #dataset, #disconnect, #disconnect_connection, #drop_column, #drop_index, #drop_join_table, #drop_table, #drop_table?, #drop_view, #each_server, #extend_datasets, extension, #extension, #fetch, #from, #from_application_timestamp, #get, #global_index_namespace?, #in_transaction?, #initialize, #inspect, #literal, #log_exception, #log_info, #log_yield, #logger=, #prepared_statement, #quote_identifier, #quote_identifiers=, #quote_identifiers?, register_extension, #remove_servers, #rename_column, #rename_table, #run, run_after_initialize, #schema, #schema_type_class, #select, #serial_primary_key_options, #servers, set_adapter_scheme, #set_column_default, #set_column_type, #set_prepared_statement, #single_threaded?, #supports_create_table_if_not_exists?, #supports_deferrable_constraints?, #supports_deferrable_foreign_key_constraints?, #supports_drop_table_if_exists?, #supports_foreign_key_parsing?, #supports_index_parsing?, #supports_partial_indexes?, #supports_prepared_transactions?, #supports_savepoints?, #supports_savepoints_in_prepared_transactions?, #supports_schema_parsing?, #supports_table_listing?, #supports_transaction_isolation_levels?, #supports_transactional_ddl?, #supports_view_listing?, #synchronize, #table_exists?, #test_connection, #to_application_timestamp, #transaction, #typecast_value, #uri, #url, #valid_connection?

Constructor Details

This class inherits a constructor from Sequel::Database

Class Method Details

+ (Object) uri_to_options(uri)

Mimic the file:// uri, by having 2 preceding slashes specify a relative path, and 3 preceding slashes specify an absolute path.



67
68
69
# File 'lib/sequel/adapters/amalgalite.rb', line 67

def self.uri_to_options(uri) # :nodoc:
  { :database => (uri.host.nil? && uri.path == '/') ? nil : "#{uri.host}#{uri.path}" }
end

Instance Method Details

- (Object) connect(server)

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).



76
77
78
79
80
81
82
83
84
# File 'lib/sequel/adapters/amalgalite.rb', line 76

def connect(server)
  opts = server_opts(server)
  opts[:database] = ':memory:' if blank_object?(opts[:database])
  db = ::Amalgalite::Database.new(opts[:database])
  db.busy_handler(::Amalgalite::BusyTimeout.new(opts.fetch(:timeout, 5000)/50, 50))
  db.type_map = SequelTypeMap.new(self)
  connection_pragmas.each{|s| log_yield(s){db.execute_batch(s)}}
  db
end

- (Object) database_type

Amalgalite is just the SQLite database without a separate SQLite installation.



87
88
89
# File 'lib/sequel/adapters/amalgalite.rb', line 87

def database_type
  :sqlite
end

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

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



108
109
110
111
112
113
114
115
116
# File 'lib/sequel/adapters/amalgalite.rb', line 108

def execute(sql, opts=OPTS)
  _execute(sql, opts) do |conn|
    begin
      yield(stmt = log_yield(sql){conn.prepare(sql)})
    ensure
      stmt.close if stmt
    end
  end
end

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

Run the given SQL with the given arguments. Returns nil.



92
93
94
95
# File 'lib/sequel/adapters/amalgalite.rb', line 92

def execute_ddl(sql, opts=OPTS)
  _execute(sql, opts){|conn| log_yield(sql){conn.execute_batch(sql)}}
  nil
end

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

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



98
99
100
# File 'lib/sequel/adapters/amalgalite.rb', line 98

def execute_dui(sql, opts=OPTS)
  _execute(sql, opts){|conn| log_yield(sql){conn.execute_batch(sql)}; conn.row_changes}
end

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

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



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

def execute_insert(sql, opts=OPTS)
  _execute(sql, opts){|conn| log_yield(sql){conn.execute_batch(sql)}; conn.last_insert_rowid}
end

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

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



119
120
121
# File 'lib/sequel/adapters/amalgalite.rb', line 119

def single_value(sql, opts=OPTS)
  _execute(sql, opts){|conn| log_yield(sql){conn.first_value_from(sql)}}
end