module Sequel::MSSQL
Constants
- APOS
- APOS_RE
- BACKSLASH_CRLF_RE
- BACKSLASH_CRLF_REPLACE
- BOOL_FALSE
- BOOL_TRUE
- BRACKET_CLOSE
- BRACKET_OPEN
- CASE_INSENSITIVE_COLLATION
- CASE_SENSITIVE_COLLATION
- COMMA
- COMMA_SEPARATOR
- CONSTANT_MAP
- CROSS_APPLY
- DATEPART_OPEN
- DATEPART_SECOND_CLOSE
- DATEPART_SECOND_MIDDLE
- DATEPART_SECOND_OPEN
- DEFAULT_TIMESTAMP_FORMAT
- DOUBLE_APOS
- DOUBLE_BRACKET_CLOSE
- EXTRACT_MAP
- FETCH_NEXT
- FORMAT_DATE
- FROM
- HEX_START
- HSTAR
- INTO
- LIMIT_ALL
- NOLOCK
- NON_SQL_OPTIONS
- OFFSET
- OUTER_APPLY
- OUTPUT
- OUTPUT_INSERTED
- PAREN_CLOSE
- PAREN_SPACE_OPEN
- READPAST
- ROWS
- ROWS_ONLY
- SPACE
- TABLE_HINT
- TOP
- TOP_PAREN
- UNICODE_STRING_START
- UPDLOCK
- WILDCARD
Public Class Methods
# File lib/sequel/adapters/shared/mssql.rb, line 9 def self.mock_adapter_setup(db) db.instance_eval do @server_version = 11000000 end end
Public Instance Methods
MSSQL uses + for string concatenation, and LIKE is case insensitive by default.
# File lib/sequel/adapters/shared/mssql.rb, line 602 def complex_expression_sql_append(sql, op, args) case op when :'||' super(sql, :+, args) when :LIKE, :"NOT LIKE" super(sql, op, args.map{|a| Sequel.lit(["(", " COLLATE #{CASE_SENSITIVE_COLLATION})"], a)}) when :ILIKE, :"NOT ILIKE" super(sql, (op == :ILIKE ? :LIKE : :"NOT LIKE"), args.map{|a| Sequel.lit(["(", " COLLATE #{CASE_INSENSITIVE_COLLATION})"], a)}) when :<<, :>> complex_expression_emulate_append(sql, op, args) when :extract part = args.at(0) raise(Sequel::Error, "unsupported extract argument: #{part.inspect}") unless format = EXTRACT_MAP[part] if part == :second expr = args.at(1) sql << DATEPART_SECOND_OPEN << format.to_s << COMMA literal_append(sql, expr) sql << DATEPART_SECOND_MIDDLE literal_append(sql, expr) sql << DATEPART_SECOND_CLOSE else sql << DATEPART_OPEN << format.to_s << COMMA literal_append(sql, args.at(1)) sql << PAREN_CLOSE end else super end end
Uses CROSS APPLY to join the given table into the current dataset.
# File lib/sequel/adapters/shared/mssql.rb, line 642 def cross_apply(table) join_table(:cross_apply, table) end
Disable the use of INSERT OUTPUT
# File lib/sequel/adapters/shared/mssql.rb, line 647 def disable_insert_output clone(:disable_insert_output=>true) end
MSSQL treats [] as a metacharacter in LIKE expresions.
# File lib/sequel/adapters/shared/mssql.rb, line 652 def escape_like(string) string.gsub(/[\%_\[\]]/){|m| "\\#{m}"} end
MSSQL uses the CONTAINS keyword for full text search
# File lib/sequel/adapters/shared/mssql.rb, line 657 def full_text_search(cols, terms, opts = OPTS) terms = "\"#{terms.join('" OR "')}\"" if terms.is_a?(Array) where("CONTAINS (?, ?)", cols, terms) end
Use the OUTPUT clause to get the value of all columns for the newly inserted record.
# File lib/sequel/adapters/shared/mssql.rb, line 663 def insert_select(*values) return unless supports_insert_select? with_sql_first(insert_select_sql(*values)) end
Add OUTPUT clause unless there is already an existing output clause, then return the SQL to insert.
# File lib/sequel/adapters/shared/mssql.rb, line 670 def insert_select_sql(*values) ds = (opts[:output] || opts[:returning]) ? self : output(nil, [SQL::ColumnAll.new(:inserted)]) ds.insert_sql(*values) end
Specify a table for a SELECT … INTO query.
# File lib/sequel/adapters/shared/mssql.rb, line 676 def into(table) clone(:into => table) end
Use the database's #mssql_unicode_strings setting if the dataset hasn't overridden it.
# File lib/sequel/adapters/shared/mssql.rb, line 592 def mssql_unicode_strings opts.has_key?(:mssql_unicode_strings) ? opts[:mssql_unicode_strings] : db.mssql_unicode_strings end
Allow overriding of the #mssql_unicode_strings option at the dataset level.
# File lib/sequel/adapters/shared/mssql.rb, line 587 def mssql_unicode_strings=(v) @opts[:mssql_unicode_strings] = v end
Allows you to do a dirty read of uncommitted data using WITH (NOLOCK).
# File lib/sequel/adapters/shared/mssql.rb, line 681 def nolock lock_style(:dirty) end
Uses OUTER APPLY to join the given table into the current dataset.
# File lib/sequel/adapters/shared/mssql.rb, line 686 def outer_apply(table) join_table(:outer_apply, table) end
Include an OUTPUT clause in the eventual INSERT, UPDATE, or DELETE query.
The first argument is the table to output into, and the second argument is either an Array of column values to select, or a Hash which maps output column names to selected values, in the style of insert or update.
Output into a returned result set is not currently supported.
Examples:
dataset.output(:output_table, [:deleted__id, :deleted__name]) dataset.output(:output_table, :id => :inserted__id, :name => :inserted__name)
# File lib/sequel/adapters/shared/mssql.rb, line 702 def output(into, values) raise(Error, "SQL Server versions 2000 and earlier do not support the OUTPUT clause") unless supports_output_clause? output = {} case values when Hash output[:column_list], output[:select_list] = values.keys, values.values when Array output[:select_list] = values end output[:into] = into clone(:output => output) end
MSSQL uses [] to quote identifiers.
# File lib/sequel/adapters/shared/mssql.rb, line 716 def quoted_identifier_append(sql, name) sql << BRACKET_OPEN << name.to_s.gsub(/\]/, DOUBLE_BRACKET_CLOSE) << BRACKET_CLOSE end
Emulate RETURNING using the output clause. This only handles values that are simple column references.
# File lib/sequel/adapters/shared/mssql.rb, line 721 def returning(*values) values = values.map do |v| unless r = unqualified_column_for(v) raise(Error, "cannot emulate RETURNING via OUTPUT for value: #{v.inspect}") end r end clone(:returning=>values) end
On MSSQL 2012+ add a default order to the current dataset if an offset is used. The default offset emulation using a subquery would be used in the unordered case by default, and that also adds a default order, so it's better to just avoid the subquery.
# File lib/sequel/adapters/shared/mssql.rb, line 735 def select_sql if @opts[:offset] && !@opts[:order] && is_2012_or_later? order(1).select_sql else super end end
The version of the database server.
# File lib/sequel/adapters/shared/mssql.rb, line 744 def server_version db.server_version(@opts[:server]) end
# File lib/sequel/adapters/shared/mssql.rb, line 748 def supports_cte?(type=:select) is_2005_or_later? end
MSSQL 2005+ supports GROUP BY CUBE.
# File lib/sequel/adapters/shared/mssql.rb, line 753 def supports_group_cube? is_2005_or_later? end
MSSQL 2005+ supports GROUP BY ROLLUP
# File lib/sequel/adapters/shared/mssql.rb, line 758 def supports_group_rollup? is_2005_or_later? end
MSSQL 2008+ supports GROUPING SETS
# File lib/sequel/adapters/shared/mssql.rb, line 763 def supports_grouping_sets? is_2008_or_later? end
MSSQL supports #insert_select via the OUTPUT clause.
# File lib/sequel/adapters/shared/mssql.rb, line 768 def supports_insert_select? supports_output_clause? && !opts[:disable_insert_output] end
MSSQL 2005+ supports INTERSECT and EXCEPT
# File lib/sequel/adapters/shared/mssql.rb, line 773 def supports_intersect_except? is_2005_or_later? end
MSSQL does not support IS TRUE
# File lib/sequel/adapters/shared/mssql.rb, line 778 def supports_is_true? false end
MSSQL doesn't support JOIN USING
# File lib/sequel/adapters/shared/mssql.rb, line 783 def supports_join_using? false end
MSSQL 2005+ supports modifying joined datasets
# File lib/sequel/adapters/shared/mssql.rb, line 788 def supports_modifying_joins? is_2005_or_later? end
MSSQL does not support multiple columns for the IN/NOT IN operators
# File lib/sequel/adapters/shared/mssql.rb, line 793 def supports_multiple_column_in? false end
MSSQL cannot use WHERE 1.
# File lib/sequel/adapters/shared/mssql.rb, line 823 def supports_where_true? false end
MSSQL 2005+ supports window functions
# File lib/sequel/adapters/shared/mssql.rb, line 818 def supports_window_functions? true end
Return a cloned dataset with the #mssql_unicode_strings option set.
# File lib/sequel/adapters/shared/mssql.rb, line 597 def with_mssql_unicode_strings(v) clone(:mssql_unicode_strings=>v) end
Protected Instance Methods
If returned primary keys are requested, use OUTPUT unless already set on the dataset. If OUTPUT is already set, use existing returning values. If OUTPUT is only set to return a single columns, return an array of just that column. Otherwise, return an array of hashes.
# File lib/sequel/adapters/shared/mssql.rb, line 833 def _import(columns, values, opts=OPTS) if opts[:return] == :primary_key && !@opts[:output] output(nil, [SQL::QualifiedIdentifier.new(:inserted, first_primary_key)])._import(columns, values, opts) elsif @opts[:output] statements = multi_insert_sql(columns, values) @db.transaction(opts.merge(:server=>@opts[:server])) do statements.map{|st| with_sql(st)} end.first.map{|v| v.length == 1 ? v.values.first : v} else super end end
MSSQL does not allow ordering in sub-clauses unless 'top' (limit) is specified
# File lib/sequel/adapters/shared/mssql.rb, line 847 def aggregate_dataset (options_overlap(Sequel::Dataset::COUNT_FROM_SELF_OPTS) && !options_overlap([:limit])) ? unordered.from_self : super end
If the dataset using a order without a limit or offset or custom SQL, remove the order. Compounds on Microsoft SQL Server have undefined order unless the result is specifically ordered. Applying the current order before the compound doesn't work in all cases, such as when qualified identifiers are used. If you want to ensure a order for a compound dataset, apply the order after all compounds have been added.
# File lib/sequel/adapters/shared/mssql.rb, line 858 def compound_from_self if @opts[:offset] && !@opts[:limit] && !is_2012_or_later? clone(:limit=>LIMIT_ALL).from_self elsif @opts[:order] && !(@opts[:sql] || @opts[:limit] || @opts[:offset]) unordered else super end end
Private Instance Methods
Allow update and delete for unordered, limited datasets only.
# File lib/sequel/adapters/shared/mssql.rb, line 871 def check_not_limited!(type) return if @opts[:skip_limit_check] && type != :truncate #SEQUEL5 #raise Sequel::InvalidOperation, "Dataset##{type} not suppored on ordered, limited datasets" if opts[:order] && opts[:limit] Sequel::Deprecation.deprecate("Dataset##{type} on ordered, limited datasets", "Call unlimited to not use a limit, or unordered to not use an order, or skip_limit_check to ignore the limit") if @opts[:order] && @opts[:limit] super if type == :truncate || @opts[:offset] end
Use strict ISO-8601 format with T between date and time, since that is the format that is multilanguage and not DATEFORMAT dependent.
# File lib/sequel/adapters/shared/mssql.rb, line 897 def default_timestamp_format DEFAULT_TIMESTAMP_FORMAT end
MSSQL supports FROM clauses in DELETE and UPDATE statements.
# File lib/sequel/adapters/shared/mssql.rb, line 908 def delete_from2_sql(sql) if joined_dataset? select_from_sql(sql) select_join_sql(sql) end end
Only include the primary table in the main delete clause
# File lib/sequel/adapters/shared/mssql.rb, line 902 def delete_from_sql(sql) sql << FROM source_list_append(sql, @opts[:from][0..0]) end
# File lib/sequel/adapters/shared/mssql.rb, line 916 def delete_output_sql(sql) output_sql(sql, :DELETED) end
There is no function on Microsoft SQL Server that does character length and respects trailing spaces (datalength respects trailing spaces, but counts bytes instead of characters). Use a hack to work around the trailing spaces issue.
# File lib/sequel/adapters/shared/mssql.rb, line 924 def emulate_function?(name) name == :char_length || name == :trim end
# File lib/sequel/adapters/shared/mssql.rb, line 928 def emulate_function_sql_append(sql, f) case f.name when :char_length literal_append(sql, SQL::Function.new(:len, Sequel.join([f.args.first, 'x'])) - 1) when :trim literal_append(sql, SQL::Function.new(:ltrim, SQL::Function.new(:rtrim, f.args.first))) end end
Microsoft SQL Server 2012 has native support for offsets, but only for ordered datasets.
# File lib/sequel/adapters/shared/mssql.rb, line 938 def emulate_offset_with_row_number? super && !(is_2012_or_later? && @opts[:order]) end
Return the first primary key for the current table. If this table has multiple primary keys, this will only return one of them. Used by #_import.
# File lib/sequel/adapters/shared/mssql.rb, line 944 def first_primary_key @db.schema(self).map{|k, v| k if v[:primary_key] == true}.compact.first end
# File lib/sequel/adapters/shared/mssql.rb, line 948 def insert_output_sql(sql) output_sql(sql, :INSERTED) end
Whether we are using SQL Server 2005 or later.
# File lib/sequel/adapters/shared/mssql.rb, line 880 def is_2005_or_later? server_version >= 9000000 end
Whether we are using SQL Server 2008 or later.
# File lib/sequel/adapters/shared/mssql.rb, line 885 def is_2008_or_later? server_version >= 10000000 end
Whether we are using SQL Server 2012 or later.
# File lib/sequel/adapters/shared/mssql.rb, line 890 def is_2012_or_later? server_version >= 11000000 end
Handle CROSS APPLY and OUTER APPLY JOIN types
# File lib/sequel/adapters/shared/mssql.rb, line 954 def join_type_sql(join_type) case join_type when :cross_apply CROSS_APPLY when :outer_apply OUTER_APPLY else super end end
MSSQL uses a literal hexidecimal number for blob strings
# File lib/sequel/adapters/shared/mssql.rb, line 966 def literal_blob_append(sql, v) sql << HEX_START << v.unpack(HSTAR).first end
Use YYYYmmdd format, since that's the only want that is multilanguage and not DATEFORMAT dependent.
# File lib/sequel/adapters/shared/mssql.rb, line 972 def literal_date(v) v.strftime(FORMAT_DATE) end
Use 0 for false on MSSQL
# File lib/sequel/adapters/shared/mssql.rb, line 977 def literal_false BOOL_FALSE end
Optionally use unicode string syntax for all strings. Don't double backslashes.
# File lib/sequel/adapters/shared/mssql.rb, line 983 def literal_string_append(sql, v) sql << (mssql_unicode_strings ? UNICODE_STRING_START : APOS) sql << v.gsub(APOS_RE, DOUBLE_APOS).gsub(BACKSLASH_CRLF_RE, BACKSLASH_CRLF_REPLACE) << APOS end
Use 1 for true on MSSQL
# File lib/sequel/adapters/shared/mssql.rb, line 989 def literal_true BOOL_TRUE end
MSSQL 2008+ supports multiple rows in the VALUES clause, older versions can use UNION.
# File lib/sequel/adapters/shared/mssql.rb, line 995 def multi_insert_sql_strategy is_2008_or_later? ? :values : :union end
# File lib/sequel/adapters/shared/mssql.rb, line 1104 def output_list_sql(sql, output) sql << OUTPUT column_list_append(sql, output[:select_list]) if into = output[:into] sql << INTO identifier_append(sql, into) if column_list = output[:column_list] sql << PAREN_SPACE_OPEN source_list_append(sql, column_list) sql << PAREN_CLOSE end end end
# File lib/sequel/adapters/shared/mssql.rb, line 1118 def output_returning_sql(sql, type, values) sql << OUTPUT if values.empty? literal_append(sql, SQL::ColumnAll.new(type)) else values = values.map do |v| case v when SQL::AliasedExpression Sequel.qualify(type, v.expression).as(v.alias) else Sequel.qualify(type, v) end end column_list_append(sql, values) end end
# File lib/sequel/adapters/shared/mssql.rb, line 1004 def select_into_sql(sql) if i = @opts[:into] sql << INTO identifier_append(sql, i) end end
Support different types of locking styles
# File lib/sequel/adapters/shared/mssql.rb, line 1043 def select_lock_sql(sql) lock = @opts[:lock] skip_locked = @opts[:skip_locked] for_update = lock == :update dirty = lock == :dirty lock_hint = for_update || dirty if lock_hint || skip_locked sql << TABLE_HINT if lock_hint sql << if for_update UPDLOCK else NOLOCK end end if lock_hint && skip_locked sql << COMMA_SEPARATOR end if skip_locked sql << READPAST end sql << PAREN_CLOSE else super end end
On 2012+ when there is an order with an offset, append the offset (and possible limit) at the end of the order clause.
# File lib/sequel/adapters/shared/mssql.rb, line 1077 def select_order_sql(sql) super if is_2012_or_later? && @opts[:order] if o = @opts[:offset] sql << OFFSET literal_append(sql, o) sql << ROWS if l = @opts[:limit] sql << FETCH_NEXT literal_append(sql, l) sql << ROWS_ONLY end end end end
MSSQL supports millisecond timestamp precision.
# File lib/sequel/adapters/shared/mssql.rb, line 1136 def timestamp_precision 3 end
# File lib/sequel/adapters/shared/mssql.rb, line 1035 def update_limit_sql(sql) if l = @opts[:limit] shared_limit_sql(sql, l) end end
Only include the primary table in the main update clause
# File lib/sequel/adapters/shared/mssql.rb, line 1141 def update_table_sql(sql) sql << SPACE source_list_append(sql, @opts[:from][0..0]) end
# File lib/sequel/adapters/shared/mssql.rb, line 1146 def uses_with_rollup? !is_2008_or_later? end