DBLINK_B...QL_DELETE(3)

πŸ“¦ version 16.15, in opensuse-leap 16.0

🌸 NAME 🌸

hey bestie, welcome to dblink_build_sql_delete(3) from the PostgreSQL 16.15 documentation πŸ’– this function builds a DELETE statement using supplied values for primary key field values. slay.


✨ SYNOPSIS ✨

dblink_build_sql_delete(text relname,
                        int2vector primary_key_attnums,
                        integer num_primary_key_atts,
                        text[] tgt_pk_att_vals_array) returns text

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so dblink_build_sql_delete can be useful in doing selective replication of a local table to a remote database. it builds an SQL DELETE command that will delete the row with the given primary key values. literally iconic for that remote-db life πŸ’…


πŸŽ€ ARGUMENTS πŸŽ€

  • relname β€” the name of a local relation, for example foo or myschema.mytab. include double quotes if the name is mixed-case or contains special characters, for example "FooBar"; without quotes, the string will be folded to lower case. iykyk 🫢
  • primary_key_attnums β€” attribute numbers (1-based) of the primary key fields, for example 1 2. no cap.
  • num_primary_key_atts β€” the number of primary key fields. that's the whole vibe.
  • tgt_pk_att_vals_array β€” values of the primary key fields to be used in the resulting DELETE command. each field is represented in text form. periodt.

πŸ‘‘ RETURN VALUE πŸ‘‘

it returns the requested SQL statement as text. bestie, that's it β€” pure text realness πŸ’–


⭐ NOTES ⭐

okay so important lore: as of PostgreSQL 9.0, the attribute numbers in primary_key_attnums are interpreted as logical column numbers, corresponding to the column's position in SELECT * FROM relname. previous versions interpreted the numbers as physical column positions. there is a difference if any column(s) to the left of the indicated column have been dropped during the lifetime of the table. so yeah, keep that in mind πŸ’€


πŸ’œ EXAMPLES πŸ’œ

           SELECT dblink_build_sql_delete('"MyFoo"', '1 2', 2, '{"1", "b"}');
                      dblink_build_sql_delete
           ---------------------------------------------
            DELETE FROM "MyFoo" WHERE f1='1' AND f2='b'
           (1 row)

this iconic little page is DBLINK_B...QL_DELETE(3) β€” brought to you by PostgreSQL 16.15, dated 2026. mwah πŸ’‹βœ¨

πŸ“¦ where this page comes from