DBLINK_B...QL_DELETE(3)

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

πŸ’– NAME πŸ’–

okay so bestie, welcome to dblink_build_sql_delete(3) from the PostgreSQL 14.24 Documentation! 🌸 This is the page for dblink_build_sql_delete, and it builds a DELETE statement using supplied values for primary key field values. lowkey iconic helper behavior. πŸ’…

✨ SYNOPSIS ✨

the signature is giving:

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

πŸ¦‹ DESCRIPTION πŸ¦‹

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. no cap, that's the whole vibe: you hand it the primary key values, it hands you back the DELETE. πŸŽ€

πŸ’… ARGUMENTS πŸ’…

  • relname β€” 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. πŸ™ˆ
  • primary_key_attnums β€” attribute numbers (1-based) of the primary key fields, for example 1 2. 🧚
  • num_primary_key_atts β€” the number of primary key fields. πŸ”₯
  • 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. πŸ’œ

πŸ‘‘ RETURN VALUE πŸ‘‘

Returns the requested SQL statement as text. slay, that's the return value, periodt. πŸ’«

🌈 NOTES 🌈

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 yes, dropped columns can make this spicy in a historical-version way β€” keep that in mind, bestie. 🫢

πŸ“ EXAMPLES πŸ“

here's the example from the page, copied exactly:

           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)

mwah πŸ’‹ β€” this iconic page is from PostgreSQL 14.24, dated 2026, and the footer vibes are DBLINK_B...QL_DELETE(3). periodt. ✨

πŸ“¦ where this page comes from