Types and Roles If Not Exists in PostgreSQL
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_role
tables 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 $$;
CREATE TABLE IF NOT EXISTS tasks ( id integer PRIMARY KEY, title varchar(200), status task_status NOT NULL DEFAULT 'todo', created_date timestamp );
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;
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
- 2024
- Reinstalling Windows at 1am
- SQLite DB Migrations with PRAGMA user_version
- My Custom Miniflux CSS Theme
- How to Disable Wayland in Debian Testing
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- 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
- Pluralistic: Bluesky creates the world's weirdest, hardest-to-understand binding arbitration clause (15 Aug 2025) from Pluralistic: Daily links from Cory Doctorow
- Just a Little More Context Bro, I Promise, and It’ll Fix Everything from Jim Nielsen’s Blog
- The Futzing Fraction from Deciphering Glyph
Articles from blogs I follow around the net
Give a Problem. Grow a Programmer.
In 2009, I kicked off my senior year in college with a class that ultimately changed the way I thought about my degree—and my future.
via flower.codes September 15, 2025Yala stablecoin depegs after theft
The YU bitcoin-backed stablecoin list its intended dollar peg after what they described as "an attempted attack", later writing that there was an "unauthorized transfer of funds". Although they initially wrote that …
via Web3 is Going Just Great September 15, 2025How big a solar battery do I need to store *all* my home's electricity?
I have a modest set of solar panels on an entirely ordinary house in suburban London. On average they generate about 3,800kWh per year. We also use about 3,800kWh of electricity each year. Obviously, we can't use all the power produced over summer an…
via Terence Eden’s Blog September 15, 2025Generated by openring