Module: Sequel::MSSQL::DatasetMethods

Constants

 '1'.freeze
 '0'.freeze
 ', '.freeze
 Dataset.clause_methods(:delete, %w'with delete from output from2 where')
 Dataset.clause_methods(:insert, %w'with insert into columns output values')
 Dataset.clause_methods(:select, %w'with select distinct limit columns into from lock join where group having order compounds')
 Dataset.clause_methods(:update, %w'with update limit table set output from where')
 Dataset.clause_methods(:update, %w'update table set output from where')
 ' WITH (NOLOCK)'.freeze
 ' WITH (UPDLOCK)'.freeze
 LiteralString.new('*').freeze
 {:CURRENT_DATE=>'CAST(CURRENT_TIMESTAMP AS DATE)'.freeze, :CURRENT_TIME=>'CAST(CURRENT_TIMESTAMP AS TIME)'.freeze}
 {:year=>"yy", :month=>"m", :day=>"d", :hour=>"hh", :minute=>"n", :second=>"s"}
 Dataset::BRACKET_CLOSE
 Dataset::BRACKET_OPEN
 Dataset::COMMA
 Dataset::PAREN_CLOSE
 Dataset::PAREN_SPACE_OPEN
 Dataset::SPACE
 Dataset::FROM
 Dataset::APOS
 Dataset::APOS_RE
 Dataset::DOUBLE_APOS
 Dataset::INTO
 ']]'.freeze
 "CAST((datepart(".freeze
 ') + datepart(ns, '.freeze
 ")/1000000000.0) AS double precision)".freeze
 "datepart(".freeze
 ' UNION ALL '.freeze
 'SELECT '.freeze
 ".%03d".freeze
 " OUTPUT INSERTED.*".freeze
 '0x'.freeze
 "N'".freeze
 /\\((?:\r\n)|\n)/.freeze
 '\\\\\\\\\\1\\1'.freeze
 " TOP (".freeze
 " TOP ".freeze
 " OUTPUT ".freeze
 "H*".freeze
 'Latin1_General_CS_AS'.freeze
 'Latin1_General_CI_AS'.freeze
 "'%Y-%m-%dT%H:%M:%S%N%z'".freeze
 "'%Y%m%d'".freeze
 'CROSS APPLY'.freeze
 'OUTER APPLY'.freeze

Attributes

mssql_unicode_strings [W] Allow overriding of the mssql_unicode_strings option at the dataset level.

Public Instance methods

complex_expression_sql_append(sql, op, args)

MSSQL uses + for string concatenation, and LIKE is case insensitive by default.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 459
459:       def complex_expression_sql_append(sql, op, args)
460:         case op
461:         when '||''||'
462:           super(sql, :+, args)
463:         when :LIKE, "NOT LIKE""NOT LIKE"
464:           super(sql, op, args.map{|a| LiteralString.new("(#{literal(a)} COLLATE #{CASE_SENSITIVE_COLLATION})")})
465:         when :ILIKE, "NOT ILIKE""NOT ILIKE"
466:           super(sql, (op == :ILIKE ? :LIKE : "NOT LIKE""NOT LIKE"), args.map{|a| LiteralString.new("(#{literal(a)} COLLATE #{CASE_INSENSITIVE_COLLATION})")})
467:         when :<<
468:           sql << complex_expression_arg_pairs(args){|a, b| "(#{literal(a)} * POWER(2, #{literal(b)}))"}
469:         when :>>
470:           sql << complex_expression_arg_pairs(args){|a, b| "(#{literal(a)} / POWER(2, #{literal(b)}))"}
471:         when :extract
472:           part = args.at(0)
473:           raise(Sequel::Error, "unsupported extract argument: #{part.inspect}") unless format = EXTRACT_MAP[part]
474:           if part == :second
475:             expr = literal(args.at(1))
476:             sql << DATEPART_SECOND_OPEN << format.to_s << COMMA << expr << DATEPART_SECOND_MIDDLE << expr << DATEPART_SECOND_CLOSE
477:           else
478:             sql << DATEPART_OPEN << format.to_s << COMMA
479:             literal_append(sql, args.at(1))
480:             sql << PAREN_CLOSE
481:           end
482:         else
483:           super
484:         end
485:       end

constant_sql_append(sql, constant)

MSSQL doesn‘t support the SQL standard CURRENT_DATE or CURRENT_TIME

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 488
488:       def constant_sql_append(sql, constant)
489:         if c = CONSTANT_MAP[constant]
490:           sql << c
491:         else
492:           super
493:         end
494:       end

cross_apply(table)

Uses CROSS APPLY to join the given table into the current dataset.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 497
497:       def cross_apply(table)
498:         join_table(:cross_apply, table)
499:       end

disable_insert_output()

Disable the use of INSERT OUTPUT

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 502
502:       def disable_insert_output
503:         clone(:disable_insert_output=>true)
504:       end

emulated_function_sql_append(sql, f)

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.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 515
515:       def emulated_function_sql_append(sql, f)
516:         case f.f
517:         when :char_length
518:           literal_append(sql, SQL::Function.new(:len, Sequel.join([f.args.first, 'x'])) - 1)
519:         when :trim
520:           literal_append(sql, SQL::Function.new(:ltrim, SQL::Function.new(:rtrim, f.args.first)))
521:         else
522:           super
523:         end
524:       end

escape_like(string)

MSSQL treats [] as a metacharacter in LIKE expresions.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 507
507:       def escape_like(string)
508:         string.gsub(/[\\%_\[\]]/){|m| "\\#{m}"}
509:       end

full_text_search(cols, terms, opts = {})

