Types and Roles If Not Exists in PostgreSQL

March 28, 2016 | 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.

My next chapter with Mastodon from Mastodon Blog
How many pillars of observability can you fit on the head of a pin? from charity.wtf
The Software Essays that Shaped Me from Refactoring English
Give Your Spouse the Gift of a Couple's Email Domain from mtlynch.io
Skip the Next iPhone from Articles on Jose M.
Have smart glasses finally hit an inflection point? from The Torment Nexus
The McPhee method from the jsomers.net blog
Pluralistic: LLMs are slot-machines (16 Aug 2025) from Pluralistic: Daily links from Cory Doctorow

Articles from blogs I follow around the net

Caitlin Rose Boyle

Cartoonist, storyboard artist

via Uses This November 29, 2025

[RIDGELINE] No Phones in The Ten-don Shop

Ridgeline subscribers — (Originally published in Japanese in Esquire Japan, October 2025) Some twenty-three years ago in Tokyo, I used to eat at a funny little tendon shop called Imoya. I was a student at Waseda University back then, and this place was a ca…

via Craig Mod — Writer + Photographer November 29, 2025

Jensen Huang Screwed Up Big Time, Revealed Big Tech’s Big Lie

Capitalists Gonna Capitalize on November 28, 2025 In a recent leaked all-hands meeting, Nvidia CEO Jensen Huang responded to a question regarding managers within the company leaning towards less frequent use of Generative AI with the following: My under…

via The Internet Review November 28, 2025

Generated by openring