DBLINK_B...QL_DELETE(3)

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

okay bestie, welcome to the DBLINK_B...QL_DELETE(3) page, straight from the PostgreSQL 15.19 Documentation ✨ this one is all about building a DELETE statement from primary-key values, and it’s lowkey iconic for selective replication. let’s get into it πŸ’–


✨ NAME ✨

dblink_build_sql_delete β€” builds a DELETE statement using supplied values for primary key field values 🎯

🌸 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 πŸ¦‹

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. periodt. πŸ’…

πŸŽ€ 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. no cap, quotes matter here 🫢
  • 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. literally the count πŸ”’
  • 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 whole return vibe ✨

⭐ 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. πŸ‘€πŸ’€

πŸ”₯ 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)
mwah πŸ’‹ β€” PostgreSQL 15.19 docs, dated 2026, signing off bestie! πŸ«ΆπŸ’–
πŸ“¦ where this page comes from