Class/Module Index [+]

Quicksearch

Sequel::MSSQL

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) click to toggle source

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

# File lib/sequel/adapters/shared/mssql.rb, line 563
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) click to toggle source

MSSQL doesn't support the SQL standard CURRENT_DATE or CURRENT_TIME

# File lib/sequel/adapters/shared/mssql.rb, line 594
def constant_sql_append(sql, constant)
  if c = CONSTANT_MAP[constant]
    sql << c
  else
    super
  end
end
cross_apply(table) click to toggle source

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

# File lib/sequel/adapters/shared/mssql.rb, line 603
def cross_apply(table)
  join_table(:cross_apply, table)
end
disable_insert_output() click to toggle source

Disable the use of INSERT OUTPUT

# File lib/sequel/adapters/shared/mssql.rb, line 608
def disable_insert_output
  clone(:disable_insert_output=>true)
end
escape_like(string) click to toggle source

MSSQL treats [] as a metacharacter in LIKE expresions.

# File lib/sequel/adapters/shared/mssql.rb, line 613
def escape_like(string)
  string.gsub(/[\\%_\[\]]/){|m| "\\#{m}"}
end
full_text_search(cols, terms, opts = OPTS) click to toggle source

MSSQL uses the CONTAINS keyword for full text search

# File lib/sequel/adapters/shared/mssql.rb, line 618
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) click to toggle source

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

# File lib/sequel/adapters/shared/mssql.rb, line 624
def insert_select(*values)
  return unless supports_insert_select?
  with_sql_first(insert_select_sql(*values))
end
insert_select_sql(*values) click to toggle source

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 631
def insert_select_sql(*values)
  ds = (opts[:output] || opts[:returning]) ? self : output(nil, [SQL::ColumnAll.new(:inserted)])
  ds.insert_sql(*values)
end
into(table) click to toggle source

Specify a table for a SELECT ... INTO query.

# File lib/sequel/adapters/shared/mssql.rb, line 637
def into(table)
  clone(:into => table)
end
mssql_unicode_strings() click to toggle source

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

# File lib/sequel/adapters/shared/mssql.rb, line 558
def mssql_unicode_strings
  defined?(@mssql_unicode_strings) ? @mssql_unicode_strings : (@mssql_unicode_strings = db.mssql_unicode_strings)
end
nolock() click to toggle source

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

# File lib/sequel/adapters/shared/mssql.rb, line 642
def nolock
  lock_style(:dirty)
end
outer_apply(table) click to toggle source

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

# File lib/sequel/adapters/shared/mssql.rb, line 647
def outer_apply(table)
  join_table(:outer_apply, table)
end
output(into, values) click to toggle source

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 663
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) click to toggle source

MSSQL uses [] to quote identifiers.

# File lib/sequel/adapters/shared/mssql.rb, line 677
def quoted_identifier_append(sql, name)
  sql << BRACKET_OPEN << name.to_s.gsub(/\]/, DOUBLE_BRACKET_CLOSE) << BRACKET_CLOSE
end
returning(*values) click to toggle source

Emulate RETURNING using the output clause. This only handles values that are simple column references.

# File lib/sequel/adapters/shared/mssql.rb, line 682
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
select_sql() click to toggle source

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 696
def select_sql
  if @opts[:offset] && !@opts[:order] && is_2012_or_later?
    order(1).select_sql
  else
    super
  end
end
server_version() click to toggle source

The version of the database server.

# File lib/sequel/adapters/shared/mssql.rb, line 705
def server_version
  db.server_version(@opts[:server])
end
supports_cte?(type=:select) click to toggle source
# File lib/sequel/adapters/shared/mssql.rb, line 709
def supports_cte?(type=:select)
  is_2005_or_later?
end
supports_group_cube?() click to toggle source

MSSQL 2005+ supports GROUP BY CUBE.

# File lib/sequel/adapters/shared/mssql.rb, line 714
def supports_group_cube?
  is_2005_or_later?
end
supports_group_rollup?() click to toggle source

MSSQL 2005+ supports GROUP BY ROLLUP

# File lib/sequel/adapters/shared/mssql.rb, line 719
def supports_group_rollup?
  is_2005_or_later?
end
supports_insert_select?() click to toggle source

MSSQL supports insert_select via the OUTPUT clause.

# File lib/sequel/adapters/shared/mssql.rb, line 724
def supports_insert_select?
  supports_output_clause? && !opts[:disable_insert_output]
end
supports_intersect_except?() click to toggle source

MSSQL 2005+ supports INTERSECT and EXCEPT

# File lib/sequel/adapters/shared/mssql.rb, line 729
def supports_intersect_except?
  is_2005_or_later?
end
supports_is_true?() click to toggle source

MSSQL does not support IS TRUE

# File lib/sequel/adapters/shared/mssql.rb, line 734
def supports_is_true?
  false
end
supports_join_using?() click to toggle source

MSSQL doesn't support JOIN USING

# File lib/sequel/adapters/shared/mssql.rb, line 739
def supports_join_using?
  false
end
supports_modifying_joins?() click to toggle source

MSSQL 2005+ supports modifying joined datasets

# File lib/sequel/adapters/shared/mssql.rb, line 744
def supports_modifying_joins?
  is_2005_or_later?
end
supports_multiple_column_in?() click to toggle source

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

# File lib/sequel/adapters/shared/mssql.rb, line 749
def supports_multiple_column_in?
  false
end
supports_offsets_in_correlated_subqueries?() click to toggle source

MSSQL 2012+ supports offsets in correlated subqueries.

# File lib/sequel/adapters/shared/mssql.rb, line 754
def supports_offsets_in_correlated_subqueries?
  is_2012_or_later?
end
supports_output_clause?() click to toggle source

MSSQL 2005+ supports the OUTPUT clause.

# File lib/sequel/adapters/shared/mssql.rb, line 759
def supports_output_clause?
  is_2005_or_later?
end
supports_returning?(type) click to toggle source

MSSQL 2005+ can emulate RETURNING via the OUTPUT clause.

# File lib/sequel/adapters/shared/mssql.rb, line 764
def supports_returning?(type)
  supports_insert_select?
end
supports_where_true?() click to toggle source

MSSQL cannot use WHERE 1.

# File lib/sequel/adapters/shared/mssql.rb, line 774
def supports_where_true?
  false
end
supports_window_functions?() click to toggle source

MSSQL 2005+ supports window functions

# File lib/sequel/adapters/shared/mssql.rb, line 769
def supports_window_functions?
  true
end

Protected Instance Methods

_import(columns, values, opts=OPTS) click to toggle source

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 784
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
aggregate_dataset() click to toggle source

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.