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.
- workflows for ai coding from /* 🤖🛠️ */
- Reinvent the Wheel from Matthias Endler
- CAPTCHAs are over (in ticketing) from pretix – behind the scenes
- You Can Choose Tools That Make You Happy from Fernando Borretti
- Using Git as S3 from Kris Tun
- Future Fonts from Blog – Brad Frost
- 21st Century C++ from Communications of the ACM
- Submarines DevCon 2025 Keynote Speech from JoshHaines.com
Articles from blogs I follow around the net
Tradeoffs to Continuous Software?
I came across this post from the tech collective crftd. about how software is in a process of “continuous disintegration”: One of the uncomfortable truths we sometimes have to break to people is that software isn't just never “done”. Worse even, it rot…
via Jim Nielsen’s Blog May 28, 2025Pluralistic: America is a scam (28 May 2025)
Today's links America is a scam: Welcome to the age of cheating. Hey look at this: Delights to delectate. Object permanence: 2010, 2015, 2020 Upcoming appearances: Where to find me. Recent appearances: Where I've been. Latest books: You keep readi…
via Pluralistic: Daily links from Cory Doctorow May 28, 2025How I taught my 3-year-old to read like a 9-year-old
Tripling reading level through tutoring
via The Intrinsic Perspective May 28, 2025Generated by openring