MSSQL uses the CONTAINS keyword for full text search

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 527
527:       def full_text_search(cols, terms, opts = {})
528:         terms = "\"#{terms.join('" OR "')}\"" if terms.is_a?(Array)
529:         filter("CONTAINS (?, ?)", cols, terms)
530:       end

insert_select(*values)

Use the OUTPUT clause to get the value of all columns for the newly inserted record.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 533
533:       def insert_select(*values)
534:         return unless supports_insert_select?
535:         naked.clone(default_server_opts(:sql=>output(nil, [SQL::ColumnAll.new(:inserted)]).insert_sql(*values))).single_record
536:       end

into(table)

Specify a table for a SELECT … INTO query.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 539
539:       def into(table)
540:         clone(:into => table)
541:       end

mssql_unicode_strings()

Use the database‘s mssql_unicode_strings setting if the dataset hasn‘t overridden it.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 454
454:       def mssql_unicode_strings
455:         defined?(@mssql_unicode_strings) ? @mssql_unicode_strings : (@mssql_unicode_strings = db.mssql_unicode_strings)
456:       end

multi_insert_sql(columns, values)

MSSQL uses a UNION ALL statement to insert multiple values at once.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 544
544:       def multi_insert_sql(columns, values)
545:         c = false
546:         sql = LiteralString.new('')
547:         u = UNION_ALL
548:         values.each do |v|
549:           sql << u if c
550:           sql << SELECT_SPACE
551:           expression_list_append(sql, v)
552:           c ||= true
553:         end
554:         [insert_sql(columns, sql)]
555:       end

nolock()

Allows you to do a dirty read of uncommitted data using WITH (NOLOCK).

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 558
558:       def nolock
559:         lock_style(:dirty)
560:       end

outer_apply(table)

Uses OUTER APPLY to join the given table into the current dataset.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 563
563:       def outer_apply(table)
564:         join_table(:outer_apply, table)
565:       end

output(into, values)

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)

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 579
579:       def output(into, values)
580:         raise(Error, "SQL Server versions 2000 and earlier do not support the OUTPUT clause") unless supports_output_clause?
581:         output = {}
582:         case values
583:           when Hash
584:             output[:column_list], output[:select_list] = values.keys, values.values
585:           when Array
586:             output[:select_list] = values
587:         end
588:         output[:into] = into
589:         clone({:output => output})
590:       end

quoted_identifier_append(sql, name)

MSSQL uses [] to quote identifiers.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 593
593:       def quoted_identifier_append(sql, name)
594:         sql << BRACKET_OPEN << name.to_s.gsub(/\]/, DOUBLE_BRACKET_CLOSE) << BRACKET_CLOSE
595:       end

server_version()

The version of the database server.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 598
598:       def server_version
599:         db.server_version(@opts[:server])
600:       end

supports_group_cube?()

MSSQL 2005+ supports GROUP BY CUBE.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 603
603:       def supports_group_cube?
604:         is_2005_or_later?
605:       end

supports_group_rollup?()

MSSQL 2005+ supports GROUP BY ROLLUP

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 608
608:       def supports_group_rollup?
609:         is_2005_or_later?
610:       end

supports_insert_select?()

MSSQL supports insert_select via the OUTPUT clause.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 613
613:       def supports_insert_select?
614:         supports_output_clause? && !opts[:disable_insert_output]
615:       end

supports_intersect_except?()

MSSQL 2005+ supports INTERSECT and EXCEPT

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 618
618:       def supports_intersect_except?
619:         is_2005_or_later?
620:       end

supports_is_true?()

MSSQL does not support IS TRUE

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 623
623:       def supports_is_true?
624:         false
625:       end

supports_join_using?()

MSSQL doesn‘t support JOIN USING

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 628
628:       def supports_join_using?
629:         false
630:       end

supports_modifying_joins?()

MSSQL 2005+ supports modifying joined datasets

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 633
633:       def supports_modifying_joins?
634:         is_2005_or_later?
635:       end

supports_multiple_column_in?()

MSSQL does not support multiple columns for the IN/NOT IN operators

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 638
638:       def supports_multiple_column_in?
639:         false
640:       end

supports_output_clause?()

MSSQL 2005+ supports the output clause.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 643
643:       def supports_output_clause?
644:         is_2005_or_later?
645:       end

supports_where_true?()

MSSQL cannot use WHERE 1.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 653
653:       def supports_where_true?
654:         false
655:       end

supports_window_functions?()

MSSQL 2005+ supports window functions

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 648
648:       def supports_window_functions?
649:         true
650:       end

Protected Instance methods

_import(columns, values, opts={})

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.

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 663
663:       def _import(columns, values, opts={})
664:         if opts[:return] == :primary_key && !@opts[:output]
665:           output(nil, [SQL::QualifiedIdentifier.new(:inserted, first_primary_key)])._import(columns, values, opts)
666:         elsif @opts[:output]
667:           statements = multi_insert_sql(columns, values)
668:           @db.transaction(opts.merge(:server=>@opts[:server])) do
669:             statements.map{|st| with_sql(st)}
670:           end.first.map{|v| v.length == 1 ? v.values.first : v}
671:         else
672:           super
673:         end
674:       end

aggregate_dataset()

MSSQL does not allow ordering in sub-clauses unless ‘top’ (limit) is specified

[Source]

     # File lib/sequel/adapters/shared/mssql.rb, line 677
677:       def aggregate_dataset
678:         (options_overlap(Sequel::Dataset::COUNT_FROM_SELF_OPTS) && !options_overlap([:limit])) ? unordered.from_self : super
679:       end

Methods

Included Modules

Constants

Attributes

Public Instance methods

Protected Instance methods