Class: ActiveRecord::ConnectionAdapters::SQLite3Adapter
| Relationships & Source Files | |
| Super Chains via Extension / Inclusion / Inheritance | |
|
Class Chain:
|
|
|
Instance Chain:
|
|
| Inherits: |
ActiveRecord::ConnectionAdapters::AbstractAdapter
|
| Defined in: | activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb |
Overview
The SQLite3 adapter works with the sqlite3-ruby drivers (available as gem from rubygems.org/gems/sqlite3).
Options:
-
:database- Path to the database file.
Constant Summary
-
ADAPTER_NAME =
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 58"SQLite" -
COLLATE_REGEX =
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 485/.*\"(\w)\".*collate\s\"(\w+)\".*/i.freeze
-
NATIVE_DATABASE_TYPES =
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 64{ primary_key: "integer PRIMARY KEY AUTOINCREMENT NOT NULL", string: { name: "varchar" }, text: { name: "text" }, integer: { name: "integer" }, float: { name: "float" }, decimal: { name: "decimal" }, datetime: { name: "datetime" }, time: { name: "time" }, date: { name: "date" }, binary: { name: "blob" }, boolean: { name: "boolean" }, json: { name: "json" }, }
::ActiveSupport::Callbacks - Included
DatabaseStatements - Included
DEFAULT_INSERT_VALUE
Quoting - Included
COLUMN_NAME, COLUMN_NAME_WITH_ORDER
AbstractAdapter - Inherited
Class Attribute Summary
AbstractAdapter - Inherited
Class Method Summary
- .database_exists?(config) ⇒ Boolean
- .new(connection, logger, connection_options, config) ⇒ SQLite3Adapter constructor
AbstractAdapter - Inherited
| .database_exists? | Does the database for this adapter exist? |
| .type_cast_config_to_boolean, .type_cast_config_to_integer | |
::ActiveSupport::DescendantsTracker - Inherited
| clear, descendants, direct_descendants, | |
| store_inherited | This is the only method that is not thread safe, but is only ever called during the eager loading phase. |
| subclasses | |
Instance Attribute Summary
- #active? ⇒ Boolean readonly
- #requires_reloading? ⇒ Boolean readonly
- #supports_check_constraints? ⇒ Boolean readonly
- #supports_common_table_expressions? ⇒ Boolean readonly
- #supports_datetime_with_precision? ⇒ Boolean readonly
- #supports_ddl_transactions? ⇒ Boolean readonly
- #supports_explain? ⇒ Boolean readonly
- #supports_expression_index? ⇒ Boolean readonly
- #supports_foreign_keys? ⇒ Boolean readonly
- #supports_index_sort_order? ⇒ Boolean readonly
-
#supports_insert_conflict_target?
readonly
Alias for #supports_insert_on_conflict?.
- #supports_insert_on_conflict? ⇒ Boolean (also: #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_insert_conflict_target?) readonly
-
#supports_insert_on_duplicate_skip?
readonly
Alias for #supports_insert_on_conflict?.
-
#supports_insert_on_duplicate_update?
readonly
Alias for #supports_insert_on_conflict?.
- #supports_json? ⇒ Boolean readonly
- #supports_lazy_transactions? ⇒ Boolean readonly
- #supports_partial_index? ⇒ Boolean readonly
- #supports_savepoints? ⇒ Boolean readonly
- #supports_transaction_isolation? ⇒ Boolean readonly
- #supports_views? ⇒ Boolean readonly
AbstractAdapter - Inherited
| #__callbacks, #__callbacks?, | |
| #active? | Checks whether the connection to the database is still active. |
| #in_use? | Alias for AbstractAdapter#owner. |
| #lock, #logger, #owner, #pool, | |
| #prepared_statements | Alias for AbstractAdapter#prepared_statements?. |
| #preventing_writes? | Determines whether writes are currently being prevented. |
| #replica?, | |
| #requires_reloading? | Returns true if its required to reload the connection between requests for development mode. |
| #schema_cache, #schema_cache=, | |
| #supports_advisory_locks? | Does this adapter support application-enforced advisory locking? |
| #supports_bulk_alter?, | |
| #supports_check_constraints? | Does this adapter support creating check constraints? |
| #supports_comments? | Does this adapter support metadata comments on database objects (tables, columns, indexes)? |
| #supports_comments_in_create? | Can comments for tables, columns, and indexes be specified in create/alter table statements? |
| #supports_common_table_expressions?, | |
| #supports_datetime_with_precision? | Does this adapter support datetime with precision? |
| #supports_ddl_transactions? | Does this adapter support DDL rollbacks in transactions? That is, would CREATE TABLE or ALTER TABLE get rolled back by a transaction? |
| #supports_explain? | Does this adapter support explain? |
| #supports_expression_index? | Does this adapter support expression indices? |
| #supports_extensions? | Does this adapter support database extensions? |
| #supports_foreign_keys? | Does this adapter support creating foreign key constraints? |
| #supports_foreign_tables? | Does this adapter support foreign/external tables? |
| #supports_index_sort_order? | Does this adapter support index sort order? |
| #supports_indexes_in_create? | Does this adapter support creating indexes in the same statement as creating the table? |
| #supports_insert_conflict_target?, #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_insert_returning?, | |
| #supports_json? | Does this adapter support json data type? |
| #supports_lazy_transactions?, | |
| #supports_materialized_views? | Does this adapter support materialized views? |
| #supports_optimizer_hints? | Does this adapter support optimizer hints? |
| #supports_partial_index? | Does this adapter support partial indices? |
| #supports_partitioned_indexes?, | |
| #supports_savepoints? | Does this adapter support savepoints? |
| #supports_transaction_isolation? | Does this adapter support setting the isolation level for a transaction? |
| #supports_validate_constraints? | Does this adapter support creating invalid constraints? |
| #supports_views? | Does this adapter support views? |
| #supports_virtual_columns? | Does this adapter support virtual columns? |
| #use_metadata_table?, #visitor | |
DatabaseStatements - Included
Instance Method Summary
-
#add_belongs_to(table_name, ref_name, **options)
Alias for #add_reference.
-
#disconnect!
Disconnects from the database if already connected.
-
#encoding
Returns the current database encoding format as a string, eg: ‘UTF-8’.
- #foreign_keys(table_name)
- #reconnect!
-
#rename_table(table_name, new_name)
Renames a table.
SQLite3::DatabaseStatements - Included
| #begin_isolated_db_transaction |
|
| #exec_delete, #exec_query, | |
| #exec_update | Alias for SQLite3::DatabaseStatements#exec_delete. |
| #explain | |
AbstractAdapter - Inherited
| #adapter_name | Returns the human-readable name of the adapter. |
| #clear_cache! | Clear any caching the database adapter may be doing. |
| #close | Check the connection back in to the connection pool. |
| #disable_extension | This is meant to be implemented by the adapters that support extensions. |
| #disable_referential_integrity | Override to turn off referential integrity while executing |
| #discard! | Immediately forget this connection ever existed. |
| #disconnect! | Disconnects from the database if already connected. |
| #enable_extension | This is meant to be implemented by the adapters that support extensions. |
| #expire | this method must only be called while holding connection pool’s mutex. |
| #extensions | A list of extensions, to be filled in by adapters that support them. |
| #index_algorithms | A list of index algorithms, to be filled by adapters that support them. |
| #lease | this method must only be called while holding connection pool’s mutex. |
| #prefetch_primary_key? | Should primary key values be selected from their corresponding sequence before the insert statement? If true, next_sequence_value is called before each insert to set the record’s primary key. |
| #prepared_statements?, | |
| #raw_connection | Provides access to the underlying database driver for this adapter. |
| #reconnect! | Disconnects from the database if already connected, and establishes a new connection with the database. |
| #reset! | Reset the state of this connection, directing the DBMS to clear transactions and other connection-related server-side state. |
| #throw_away! | Removes the connection from the pool and disconnect it. |
| #unprepared_statement, | |
| #verify! | Checks whether the connection to the database is still active (i.e. not stale). |
| #log | |
Savepoints - Included
DatabaseLimits - Included
| #allowed_index_name_length | Returns the maximum allowed length for an index name. |
| #in_clause_length | Returns the maximum number of elements in an IN (x,y,z) clause. |
| #index_name_length | Returns the maximum length of an index name. |
| #table_alias_length | Returns the maximum length of a table alias. |
Quoting - Included
| #quote | Quotes the column value to help prevent SQL injection attacks. |
| #quote_column_name | Quotes the column name. |
| #quote_string | Quotes a string, escaping any ‘ (single quote) and \ (backslash) characters. |
| #quote_table_name | Quotes the table name. |
| #quote_table_name_for_assignment | Override to return the quoted table name for assignment. |
| #quoted_date | Quote date/time values for use in SQL input. |
| #quoted_false, #quoted_true, | |
| #type_cast | Cast a |
| #unquoted_false, #unquoted_true | |
DatabaseStatements - Included
| #add_transaction_record | Register a record with the current transaction so that its after_commit and after_rollback callbacks can be called. |
| #begin_db_transaction | Begins the transaction (and turns off auto-committing). |
| #begin_isolated_db_transaction | Begins the transaction with the isolation level set. |
| #commit_db_transaction | Commits the transaction (and turns on auto-committing). |
| #create | Alias for DatabaseStatements#insert. |
| #default_sequence_name, | |
| #delete | Executes the delete statement and returns the number of rows affected. |
| #disable_lazy_transactions!, #empty_insert_statement_value, #enable_lazy_transactions!, | |
| #exec_delete | Executes delete |
| #exec_insert | Executes insert |
| #exec_query | Executes |
| #exec_update | Executes update |
| #execute | Executes the SQL statement in the context of this connection and returns the raw result from the connection adapter. |
| #initialize, | |
| #insert | Executes an INSERT query and returns the new record’s ID. |
| #insert_fixture | Inserts the given fixture into the table. |
| #insert_fixtures_set, | |
| #reset_sequence! | Set the sequence to the max value of the table’s column. |
| #rollback_db_transaction | Rolls back the transaction (and turns on auto-committing). |
| #rollback_to_savepoint, | |
| #sanitize_limit | Sanitizes the given LIMIT parameter in order to prevent SQL injection. |
| #select_all | Returns an |
| #select_one | Returns a record hash with the column names as keys and column values as values. |
| #select_rows | Returns an array of arrays containing the field values. |
| #select_value | Returns a single value from a record. |
| #select_values | Returns an array of the values of the first column in a select: |
| #to_sql | Converts an arel AST to SQL. |
| #transaction | Runs the given block in a database transaction, and returns the result of the block. |
| #transaction_isolation_levels, | |
| #truncate | Executes the truncate statement. |
| #update | Executes the update statement and returns the number of rows affected. |
| #write_query? | Determines whether the SQL statement is a write query. |
SchemaStatements - Included
| #add_belongs_to | Alias for SchemaStatements#add_reference. |
| #add_check_constraint | Adds a new check constraint to the table. |
| #add_column | Add a new |
| #add_foreign_key | Adds a new foreign key. |
| #add_index | Adds a new index to the table. |
| #add_reference | Adds a reference. |
| #add_timestamps | Adds timestamps ( |
| #assume_migrated_upto_version, | |
| #change_column | Changes the column’s definition according to the new options. |
| #change_column_comment | Changes the comment for a column or removes it if |
| #change_column_default | Sets a new default value for a column: |
| #change_column_null | Sets or removes a |
| #change_table | A block for changing columns in |
| #change_table_comment | Changes the comment for a table or removes it if |
| #check_constraints | Returns an array of check constraints for the given table. |
| #column_exists? | Checks to see if a column exists in a given table. |
| #columns | Returns an array of |
| #create_join_table | Creates a new join table with the name created using the lexical order of the first two arguments. |
| #create_table | Creates a new table with the name |
| #data_source_exists? | Checks to see if the data source |
| #data_sources | Returns the relation names useable to back Active Record models. |
| #drop_join_table | Drops the join table specified by the given arguments. |
| #drop_table | Drops a table from the database. |
| #foreign_key_exists? | Checks to see if a foreign key exists on a table for a given foreign key definition. |
| #foreign_keys | Returns an array of foreign keys for the given table. |
| #index_exists? | Checks to see if an index exists on a table for a given index definition. |
| #index_name_exists? | Verifies the existence of an index with a given name. |
| #indexes | Returns an array of indexes for the given table. |
| #native_database_types | Returns a hash of mappings from the abstract data types to the native database types. |
| #options_include_default?, | |
| #primary_key | Returns just a table’s primary key. |
| #remove_belongs_to | Alias for SchemaStatements#remove_reference. |
| #remove_check_constraint | Removes the given check constraint from the table. |
| #remove_column | Removes the column from the table definition. |
| #remove_columns | Removes the given columns from the table definition. |
| #remove_foreign_key | Removes the given foreign key from the table. |
| #remove_index | Removes the given index from the table. |
| #remove_reference | Removes the reference(s). |
| #remove_timestamps | Removes the timestamp columns ( |
| #rename_column | Renames a column. |
| #rename_index | Renames an index. |
| #rename_table | Renames a table. |
| #table_alias_for | Truncates a table alias according to the limits of the current adapter. |
| #table_comment | Returns the table comment that’s stored in database metadata. |
| #table_exists? | Checks to see if the table |
| #table_options, | |
| #tables | Returns an array of table names defined in the database. |
| #view_exists? | Checks to see if the view |
| #views | Returns an array of view names defined in the database. |
::ActiveSupport::Callbacks - Included
| #run_callbacks | Runs the callbacks for the given event. |
Constructor Details
.new(connection, logger, connection_options, config) ⇒ SQLite3Adapter
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 86
def initialize(connection, logger, , config) super(connection, logger, config) configure_connection end
Class Method Details
.database_exists?(config) ⇒ Boolean
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 91
def self.database_exists?(config) config = config.symbolize_keys if config[:database] == ":memory:" true else database_file = defined?(Rails.root) ? File.(config[:database], Rails.root) : config[:database] File.exist?(database_file) end end
Instance Attribute Details
#active? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 156
def active? !@connection.closed? end
#requires_reloading? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 121
def requires_reloading? true end
#supports_check_constraints? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 129
def supports_check_constraints? true end
#supports_common_table_expressions? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 145
def supports_common_table_expressions? database_version >= "3.8.3" end
#supports_datetime_with_precision? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 137
def supports_datetime_with_precision? true end
#supports_ddl_transactions? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 101
def supports_ddl_transactions? true end
#supports_explain? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 185
def supports_explain? true end
#supports_expression_index? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 117
def supports_expression_index? database_version >= "3.9.0" end
#supports_foreign_keys? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 125
def supports_foreign_keys? true end
#supports_index_sort_order? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 172
def supports_index_sort_order? true end
#supports_insert_conflict_target? (readonly)
Alias for #supports_insert_on_conflict?.
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 154
alias supports_insert_conflict_target? supports_insert_on_conflict?
#supports_insert_on_conflict? ⇒ Boolean (readonly)
Also known as: #supports_insert_on_duplicate_skip?, #supports_insert_on_duplicate_update?, #supports_insert_conflict_target?
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 149
def supports_insert_on_conflict? database_version >= "3.24.0" end
#supports_insert_on_duplicate_skip? (readonly)
Alias for #supports_insert_on_conflict?.
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 152
alias supports_insert_on_duplicate_skip? supports_insert_on_conflict?
#supports_insert_on_duplicate_update? (readonly)
Alias for #supports_insert_on_conflict?.
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 153
alias supports_insert_on_duplicate_update? supports_insert_on_conflict?
#supports_json? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 141
def supports_json? true end
#supports_lazy_transactions? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 189
def supports_lazy_transactions? true end
#supports_partial_index? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 113
def supports_partial_index? true end
#supports_savepoints? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 105
def supports_savepoints? true end
#supports_transaction_isolation? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 109
def supports_transaction_isolation? true end
#supports_views? ⇒ Boolean (readonly)
[ GitHub ]
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 133
def supports_views? true end
Instance Method Details
#add_belongs_to(table_name, ref_name, **options)
Alias for #add_reference.
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 289
alias :add_belongs_to :add_reference
#disconnect!
Disconnects from the database if already connected. Otherwise, this method does nothing.
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 167
def disconnect! super @connection.close rescue nil end
#encoding
Returns the current database encoding format as a string, eg: ‘UTF-8’
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 181
def encoding @connection.encoding.to_s end
#foreign_keys(table_name)
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 291
def foreign_keys(table_name) fk_info = exec_query("PRAGMA foreign_key_list(#{quote(table_name)})", "SCHEMA") fk_info.map do |row| = { column: row["from"], primary_key: row["to"], on_delete: extract_foreign_key_action(row["on_delete"]), on_update: extract_foreign_key_action(row["on_update"]) } ForeignKeyDefinition.new(table_name, row["table"], ) end end
#reconnect!
[ GitHub ]# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 160
def reconnect! super connect if @connection.closed? end
#rename_table(table_name, new_name)
Renames a table.
Example:
rename_table('octopuses', 'octopi')
# File 'activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb', line 228
def rename_table(table_name, new_name) schema_cache.clear_data_source_cache!(table_name.to_s) schema_cache.clear_data_source_cache!(new_name.to_s) exec_query "ALTER TABLE #{quote_table_name(table_name)} RENAME TO #{quote_table_name(new_name)}" rename_table_indexes(table_name, new_name) end