module Sequel::SQLComments

Public Instance Methods

comment(comment) click to toggle source

Return a modified copy of the dataset that will use the given comment. To uncomment a commented dataset, pass nil as the argument.

   # File lib/sequel/extensions/sql_comments.rb
58 def comment(comment)
59   clone(:comment=>(format_sql_comment(comment) if comment))
60 end

Private Instance Methods

format_sql_comment(comment) click to toggle source

Format the comment. For maximum compatibility, this uses a single line SQL comment, and converts all consecutive whitespace in the comment to a single space.

   # File lib/sequel/extensions/sql_comments.rb
90 def format_sql_comment(comment)
91   " -- #{comment.to_s.gsub(/\s+/, ' ')}\n"
92 end