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
- Setting up ANTLR4 on Windows
- Meritocracy?
- Possible Plagiarism Made me Cringe
- SQLite DB Migrations with PRAGMA user_version
- Using Plex with Nextcloud
Recent Favorite Blog Posts
This is a collection of the last 8 posts that I bookmarked.
- The Rise of Bluesky from Communications of the ACM
- Podcaster, DJ, and writer DJ Louie XIV on going for it (even if you’re terrified) from The Creative Independent
- Useful Bluesky Tools from Robb Knight • Posts • Atom Feed
- Re: Bluesky from Colin Devroe
- From the Red Hell to the Sky of Blue from Straphanger
- We don’t need to use what we make from Derek Sivers blog
- Ubuntu Summit 2024: A joyful experience filled with sorrow from Planet KDE | English
- Sabotage from jwz
Articles from blogs I follow around the net
13/12/2024
# I can't believe it's been over a month since the last post. Not very good for someone who's supposed to be back. Still, I've also been struggling to get back to making music again; I've had a couple of ideas and put them on SoundClou…
via Colin Walker - Daily Feed December 18, 2024Christmas with Grubbs – an animated holiday special I worked on that you and your kids will love.
I am part of an animated holiday special and you can watch it on YouTube for free! Christmas With Grubbs is an animated holiday special based on Max Weaver's comic. It's about a little boy and his imaginary friend who get into all sorts of mischie…
via WIL WHEATON dot NET December 17, 2024Businessweek: Crypto Got What It Wanted in November’s Election. Now What?
The industry is now in a position to weaken financial rules that might protect consumers from the next crypto crash.
via Citation Needed December 17, 2024