Module | Sequel::MSSQL::DatasetMethods
In: | lib/sequel/adapters/shared/mssql.rb

### Methods

aggregate_dataset complex_expression_sql_append constant_sql_append disable_insert_output disable_insert_output! full_text_search insert_select into multi_insert_sql new nolock output output! quoted_identifier_append server_version supports_insert_select? supports_intersect_except? supports_is_true? supports_join_using? supports_modifying_joins? supports_multiple_column_in? supports_output_clause? supports_where_true? supports_window_functions?

### Included Modules

EmulateOffsetWithRowNumber

### Constants

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 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
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
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

### Attributes

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

### Public Class methods

new(db, opts={})

Copy the mssql_unicode_strings option from the `db` object.

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 293
    293:       def initialize(db, opts={})
    294:         super
    295:         @mssql_unicode_strings = db.mssql_unicode_strings
    296:       end

### 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 299
    299:       def complex_expression_sql_append(sql, op, args)
    300:         case op
    301:         when '||''||'
    302:           super(sql, :+, args)
    303:         when :LIKE, "NOT LIKE""NOT LIKE"
    304:           super(sql, op, args.map{|a| LiteralString.new("(#{literal(a)} COLLATE #{CASE_SENSITIVE_COLLATION})")})
    305:         when :ILIKE, "NOT ILIKE""NOT ILIKE"
    306:           super(sql, (op == :ILIKE ? :LIKE : "NOT LIKE""NOT LIKE"), args.map{|a| LiteralString.new("(#{literal(a)} COLLATE #{CASE_INSENSITIVE_COLLATION})")})
    307:         when :<<
    308:           sql << complex_expression_arg_pairs(args){|a, b| "(#{literal(a)} * POWER(2, #{literal(b)}))"}
    309:         when :>>
    310:           sql << complex_expression_arg_pairs(args){|a, b| "(#{literal(a)} / POWER(2, #{literal(b)}))"}
    311:         when :extract
    312:           part = args.at(0)
    313:           raise(Sequel::Error, "unsupported extract argument: #{part.inspect}") unless format = EXTRACT_MAP[part]
    314:           if part == :second
    315:             expr = literal(args.at(1))
    316:             sql << DATEPART_SECOND_OPEN << format.to_s << COMMA << expr << DATEPART_SECOND_MIDDLE << expr << DATEPART_SECOND_CLOSE
    317:           else
    318:             sql << DATEPART_OPEN << format.to_s << COMMA
    319:             literal_append(sql, args.at(1))
    320:             sql << PAREN_CLOSE
    321:           end
    322:         else
    323:           super
    324:         end
    325:       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 328
    328:       def constant_sql_append(sql, constant)
    329:         if c = CONSTANT_MAP[constant]
    330:           sql << c
    331:         else
    332:           super
    333:         end
    334:       end

disable_insert_output()

Disable the use of INSERT OUTPUT

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 337
    337:       def disable_insert_output
    338:         clone(:disable_insert_output=>true)
    339:       end

disable_insert_output!()

Disable the use of INSERT OUTPUT, modifying the receiver

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 342
    342:       def disable_insert_output!
    343:         mutation_method(:disable_insert_output)
    344:       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 347
    347:       def full_text_search(cols, terms, opts = {})
    348:         filter("CONTAINS (#{literal(cols)}, #{literal(terms)})")
    349:       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 352
    352:       def insert_select(*values)
    353:         return unless supports_insert_select?
    354:         naked.clone(default_server_opts(:sql=>output(nil, [SQL::ColumnAll.new(:inserted)]).insert_sql(*values))).single_record
    355:       end

into(table)

Specify a table for a SELECT … INTO query.

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 358
    358:       def into(table)
    359:         clone(:into => table)
    360:       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 363
    363:       def multi_insert_sql(columns, values)
    364:         c = false
    365:         sql = LiteralString.new('')
    366:         u = UNION_ALL
    367:         values.each do |v|
    368:           sql << u if c
    369:           sql << SELECT_SPACE
    370:           expression_list_append(sql, v)
    371:           c ||= true
    372:         end
    373:         [insert_sql(columns, sql)]
    374:       end

nolock()

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

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 377
    377:       def nolock
    378:         lock_style(:dirty)
    379:       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 393
    393:       def output(into, values)
    394:         raise(Error, "SQL Server versions 2000 and earlier do not support the OUTPUT clause") unless supports_output_clause?
    395:         output = {}
    396:         case values
    397:           when Hash
    398:             output[:column_list], output[:select_list] = values.keys, values.values
    399:           when Array
    400:             output[:select_list] = values
    401:         end
    402:         output[:into] = into
    403:         clone({:output => output})
    404:       end

output!(into, values)

An output method that modifies the receiver.

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 407
    407:       def output!(into, values)
    408:         mutation_method(:output, into, values)
    409:       end

quoted_identifier_append(sql, name)

MSSQL uses [] to quote identifiers

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 412
    412:       def quoted_identifier_append(sql, name)
    413:         sql << BRACKET_OPEN << name.to_s << BRACKET_CLOSE
    414:       end

server_version()

The version of the database server.

[Source]

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

supports_insert_select?()

MSSQL supports insert_select via the OUTPUT clause.

[Source]

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

supports_intersect_except?()

MSSQL 2005+ supports INTERSECT and EXCEPT

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 427
    427:       def supports_intersect_except?
    428:         is_2005_or_later?
    429:       end

supports_is_true?()

MSSQL does not support IS TRUE

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 432
    432:       def supports_is_true?
    433:         false
    434:       end

supports_join_using?()

MSSQL doesn‘t support JOIN USING

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 437
    437:       def supports_join_using?
    438:         false
    439:       end

supports_modifying_joins?()

MSSQL 2005+ supports modifying joined datasets

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 442
    442:       def supports_modifying_joins?
    443:         is_2005_or_later?
    444:       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 447
    447:       def supports_multiple_column_in?
    448:         false
    449:       end

supports_output_clause?()

MSSQL 2005+ supports the output clause.

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 452
    452:       def supports_output_clause?
    453:         is_2005_or_later?
    454:       end

supports_where_true?()

MSSQL cannot use WHERE 1.

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 462
    462:       def supports_where_true?
    463:         false
    464:       end

supports_window_functions?()

MSSQL 2005+ supports window functions

[Source]

         # File lib/sequel/adapters/shared/mssql.rb, line 457
    457:       def supports_window_functions?
    458:         true
    459:       end

### Protected Instance methods

aggregate_dataset()

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

[Source]

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

[Validate]