Types and Roles If Not Exists in PostgreSQL

| databases | programming | sql |

For certain operations such as creating types and roles in PostgreSQL you are not able to use the handy IF NOT EXISTS parameter. This makes creating reusable scripts a bit more challenging, especially if you are going to be running these scripts more than once against the same database. On solution to this problem is to Just Do It™. DO allows you to execute anonymous code blocks. For example, suppose we had a simple task table with a custom type called task_status along with a readerrole that has only select permissions. Using the pg_type and pg_roletables we can write a DO expression that will check to make sure that the elements do not exist before attempting to create them, which will prevent your script from erroring out in the event that they do exist. First we will create the custom type.

DO $$
BEGIN
    IF NOT EXISTS (SELECT 1 FROM pg_type WHERE typname = 'task_status') THEN
        CREATE TYPE task_status AS ENUM ('todo', 'doing', 'blocked', 'done');
    END IF;
END
$$;
Then we can create our table.
CREATE TABLE IF NOT EXISTS
tasks (
  id           integer PRIMARY KEY,
  title        varchar(200), 
  status       task_status NOT NULL DEFAULT 'todo',
  created_date timestamp
);
Next, we can create our new role called reader and grant read only rights on the tasks table.
DO $$
BEGIN
    IF NOT EXISTS (SELECT 1 FROM pg_roles WHERE rolname = 'reader') THEN
        CREATE ROLE reader;
    END IF;
END
$$;
GRANT SELECT ON tasks TO reader;
The entire script is shown below.

You can run this script as many times as you wish and it will just work™, which means that if you are running full migrations then you do not have to do any manual overrides or comment anything out. Note that the reason why we do not have to wrap up the GRANT in a check is because if you duplicate a grant, PostgreSQL will return a notice but not an error.

Thank you for reading! Share your thoughts with me on bluesky, mastodon, or via email.

Check out some more stuff to read down below.

Most popular posts this month

Recent Favorite Blog Posts

This is a collection of the last 8 posts that I bookmarked.

Articles from blogs I follow around the net

Introducing my new Atomic Design Certification Course!

TL;DR: You can preorder my new Atomic Design Certification Course for only $50! Why create an Atomic Design Certification Course? I’ve got big ambitious for this course, and I’m aiming to: Increase design system adoption For years, people (me included!) […

via Blog – Brad Frost July 23, 2025

Issue 89 – Crypto wins in Washington with midnight calls, chocolate bars, and a $141 million threat

Trump stands to profit from a $2 billion bitcoin bet as the crypto industry pushes through bills aimed at bolstering the sector

via Citation Needed July 23, 2025

Pluralistic: Installing Android phones in Blackberry chassis (23 Jul 2025)

Today's links Installing Android phones in Blackberry chassis: From e-waste to a better phone. Hey look at this: Delights to delectate. Object permanence: Owning "freedom of expression"; Spider-silk thread; Auditing your body's code; RIP E…

via Pluralistic: Daily links from Cory Doctorow July 23, 2025

Generated by openring