DBLINK_B...QL_DELETE(3)

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

okay bestie, welcome to the dblink_build_sql_delete(3) page from the PostgreSQL 13.23 Documentation. this one is literally a little SQL-statement-building helper, and yes, the vibes are immaculate ✨


πŸ’– NAME πŸ’–

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

✨ 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 a SQL DELETE command that will delete the row with the given primary key values. no cap, that's the whole flex. πŸ’…

πŸŽ€ 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. ✨

πŸ’… 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. lowkey important, bestie. 🫢

πŸ“ 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 πŸ’‹ that's the whole page, bestie β€” brought to you by the PostgreSQL 13.23 docs, dated 2025, and filed under dblink_build_sql_delete(3). πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from