module Sequel::Postgres::DatasetMethods

  1. lib/sequel/adapters/shared/postgres.rb

Constants

EXPLAIN_BOOLEAN_OPTIONS = {}  
EXPLAIN_NONBOOLEAN_OPTIONS = { :serialize => {:none=>"SERIALIZE NONE", :text=>"SERIALIZE TEXT", :binary=>"SERIALIZE BINARY"}.freeze, :format => {:text=>"FORMAT TEXT", :xml=>"FORMAT XML", :json=>"FORMAT JSON", :yaml=>"FORMAT YAML"}.freeze }.freeze  
LOCK_MODES = ['ACCESS SHARE', 'ROW SHARE', 'ROW EXCLUSIVE', 'SHARE UPDATE EXCLUSIVE', 'SHARE', 'SHARE ROW EXCLUSIVE', 'EXCLUSIVE', 'ACCESS EXCLUSIVE'].each(&:freeze).freeze  
NULL = LiteralString.new('NULL').freeze  

Public Instance methods

analyze()

Return the results of an EXPLAIN ANALYZE query as a string

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2046 def analyze
2047   explain(:analyze=>true)
2048 end
complex_expression_sql_append(sql, op, args)

Handle converting the ruby xor operator (^) into the PostgreSQL xor operator (#), and use the ILIKE and NOT ILIKE operators.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2053 def complex_expression_sql_append(sql, op, args)
2054   case op
2055   when :^
2056     j = ' # '
2057     c = false
2058     args.each do |a|
2059       sql << j if c
2060       literal_append(sql, a)
2061       c ||= true
2062     end
2063   when :ILIKE, :'NOT ILIKE'
2064     sql << '('
2065     literal_append(sql, args[0])
2066     sql << ' ' << op.to_s << ' '
2067     literal_append(sql, args[1])
2068     sql << ')'
2069   else
2070     super
2071   end
2072 end
disable_insert_returning()

Disables automatic use of INSERT … RETURNING. You can still use returning manually to force the use of RETURNING when inserting.

This is designed for cases where INSERT RETURNING cannot be used, such as when you are using partitioning with trigger functions or conditional rules, or when you are using a PostgreSQL version less than 8.2, or a PostgreSQL derivative that does not support returning.

Note that when this method is used, insert will not return the primary key of the inserted row, you will have to get the primary key of the inserted row before inserting via nextval, or after inserting via currval or lastval (making sure to use the same database connection for currval or lastval).

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2088 def disable_insert_returning
2089   clone(:disable_insert_returning=>true)
2090 end
empty?()

Always return false when using VALUES

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2093 def empty?
2094   return false if @opts[:values]
2095   super
2096 end
explain(opts=OPTS)

Return the results of an EXPLAIN query. Boolean options:

:analyze

Use the ANALYZE option.

:buffers

Use the BUFFERS option.

:costs

Use the COSTS option.

:generic_plan

Use the GENERIC_PLAN option.

:memory

Use the MEMORY option.

:settings

Use the SETTINGS option.

:summary

Use the SUMMARY option.

:timing

Use the TIMING option.

:verbose

Use the VERBOSE option.

:wal

Use the WAL option.

Non boolean options:

:format

Use the FORMAT option to change the format of the returned value. Values can be :text, :xml, :json, or :yaml.

:serialize

Use the SERIALIZE option to get timing on serialization. Values can be :none, :text, or :binary.

See the PostgreSQL EXPLAIN documentation for an explanation of what each option does.

In most cases, the return value is a single string. However, using the format: :json option can result in the return value being an array containing a hash.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2126 def explain(opts=OPTS)
2127   rows = clone(:append_sql=>explain_sql_string_origin(opts)).map(:'QUERY PLAN')
2128 
2129   if rows.length == 1
2130     rows[0]
2131   elsif rows.all?{|row| String === row}
2132     rows.join("\r\n") 
2133   # simplecov:disable
2134   else
2135     # This branch is unreachable in tests, but it seems better to just return
2136     # all rows than throw in error if this case actually happens.
2137     rows
2138   # simplecov:enable
2139   end
2140 end
for_key_share()

Return a cloned dataset which will use FOR KEY SHARE to lock returned rows. Supported on PostgreSQL 9.3+.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2144 def for_key_share
2145   cached_lock_style_dataset(:_for_key_share_ds, :key_share)
2146 end
for_no_key_update()

Return a cloned dataset which will use FOR NO KEY UPDATE to lock returned rows. This is generally a better choice than using for_update on PostgreSQL, unless you will be deleting the row or modifying a key column. Supported on PostgreSQL 9.3+.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2151 def for_no_key_update
2152   cached_lock_style_dataset(:_for_no_key_update_ds, :no_key_update)
2153 end
for_share()

Return a cloned dataset which will use FOR SHARE to lock returned rows.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2156 def for_share
2157   cached_lock_style_dataset(:_for_share_ds, :share)
2158 end
full_text_search(cols, terms, opts = OPTS)

Run a full text search on PostgreSQL. By default, searching for the inclusion of any of the terms in any of the cols.

Options:

:headline

Append a expression to the selected columns aliased to headline that contains an extract of the matched text.

:language

The language to use for the search (default: ‘simple’)

:plain

Whether a plain search should be used (default: false). In this case, terms should be a single string, and it will do a search where cols contains all of the words in terms. This ignores search operators in terms.

:phrase

Similar to :plain, but also adding an ILIKE filter to ensure that returned rows also include the exact phrase used.

:rank

Set to true to order by the rank, so that closer matches are returned first.

:to_tsquery

Can be set to :plain, :phrase, or :websearch to specify the function to use to convert the terms to a ts_query.

:tsquery

Specifies the terms argument is already a valid SQL expression returning a tsquery, and can be used directly in the query.

:tsvector

Specifies the cols argument is already a valid SQL expression returning a tsvector, and can be used directly in the query.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2179 def full_text_search(cols, terms, opts = OPTS)
2180   lang = Sequel.cast(opts[:language] || 'simple', :regconfig)
2181 
2182   unless opts[:tsvector]
2183     phrase_cols = full_text_string_join(cols)
2184     cols = Sequel.function(:to_tsvector, lang, phrase_cols)
2185   end
2186 
2187   unless opts[:tsquery]
2188     phrase_terms = terms.is_a?(Array) || terms.is_a?(Set) ? Sequel.array_or_set_join(terms, ' | ') : terms
2189 
2190     query_func = case to_tsquery = opts[:to_tsquery]
2191     when :phrase, :plain
2192       :"#{to_tsquery}to_tsquery"
2193     when :websearch
2194       :"websearch_to_tsquery"
2195     else
2196       (opts[:phrase] || opts[:plain]) ? :plainto_tsquery : :to_tsquery
2197     end
2198 
2199     terms = Sequel.function(query_func, lang, phrase_terms)
2200   end
2201 
2202   ds = where(Sequel.lit(["", " @@ ", ""], cols, terms))
2203 
2204   if opts[:phrase]
2205     raise Error, "can't use :phrase with either :tsvector or :tsquery arguments to full_text_search together" if opts[:tsvector] || opts[:tsquery]
2206     ds = ds.grep(phrase_cols, "%#{escape_like(phrase_terms)}%", :case_insensitive=>true)
2207   end
2208 
2209   if opts[:rank]
2210     ds = ds.reverse{ts_rank_cd(cols, terms)}
2211   end
2212 
2213   if opts[:headline]
2214     ds = ds.select_append{ts_headline(lang, phrase_cols, terms).as(:headline)}
2215   end
2216 
2217   ds
2218 end
insert(*values)

Insert given values into the database.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2221 def insert(*values)
2222   if @opts[:returning]
2223     # Already know which columns to return, let the standard code handle it
2224     super
2225   elsif @opts[:sql] || @opts[:disable_insert_returning]
2226     # Raw SQL used or RETURNING disabled, just use the default behavior
2227     # and return nil since sequence is not known.
2228     super
2229     nil
2230   else
2231     # Force the use of RETURNING with the primary key value,
2232     # unless it has been disabled.
2233     returning(insert_pk).insert(*values){|r| return r.values.first}
2234   end
2235 end
insert_conflict(opts=OPTS)

Handle uniqueness violations when inserting, by updating the conflicting row, using ON CONFLICT. With no options, uses ON CONFLICT DO NOTHING. Options:

:conflict_where

The index filter, when using a partial index to determine uniqueness.

:constraint

An explicit constraint name, has precedence over :target.

:target

The column name or expression to handle uniqueness violations on.

:select

Use ON CONFLICT DO SELECT. This will use the dataset’s lock style. You must use returning on this dataset when using this option.

:select_where

A WHERE condition to use for the select.

:update

A hash of columns and values to set. Uses ON CONFLICT DO UPDATE.

:update_where

A WHERE condition to use for the update.

Examples:

DB[:table].insert_conflict.insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT DO NOTHING

DB[:table].insert_conflict(constraint: :table_a_uidx).insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT ON CONSTRAINT table_a_uidx DO NOTHING

DB[:table].insert_conflict(target: :a).insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT (a) DO NOTHING

DB[:table].insert_conflict(target: :a, conflict_where: {c: true}).insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT (a) WHERE (c IS TRUE) DO NOTHING

DB[:table].insert_conflict(target: :a, update: {b: Sequel[:excluded][:b]}).insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT (a) DO UPDATE SET b = excluded.b

DB[:table].insert_conflict(constraint: :table_a_uidx,
  update: {b: Sequel[:excluded][:b]}, update_where: {Sequel[:table][:status_id] => 1}).insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT ON CONSTRAINT table_a_uidx
# DO UPDATE SET b = excluded.b WHERE (table.status_id = 1)

DB[:table].returning(:a).insert_conflict(target: :a, select: true).insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT (a) DO SELECT RETURNING a

DB[:table].returning(:a).for_update.
  insert_conflict(target: :a, select: true, select_where: {Sequel[:excluded][:b] => 3}).
  insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT (a) DO SELECT FOR UPDATE WHERE (excluded.b = 3) RETURNING a
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2285 def insert_conflict(opts=OPTS)
2286   if opts[:select] && opts[:update]
2287     raise Error, "Cannot provide both :select and :update options to insert_conflict"
2288   end
2289 
2290   clone(:insert_conflict => opts)
2291 end
insert_ignore()

Ignore uniqueness/exclusion violations when inserting, using ON CONFLICT DO NOTHING. Exists mostly for compatibility to MySQL’s insert_ignore. Example:

DB[:table].insert_ignore.insert(a: 1, b: 2)
# INSERT INTO TABLE (a, b) VALUES (1, 2)
# ON CONFLICT DO NOTHING
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2299 def insert_ignore
2300   insert_conflict
2301 end
insert_select(*values)

Insert a record, returning the record inserted, using RETURNING. Always returns nil without running an INSERT statement if disable_insert_returning is used. If the query runs but returns no values, returns false.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2306 def insert_select(*values)
2307   return unless supports_insert_select?
2308   # Handle case where query does not return a row
2309   server?(:default).with_sql_first(insert_select_sql(*values)) || false
2310 end
insert_select_sql(*values)

The SQL to use for an insert_select, adds a RETURNING clause to the insert unless the RETURNING clause is already present.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2314 def insert_select_sql(*values)
2315   ds = opts[:returning] ? self : returning
2316   ds.insert_sql(*values)
2317 end
join_table(type, table, expr=nil, options=OPTS, &block)

Support SQL::AliasedExpression as expr to setup a USING join with a table alias for the USING columns.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2321 def join_table(type, table, expr=nil, options=OPTS, &block)
2322   if expr.is_a?(SQL::AliasedExpression) && expr.expression.is_a?(Array) && !expr.expression.empty? && expr.expression.all?
2323     options = options.merge(:join_using=>true)
2324   end
2325   super
2326 end
lock(mode, opts=OPTS)

Locks all tables in the dataset’s FROM clause (but not in JOINs) with the specified mode (e.g. ‘EXCLUSIVE’). If a block is given, starts a new transaction, locks the table, and yields. If a block is not given, just locks the tables. Note that PostgreSQL will probably raise an error if you lock the table outside of an existing transaction. Returns nil.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2333 def lock(mode, opts=OPTS)
2334   if defined?(yield) # perform locking inside a transaction and yield to block
2335     @db.transaction(opts){lock(mode, opts); yield}
2336   else
2337     sql = 'LOCK TABLE '.dup
2338     source_list_append(sql, @opts[:from])
2339     mode = mode.to_s.upcase.strip
2340     unless LOCK_MODES.include?(mode)
2341       raise Error, "Unsupported lock mode: #{mode}"
2342     end
2343     sql << " IN #{mode} MODE"
2344     @db.execute(sql, opts)
2345   end
2346   nil
2347 end
merge(&block)

Support MERGE RETURNING on PostgreSQL 17+.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2350 def merge(&block)
2351   sql = merge_sql
2352   if uses_returning?(:merge)
2353     returning_fetch_rows(sql, &block)
2354   else
2355     execute_ddl(sql)
2356   end
2357 end
merge_delete_when_not_matched_by_source(&block)

Return a dataset with a WHEN NOT MATCHED BY SOURCE THEN DELETE clause added to the MERGE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.

merge_delete_not_matched_by_source
# WHEN NOT MATCHED BY SOURCE THEN DELETE

merge_delete_not_matched_by_source{a > 30}
# WHEN NOT MATCHED BY SOURCE AND (a > 30) THEN DELETE
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2368 def merge_delete_when_not_matched_by_source(&block)
2369   _merge_when(:type=>:delete_not_matched_by_source, &block)
2370 end
merge_do_nothing_when_matched(&block)

Return a dataset with a WHEN MATCHED THEN DO NOTHING clause added to the MERGE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.

merge_do_nothing_when_matched
# WHEN MATCHED THEN DO NOTHING

merge_do_nothing_when_matched{a > 30}
# WHEN MATCHED AND (a > 30) THEN DO NOTHING
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2381 def merge_do_nothing_when_matched(&block)
2382   _merge_when(:type=>:matched, &block)
2383 end
merge_do_nothing_when_not_matched(&block)

Return a dataset with a WHEN NOT MATCHED THEN DO NOTHING clause added to the MERGE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.

merge_do_nothing_when_not_matched
# WHEN NOT MATCHED THEN DO NOTHING

merge_do_nothing_when_not_matched{a > 30}
# WHEN NOT MATCHED AND (a > 30) THEN DO NOTHING
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2394 def merge_do_nothing_when_not_matched(&block)
2395   _merge_when(:type=>:not_matched, &block)
2396 end
merge_do_nothing_when_not_matched_by_source(&block)

Return a dataset with a WHEN NOT MATCHED BY SOURCE THEN DO NOTHING clause added to the MERGE BY SOURCE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.

merge_do_nothing_when_not_matched_by_source
# WHEN NOT MATCHED BY SOURCE THEN DO NOTHING

merge_do_nothing_when_not_matched_by_source{a > 30}
# WHEN NOT MATCHED BY SOURCE AND (a > 30) THEN DO NOTHING
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2407 def merge_do_nothing_when_not_matched_by_source(&block)
2408   _merge_when(:type=>:not_matched_by_source, &block)
2409 end
merge_insert(*values, &block)

Support OVERRIDING USER|SYSTEM VALUE for MERGE INSERT.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2412 def merge_insert(*values, &block)
2413   h = {:type=>:insert, :values=>values}
2414   if @opts[:override]
2415     h[:override] = insert_override_sql(String.new)
2416   end
2417   _merge_when(h, &block)
2418 end
merge_update_when_not_matched_by_source(values, &block)

Return a dataset with a WHEN NOT MATCHED BY SOURCE THEN UPDATE clause added to the MERGE statement. If a block is passed, treat it as a virtual row and use it as additional conditions for the match.

merge_update_not_matched_by_source(i1: Sequel[:i1]+:i2+10, a: Sequel[:a]+:b+20)
# WHEN NOT MATCHED BY SOURCE THEN UPDATE SET i1 = (i1 + i2 + 10), a = (a + b + 20)

merge_update_not_matched_by_source(i1: :i2){a > 30}
# WHEN NOT MATCHED BY SOURCE AND (a > 30) THEN UPDATE SET i1 = i2
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2429 def merge_update_when_not_matched_by_source(values, &block)
2430   _merge_when(:type=>:update_not_matched_by_source, :values=>values, &block)
2431 end
overriding_system_value()

Use OVERRIDING USER VALUE for INSERT statements, so that identity columns always use the user supplied value, and an error is not raised for identity columns that are GENERATED ALWAYS.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2436 def overriding_system_value
2437   clone(:override=>:system)
2438 end
overriding_user_value()

Use OVERRIDING USER VALUE for INSERT statements, so that identity columns always use the sequence value instead of the user supplied value.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2442 def overriding_user_value
2443   clone(:override=>:user)
2444 end
supports_cte?(type=:select)
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2446 def supports_cte?(type=:select)
2447   if type == :select
2448     server_version >= 80400
2449   else
2450     server_version >= 90100
2451   end
2452 end
supports_cte_in_subqueries?()

PostgreSQL supports using the WITH clause in subqueries if it supports using WITH at all (i.e. on PostgreSQL 8.4+).

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2456 def supports_cte_in_subqueries?
2457   supports_cte?
2458 end
supports_distinct_on?()

DISTINCT ON is a PostgreSQL extension

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2461 def supports_distinct_on?
2462   true
2463 end
supports_group_cube?()

PostgreSQL 9.5+ supports GROUP CUBE

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2466 def supports_group_cube?
2467   server_version >= 90500
2468 end
supports_group_rollup?()

PostgreSQL 9.5+ supports GROUP ROLLUP

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2471 def supports_group_rollup?
2472   server_version >= 90500
2473 end
supports_grouping_sets?()

PostgreSQL 9.5+ supports GROUPING SETS

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2476 def supports_grouping_sets?
2477   server_version >= 90500
2478 end
supports_insert_conflict?()

PostgreSQL 9.5+ supports the ON CONFLICT clause to INSERT.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2486 def supports_insert_conflict?
2487   server_version >= 90500
2488 end
supports_insert_select?()

True unless insert returning has been disabled for this dataset.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2481 def supports_insert_select?
2482   !@opts[:disable_insert_returning]
2483 end
supports_lateral_subqueries?()

PostgreSQL 9.3+ supports lateral subqueries

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2491 def supports_lateral_subqueries?
2492   server_version >= 90300
2493 end
supports_merge?()

PostgreSQL 15+ supports MERGE.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2501 def supports_merge?
2502   server_version >= 150000
2503 end
supports_modifying_joins?()

PostgreSQL supports modifying joined datasets

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2496 def supports_modifying_joins?
2497   true
2498 end
supports_nowait?()

PostgreSQL supports NOWAIT.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2506 def supports_nowait?
2507   true
2508 end
supports_regexp?()

PostgreSQL supports pattern matching via regular expressions

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2521 def supports_regexp?
2522   true
2523 end
supports_returning?(type)

MERGE RETURNING is supported on PostgreSQL 17+. Other RETURNING is supported on all supported PostgreSQL versions.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2512 def supports_returning?(type)
2513   if type == :merge
2514     server_version >= 170000
2515   else
2516     true
2517   end
2518 end
supports_skip_locked?()

PostgreSQL 9.5+ supports SKIP LOCKED.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2526 def supports_skip_locked?
2527   server_version >= 90500
2528 end
supports_timestamp_timezones?()

PostgreSQL supports timezones in literal timestamps

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2533 def supports_timestamp_timezones?
2534   # SEQUEL6: Remove
2535   true
2536 end
supports_window_clause?()

PostgreSQL 8.4+ supports WINDOW clause.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2540 def supports_window_clause?
2541   server_version >= 80400
2542 end
supports_window_function_frame_option?(option)

Base support added in 8.4, offset supported added in 9.0, GROUPS and EXCLUDE support added in 11.0.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2551 def supports_window_function_frame_option?(option)
2552   case option
2553   when :rows, :range
2554     true
2555   when :offset
2556     server_version >= 90000
2557   when :groups, :exclude
2558     server_version >= 110000
2559   else
2560     false
2561   end
2562 end
supports_window_functions?()

PostgreSQL 8.4+ supports window functions

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2545 def supports_window_functions?
2546   server_version >= 80400
2547 end
truncate(opts = OPTS)

Truncates the dataset. Returns nil.

Options:

:cascade

whether to use the CASCADE option, useful when truncating tables with foreign keys.

:only

truncate using ONLY, so child tables are unaffected

:restart

use RESTART IDENTITY to restart any related sequences

:only and :restart only work correctly on PostgreSQL 8.4+.

Usage:

DB[:table].truncate
# TRUNCATE TABLE "table"

DB[:table].truncate(cascade: true, only: true, restart: true)
# TRUNCATE TABLE ONLY "table" RESTART IDENTITY CASCADE
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2580 def truncate(opts = OPTS)
2581   if opts.empty?
2582     super()
2583   else
2584     clone(:truncate_opts=>opts).truncate
2585   end
2586 end
with_ties()

Use WITH TIES when limiting the result set to also include additional rules that have the same results for the order column as the final row. Requires PostgreSQL 13.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2591 def with_ties
2592   clone(:limit_with_ties=>true)
2593 end

Protected Instance methods

_import(columns, values, opts=OPTS)

If returned primary keys are requested, use RETURNING unless already set on the dataset. If RETURNING is already set, use existing returning values. If RETURNING is only set to return a single columns, return an array of just that column. Otherwise, return an array of hashes.

[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2601 def _import(columns, values, opts=OPTS)
2602   if @opts[:returning]
2603     # no transaction: our multi_insert_sql_strategy should guarantee
2604     # that there's only ever a single statement.
2605     sql = multi_insert_sql(columns, values)[0]
2606     returning_fetch_rows(sql).map{|v| v.length == 1 ? v.values.first : v}
2607   elsif opts[:return] == :primary_key
2608     returning(insert_pk)._import(columns, values, opts)
2609   else
2610     super
2611   end
2612 end
to_prepared_statement(type, *a)
[show source] 
     # File lib/sequel/adapters/shared/postgres.rb
2614 def to_prepared_statement(type, *a)
2615   if type == :insert && !@opts.has_key?(:returning)
2616     returning(insert_pk).send(:to_prepared_statement, :insert_pk, *a)
2617   else
2618     super
2619   end
2620 end