Module: Sequel::MSSQL::DatasetMethods
- Includes:
- EmulateOffsetWithRowNumber
- Included in:
- ADO::MSSQL::Dataset, JDBC::JTDS::Dataset, ODBC::MSSQL::Dataset, TinyTDS::Dataset
- Defined in:
- lib/sequel/adapters/shared/mssql.rb
Constant Summary collapse
- BOOL_TRUE =
'1'.freeze
- BOOL_FALSE =
'0'.freeze
- COMMA_SEPARATOR =
', '.freeze
- DELETE_CLAUSE_METHODS =
Dataset.clause_methods(:delete, %w'with delete from output from2 where')
- INSERT_CLAUSE_METHODS =
Dataset.clause_methods(:insert, %w'with insert into columns output values')
- SELECT_CLAUSE_METHODS =
Dataset.clause_methods(:select, %w'with select distinct limit columns into from lock join where group having order compounds')
- UPDATE_CLAUSE_METHODS =
Dataset.clause_methods(:update, %w'with update limit table set output from where')
- UPDATE_CLAUSE_METHODS_2000 =
Dataset.clause_methods(:update, %w'update table set output from where')
- NOLOCK =
' WITH (NOLOCK)'.freeze
- UPDLOCK =
' WITH (UPDLOCK)'.freeze
- WILDCARD =
LiteralString.new('*').freeze
- CONSTANT_MAP =
{:CURRENT_DATE=>'CAST(CURRENT_TIMESTAMP AS DATE)'.freeze, :CURRENT_TIME=>'CAST(CURRENT_TIMESTAMP AS TIME)'.freeze}
- EXTRACT_MAP =
{:year=>"yy", :month=>"m", :day=>"d", :hour=>"hh", :minute=>"n", :second=>"s"}
- BRACKET_CLOSE =
Dataset::BRACKET_CLOSE
- BRACKET_OPEN =
Dataset::BRACKET_OPEN
- COMMA =
Dataset::COMMA
- PAREN_CLOSE =
Dataset::PAREN_CLOSE
- PAREN_SPACE_OPEN =
Dataset::PAREN_SPACE_OPEN
- SPACE =
Dataset::SPACE
- FROM =
Dataset::FROM
- APOS =
Dataset::APOS
- APOS_RE =
Dataset::APOS_RE
- DOUBLE_APOS =
Dataset::DOUBLE_APOS
- INTO =
Dataset::INTO
- DOUBLE_BRACKET_CLOSE =
']]'.freeze
- DATEPART_SECOND_OPEN =
"CAST((datepart(".freeze
- DATEPART_SECOND_MIDDLE =
') + datepart(ns, '.freeze
- DATEPART_SECOND_CLOSE =
")/1000000000.0) AS double precision)".freeze
- DATEPART_OPEN =
"datepart(".freeze
- UNION_ALL =
' UNION ALL '.freeze
- SELECT_SPACE =
'SELECT '.freeze
- TIMESTAMP_USEC_FORMAT =
".%03d".freeze
- OUTPUT_INSERTED =
" OUTPUT INSERTED.*".freeze
- HEX_START =
'0x'.freeze
- UNICODE_STRING_START =
"N'".freeze
- BACKSLASH_CRLF_RE =
/\\((?:\r\n)|\n)/.freeze
- BACKSLASH_CRLF_REPLACE =
'\\\\\\\\\\1\\1'.freeze
- TOP_PAREN =
" TOP (".freeze
- TOP =
" TOP ".freeze
- OUTPUT =
" OUTPUT ".freeze
- HSTAR =
"H*".freeze
- CASE_SENSITIVE_COLLATION =
'Latin1_General_CS_AS'.freeze
- CASE_INSENSITIVE_COLLATION =
'Latin1_General_CI_AS'.freeze
- DEFAULT_TIMESTAMP_FORMAT =
"'%Y-%m-%dT%H:%M:%S%N%z'".freeze
- FORMAT_DATE =
"'%Y%m%d'".freeze
- CROSS_APPLY =
'CROSS APPLY'.freeze
- OUTER_APPLY =
'OUTER APPLY'.freeze
- OFFSET =
" OFFSET ".freeze
- ROWS =
" ROWS".freeze
- ROWS_ONLY =
" ROWS ONLY".freeze
- FETCH_NEXT =
" FETCH NEXT ".freeze
Instance Attribute Summary collapse
-
#mssql_unicode_strings ⇒ Object
Use the database’s mssql_unicode_strings setting if the dataset hasn’t overridden it.
Instance Method Summary collapse
-
#complex_expression_sql_append(sql, op, args) ⇒ Object
MSSQL uses + for string concatenation, and LIKE is case insensitive by default.
-
#constant_sql_append(sql, constant) ⇒ Object
MSSQL doesn’t support the SQL standard CURRENT_DATE or CURRENT_TIME.
-
#cross_apply(table) ⇒ Object
Uses CROSS APPLY to join the given table into the current dataset.
-
#disable_insert_output ⇒ Object
Disable the use of INSERT OUTPUT.
-
#emulated_function_sql_append(sql, f) ⇒ Object
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).
-
#escape_like(string) ⇒ Object
MSSQL treats [] as a metacharacter in LIKE expresions.
-
#full_text_search(cols, terms, opts = OPTS) ⇒ Object
MSSQL uses the CONTAINS keyword for full text search.
-
#insert_select(*values) ⇒ Object
Use the OUTPUT clause to get the value of all columns for the newly inserted record.
-
#into(table) ⇒ Object
Specify a table for a SELECT …
-
#multi_insert_sql(columns, values) ⇒ Object
MSSQL uses a UNION ALL statement to insert multiple values at once.
-
#nolock ⇒ Object
Allows you to do a dirty read of uncommitted data using WITH (NOLOCK).
-
#outer_apply(table) ⇒ Object
Uses OUTER APPLY to join the given table into the current dataset.
-
#output(into, values) ⇒ Object
Include an OUTPUT clause in the eventual INSERT, UPDATE, or DELETE query.
-
#quoted_identifier_append(sql, name) ⇒ Object
MSSQL uses [] to quote identifiers.
-
#select_sql ⇒ Object
On MSSQL 2012+ add a default order to the current dataset if an offset is used.
-
#server_version ⇒ Object
The version of the database server.
-
#supports_group_cube? ⇒ Boolean
MSSQL 2005+ supports GROUP BY CUBE.
-
#supports_group_rollup? ⇒ Boolean
MSSQL 2005+ supports GROUP BY ROLLUP.
-
#supports_insert_select? ⇒ Boolean
MSSQL supports insert_select via the OUTPUT clause.
-
#supports_intersect_except? ⇒ Boolean
MSSQL 2005+ supports INTERSECT and EXCEPT.
-
#supports_is_true? ⇒ Boolean
MSSQL does not support IS TRUE.
-
#supports_join_using? ⇒ Boolean
MSSQL doesn’t support JOIN USING.
-
#supports_modifying_joins? ⇒ Boolean
MSSQL 2005+ supports modifying joined datasets.
-
#supports_multiple_column_in? ⇒ Boolean
MSSQL does not support multiple columns for the IN/NOT IN operators.
-
#supports_output_clause? ⇒ Boolean
MSSQL 2005+ supports the output clause.
-
#supports_where_true? ⇒ Boolean
MSSQL cannot use WHERE 1.
-
#supports_window_functions? ⇒ Boolean
MSSQL 2005+ supports window functions.
Instance Attribute Details
#mssql_unicode_strings ⇒ Object
Use the database’s mssql_unicode_strings setting if the dataset hasn’t overridden it.
516 517 518 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 516 def mssql_unicode_strings defined?(@mssql_unicode_strings) ? @mssql_unicode_strings : (@mssql_unicode_strings = db.mssql_unicode_strings) end |
Instance Method Details
#complex_expression_sql_append(sql, op, args) ⇒ Object
MSSQL uses + for string concatenation, and LIKE is case insensitive by default.
521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 521 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 |
#constant_sql_append(sql, constant) ⇒ Object
MSSQL doesn’t support the SQL standard CURRENT_DATE or CURRENT_TIME
552 553 554 555 556 557 558 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 552 def constant_sql_append(sql, constant) if c = CONSTANT_MAP[constant] sql << c else super end end |
#cross_apply(table) ⇒ Object
Uses CROSS APPLY to join the given table into the current dataset.
561 562 563 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 561 def cross_apply(table) join_table(:cross_apply, table) end |
#disable_insert_output ⇒ Object
Disable the use of INSERT OUTPUT
566 567 568 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 566 def disable_insert_output clone(:disable_insert_output=>true) end |
#emulated_function_sql_append(sql, f) ⇒ Object
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.
579 580 581 582 583 584 585 586 587 588 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 579 def emulated_function_sql_append(sql, f) case f.f 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))) else super end end |
#escape_like(string) ⇒ Object
MSSQL treats [] as a metacharacter in LIKE expresions.
571 572 573 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 571 def escape_like(string) string.gsub(/[\\%_\[\]]/){|m| "\\#{m}"} end |
#full_text_search(cols, terms, opts = OPTS) ⇒ Object
MSSQL uses the CONTAINS keyword for full text search
591 592 593 594 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 591 def full_text_search(cols, terms, opts = OPTS) terms = "\"#{terms.join('" OR "')}\"" if terms.is_a?(Array) filter("CONTAINS (?, ?)", cols, terms) end |
#insert_select(*values) ⇒ Object
Use the OUTPUT clause to get the value of all columns for the newly inserted record.
597 598 599 600 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 597 def insert_select(*values) return unless supports_insert_select? naked.clone(default_server_opts(:sql=>output(nil, [SQL::ColumnAll.new(:inserted)]).insert_sql(*values))).single_record end |
#into(table) ⇒ Object
Specify a table for a SELECT … INTO query.
603 604 605 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 603 def into(table) clone(:into => table) end |
#multi_insert_sql(columns, values) ⇒ Object
MSSQL uses a UNION ALL statement to insert multiple values at once.
608 609 610 611 612 613 614 615 616 617 618 619 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 608 def multi_insert_sql(columns, values) c = false sql = LiteralString.new('') u = UNION_ALL values.each do |v| sql << u if c sql << SELECT_SPACE expression_list_append(sql, v) c ||= true end [insert_sql(columns, sql)] end |
#nolock ⇒ Object
Allows you to do a dirty read of uncommitted data using WITH (NOLOCK).
622 623 624 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 622 def nolock lock_style(:dirty) end |
#outer_apply(table) ⇒ Object
Uses OUTER APPLY to join the given table into the current dataset.
627 628 629 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 627 def outer_apply(table) join_table(:outer_apply, table) end |
#output(into, values) ⇒ Object
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)
643 644 645 646 647 648 649 650 651 652 653 654 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 643 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 |
#quoted_identifier_append(sql, name) ⇒ Object
MSSQL uses [] to quote identifiers.
657 658 659 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 657 def quoted_identifier_append(sql, name) sql << BRACKET_OPEN << name.to_s.gsub(/\]/, DOUBLE_BRACKET_CLOSE) << BRACKET_CLOSE end |
#select_sql ⇒ Object
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.
665 666 667 668 669 670 671 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 665 def select_sql if @opts[:offset] && !@opts[:order] && is_2012_or_later? order(1).select_sql else super end end |
#server_version ⇒ Object
The version of the database server.
674 675 676 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 674 def server_version db.server_version(@opts[:server]) end |
#supports_group_cube? ⇒ Boolean
MSSQL 2005+ supports GROUP BY CUBE.
679 680 681 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 679 def supports_group_cube? is_2005_or_later? end |
#supports_group_rollup? ⇒ Boolean
MSSQL 2005+ supports GROUP BY ROLLUP
684 685 686 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 684 def supports_group_rollup? is_2005_or_later? end |
#supports_insert_select? ⇒ Boolean
MSSQL supports insert_select via the OUTPUT clause.
689 690 691 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 689 def supports_insert_select? supports_output_clause? && !opts[:disable_insert_output] end |
#supports_intersect_except? ⇒ Boolean
MSSQL 2005+ supports INTERSECT and EXCEPT
694 695 696 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 694 def supports_intersect_except? is_2005_or_later? end |
#supports_is_true? ⇒ Boolean
MSSQL does not support IS TRUE
699 700 701 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 699 def supports_is_true? false end |
#supports_join_using? ⇒ Boolean
MSSQL doesn’t support JOIN USING
704 705 706 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 704 def supports_join_using? false end |
#supports_modifying_joins? ⇒ Boolean
MSSQL 2005+ supports modifying joined datasets
709 710 711 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 709 def is_2005_or_later? end |
#supports_multiple_column_in? ⇒ Boolean
MSSQL does not support multiple columns for the IN/NOT IN operators
714 715 716 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 714 def supports_multiple_column_in? false end |
#supports_output_clause? ⇒ Boolean
MSSQL 2005+ supports the output clause.
719 720 721 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 719 def supports_output_clause? is_2005_or_later? end |
#supports_where_true? ⇒ Boolean
MSSQL cannot use WHERE 1.
729 730 731 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 729 def supports_where_true? false end |
#supports_window_functions? ⇒ Boolean
MSSQL 2005+ supports window functions
724 725 726 |
# File 'lib/sequel/adapters/shared/mssql.rb', line 724 def supports_window_functions? true end |