DBLINK_GET_PKEY(3)

💖 NAME 💖

okay bestie, this is the DBLINK_GET_PKEY(3) page — the dblink_get_pkey manual from the PostgreSQL 13.23 Documentation — and it literally returns the positions and field names of a relation's primary key fields. periodt. 👑

---

✨ SYNOPSIS ✨

dblink_get_pkey(text relname) returns setof dblink_pkey_results

---

🦋 DESCRIPTION 🦋

So dblink_get_pkey gives you info about the primary key of a relation in the local database. Sometimes that's useful when you're generating queries to send to remote databases, and honestly? iconic little helper behavior. 💅

---

🎀 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 ✨

---

🌸 RETURN VALUE 🌸

It returns one row for each primary key field, or no rows if the relation has no primary key. The result row type is defined as:

CREATE TYPE dblink_pkey_results AS (position int, colname text);

The position column simply runs from 1 to N; it is the number of the field within the primary key, not the number within the table's columns. bestie, do not mix those up 😭

---

🔥 EXAMPLES 🔥

CREATE TABLE foobar (
    f1 int,
    f2 int,
    f3 int,
    PRIMARY KEY (f1, f2, f3)
);
CREATE TABLE

SELECT * FROM dblink_get_pkey('foobar');
 position | colname
----------+---------
        1 | f1
        2 | f2
        3 | f3
(3 rows)

---

that's the whole page, bestie 💖 — PostgreSQL 13.23, 2025, the DBLINK_GET_PKEY(3) manual. slay and bye 🫶