Module: ActiveRecord::ConnectionAdapters::SQLServer::SchemaStatements
- Included in:
- ActiveRecord::ConnectionAdapters::SQLServerAdapter
- Defined in:
- lib/active_record/connection_adapters/sqlserver/schema_statements.rb
Instance Method Summary collapse
- #change_column(table_name, column_name, type, options = {}) ⇒ Object
- #change_column_default(table_name, column_name, default_or_changes) ⇒ Object
- #change_column_null(table_name, column_name, allow_null, default = nil) ⇒ Object
- #columns(table_name) ⇒ Object
- #columns_for_distinct(columns, orders) ⇒ Object
- #create_schema_dumper(options) ⇒ Object
- #create_table(table_name, comment: nil, **options) ⇒ Object
- #drop_table(table_name, options = {}) ⇒ Object
- #extract_foreign_key_action(action, fk_name) ⇒ Object
- #foreign_keys(table_name) ⇒ Object
- #indexes(table_name) ⇒ Object
- #native_database_types ⇒ Object
- #new_column(name, default, sql_type_metadata, null, table_name, default_function = nil, collation = nil, comment = nil, sqlserver_options = {}) ⇒ Object
- #primary_keys(table_name) ⇒ Object
- #primary_keys_select(table_name) ⇒ Object
- #remove_column(table_name, column_name, type = nil, options = {}) ⇒ Object
- #remove_index!(table_name, index_name) ⇒ Object
- #rename_column(table_name, column_name, new_column_name) ⇒ Object
- #rename_index(table_name, old_name, new_name) ⇒ Object
- #rename_table(table_name, new_name) ⇒ Object
- #type_to_sql(type, limit: nil, precision: nil, scale: nil) ⇒ Object
- #update_table_definition(table_name, base) ⇒ Object
Instance Method Details
#change_column(table_name, column_name, type, options = {}) ⇒ Object
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 140 def change_column(table_name, column_name, type, = {}) sql_commands = [] indexes = [] column_object = schema_cache.columns(table_name).find { |c| c.name.to_s == column_name.to_s } without_constraints = .key?(:default) || .key?(:limit) default = if !.key?(:default) && column_object column_object.default else [:default] end if without_constraints || (column_object && column_object.type != type.to_sym) remove_default_constraint(table_name, column_name) indexes = indexes(table_name).select { |index| index.columns.include?(column_name.to_s) } remove_indexes(table_name, column_name) end sql_commands << "UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote_default_expression([:default], column_object)} WHERE #{quote_column_name(column_name)} IS NULL" if ![:null].nil? && [:null] == false && ![:default].nil? sql_commands << "ALTER TABLE #{quote_table_name(table_name)} ALTER COLUMN #{quote_column_name(column_name)} #{type_to_sql(type, limit: [:limit], precision: [:precision], scale: [:scale])}" sql_commands.last << ' NOT NULL' if ![:null].nil? && [:null] == false if without_constraints default = quote_default_expression(default, column_object || column_for(table_name, column_name)) sql_commands << "ALTER TABLE #{quote_table_name(table_name)} ADD CONSTRAINT #{default_constraint_name(table_name, column_name)} DEFAULT #{default} FOR #{quote_column_name(column_name)}" end # Add any removed indexes back indexes.each do |index| sql_commands << "CREATE INDEX #{quote_table_name(index.name)} ON #{quote_table_name(table_name)} (#{index.columns.map { |c| quote_column_name(c) }.join(', ')})" end sql_commands.each { |c| do_execute(c) } clear_cache! end |
#change_column_default(table_name, column_name, default_or_changes) ⇒ Object
170 171 172 173 174 175 176 177 178 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 170 def change_column_default(table_name, column_name, default_or_changes) clear_cache! column = column_for(table_name, column_name) return unless column remove_default_constraint(table_name, column_name) default = extract_new_default_value(default_or_changes) do_execute "ALTER TABLE #{quote_table_name(table_name)} ADD CONSTRAINT #{default_constraint_name(table_name, column_name)} DEFAULT #{quote_default_expression(default, column)} FOR #{quote_column_name(column_name)}" clear_cache! end |
#change_column_null(table_name, column_name, allow_null, default = nil) ⇒ Object
263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 263 def change_column_null(table_name, column_name, allow_null, default = nil) table_id = SQLServer::Utils.extract_identifiers(table_name) column_id = SQLServer::Utils.extract_identifiers(column_name) column = column_for(table_name, column_name) if !allow_null.nil? && allow_null == false && !default.nil? do_execute("UPDATE #{table_id} SET #{column_id}=#{quote(default)} WHERE #{column_id} IS NULL") end sql = "ALTER TABLE #{table_id} ALTER COLUMN #{column_id} #{type_to_sql column.type, limit: column.limit, precision: column.precision, scale: column.scale}" sql << ' NOT NULL' if !allow_null.nil? && allow_null == false do_execute sql end |
#columns(table_name) ⇒ Object
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 66 def columns(table_name) return [] if table_name.blank? column_definitions(table_name).map do |ci| = ci.slice :ordinal_position, :is_primary, :is_identity = ci[:type], new_column( ci[:name], ci[:default_value], , ci[:null], ci[:table_name], ci[:default_function], ci[:collation], nil, ) end end |
#columns_for_distinct(columns, orders) ⇒ Object
249 250 251 252 253 254 255 256 257 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 249 def columns_for_distinct(columns, orders) order_columns = orders.reject(&:blank?).map{ |s| s = s.to_sql unless s.is_a?(String) s.gsub(/\s+(?:ASC|DESC)\b/i, '') .gsub(/\s+NULLS\s+(?:FIRST|LAST)\b/i, '') }.reject(&:blank?).map.with_index { |column, i| "#{column} AS alias_#{i}" } (order_columns << super).join(", ") end |
#create_schema_dumper(options) ⇒ Object
275 276 277 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 275 def create_schema_dumper() SQLServer::SchemaDumper.create(self, ) end |
#create_table(table_name, comment: nil, **options) ⇒ Object
10 11 12 13 14 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 10 def create_table(table_name, comment: nil, **) res = super clear_cache! res end |
#drop_table(table_name, options = {}) ⇒ Object
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 16 def drop_table(table_name, = {}) # Mimic CASCADE option as best we can. if [:force] == :cascade execute_procedure(:sp_fkeys, pktable_name: table_name).each do |fkdata| fktable = fkdata['FKTABLE_NAME'] fkcolmn = fkdata['FKCOLUMN_NAME'] pktable = fkdata['PKTABLE_NAME'] pkcolmn = fkdata['PKCOLUMN_NAME'] remove_foreign_key fktable, name: fkdata['FK_NAME'] do_execute "DELETE FROM #{quote_table_name(fktable)} WHERE #{quote_column_name(fkcolmn)} IN ( SELECT #{quote_column_name(pkcolmn)} FROM #{quote_table_name(pktable)} )" end end if [:if_exists] && @version_year < 2016 execute "IF EXISTS(SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = #{quote(table_name)}) DROP TABLE #{quote_table_name(table_name)}" else super end end |
#extract_foreign_key_action(action, fk_name) ⇒ Object
215 216 217 218 219 220 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 215 def extract_foreign_key_action(action, fk_name) case select_value("SELECT #{action}_referential_action_desc FROM sys.foreign_keys WHERE name = '#{fk_name}'") when 'CASCADE' then :cascade when 'SET_NULL' then :nullify end end |
#foreign_keys(table_name) ⇒ Object
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 198 def foreign_keys(table_name) identifier = SQLServer::Utils.extract_identifiers(table_name) fk_info = execute_procedure :sp_fkeys, nil, identifier.schema, nil, identifier.object, identifier.schema fk_info.map do |row| from_table = identifier.object to_table = row['PKTABLE_NAME'] = { name: row['FK_NAME'], column: row['FKCOLUMN_NAME'], primary_key: row['PKCOLUMN_NAME'], on_update: extract_foreign_key_action('update', row['FK_NAME']), on_delete: extract_foreign_key_action('delete', row['FK_NAME']) } ForeignKeyDefinition.new from_table, to_table, end end |
#indexes(table_name) ⇒ Object
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 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 35 def indexes(table_name) data = select("EXEC sp_helpindex #{quote(table_name)}", "SCHEMA") rescue [] data.reduce([]) do |indexes, index| index = index.with_indifferent_access if index[:index_description] =~ /primary key/ indexes else name = index[:index_name] unique = index[:index_description] =~ /unique/ where = select_value("SELECT [filter_definition] FROM sys.indexes WHERE name = #{quote(name)}") orders = {} columns = [] index[:index_keys].split(',').each do |column| column.strip! if column.ends_with?('(-)') column.gsub! '(-)', '' orders[column] = :desc end columns << column end indexes << IndexDefinition.new(table_name, name, unique, columns, where: where, orders: orders) end end end |
#native_database_types ⇒ Object
6 7 8 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 6 def native_database_types @native_database_types ||= initialize_native_database_types.freeze end |
#new_column(name, default, sql_type_metadata, null, table_name, default_function = nil, collation = nil, comment = nil, sqlserver_options = {}) ⇒ Object
85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 85 def new_column(name, default, , null, table_name, default_function = nil, collation = nil, comment = nil, = {}) SQLServerColumn.new( name, default, , null, table_name, default_function, collation, comment, ) end |
#primary_keys(table_name) ⇒ Object
98 99 100 101 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 98 def primary_keys(table_name) primaries = primary_keys_select(table_name) primaries.present? ? primaries : identity_columns(table_name).map(&:name) end |
#primary_keys_select(table_name) ⇒ Object
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 103 def primary_keys_select(table_name) identifier = database_prefix_identifier(table_name) database = identifier.fully_qualified_database_quoted sql = %{ SELECT KCU.COLUMN_NAME AS [name] FROM #{database}.INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS KCU LEFT OUTER JOIN #{database}.INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS TC ON KCU.CONSTRAINT_NAME = TC.CONSTRAINT_NAME AND KCU.CONSTRAINT_NAME = TC.CONSTRAINT_NAME AND KCU.CONSTRAINT_CATALOG = TC.CONSTRAINT_CATALOG AND KCU.CONSTRAINT_SCHEMA = TC.CONSTRAINT_SCHEMA AND TC.CONSTRAINT_TYPE = N'PRIMARY KEY' WHERE KCU.TABLE_NAME = #{prepared_statements ? '@0' : quote(identifier.object)} AND KCU.TABLE_SCHEMA = #{identifier.schema.blank? ? 'schema_name()' : (prepared_statements ? '@1' : quote(identifier.schema))} AND TC.CONSTRAINT_TYPE = N'PRIMARY KEY' ORDER BY KCU.ORDINAL_POSITION ASC }.gsub(/[[:space:]]/, ' ') binds = [] nv128 = SQLServer::Type::UnicodeVarchar.new limit: 128 binds << Relation::QueryAttribute.new('TABLE_NAME', identifier.object, nv128) binds << Relation::QueryAttribute.new('TABLE_SCHEMA', identifier.schema, nv128) unless identifier.schema.blank? sp_executesql(sql, 'SCHEMA', binds).map { |r| r['name'] } end |
#remove_column(table_name, column_name, type = nil, options = {}) ⇒ Object
132 133 134 135 136 137 138 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 132 def remove_column(table_name, column_name, type = nil, = {}) raise ArgumentError.new('You must specify at least one column name. Example: remove_column(:people, :first_name)') if column_name.is_a? Array remove_check_constraints(table_name, column_name) remove_default_constraint(table_name, column_name) remove_indexes(table_name, column_name) do_execute "ALTER TABLE #{quote_table_name(table_name)} DROP COLUMN #{quote_column_name(column_name)}" end |
#remove_index!(table_name, index_name) ⇒ Object
194 195 196 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 194 def remove_index!(table_name, index_name) do_execute "DROP INDEX #{quote_column_name(index_name)} ON #{quote_table_name(table_name)}" end |
#rename_column(table_name, column_name, new_column_name) ⇒ Object
180 181 182 183 184 185 186 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 180 def rename_column(table_name, column_name, new_column_name) clear_cache! identifier = SQLServer::Utils.extract_identifiers("#{table_name}.#{column_name}") execute_procedure :sp_rename, identifier.quoted, new_column_name, 'COLUMN' rename_column_indexes(table_name, column_name, new_column_name) clear_cache! end |
#rename_index(table_name, old_name, new_name) ⇒ Object
188 189 190 191 192 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 188 def rename_index(table_name, old_name, new_name) raise ArgumentError, "Index name '#{new_name}' on table '#{table_name}' is too long; the limit is #{allowed_index_name_length} characters" if new_name.length > allowed_index_name_length identifier = SQLServer::Utils.extract_identifiers("#{table_name}.#{old_name}") execute_procedure :sp_rename, identifier.quoted, new_name, 'INDEX' end |
#rename_table(table_name, new_name) ⇒ Object
127 128 129 130 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 127 def rename_table(table_name, new_name) do_execute "EXEC sp_rename '#{table_name}', '#{new_name}'" rename_table_indexes(table_name, new_name) end |
#type_to_sql(type, limit: nil, precision: nil, scale: nil) ⇒ Object
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/active_record/connection_adapters/sqlserver/schema_statements.rb', line 222 def type_to_sql(type, limit: nil, precision: nil, scale: nil, **) type_limitable = %w(string integer float char nchar varchar nvarchar).include?(type.to_s) limit = nil unless type_limitable case type.to_s when 'integer' case limit when 1 then 'tinyint' when 2 then 'smallint' when 3..4, nil then 'integer' when 5..8 then 'bigint' else raise(ActiveRecordError, "No integer type has byte size #{limit}. Use a numeric with precision 0 instead.") end when 'datetime2' column_type_sql = super if precision if (0..7) === precision column_type_sql << "(#{precision})" else raise(ActiveRecordError, "The dattime2 type has precision of #{precision}. The allowed range of precision is from 0 to 7") end end column_type_sql else super end end |