Créer un ROLE PostgreSQL (utilisateur) s'il n'existe pas

Comment écrire un script SQL pour créer un ROLE dans PostgreSQL 9.1, mais sans générer d'erreur s'il existe déjà?

Le script actuel a simplement:

CREATE ROLE my_user LOGIN PASSWORD 'my_password';

Cela échoue si l'utilisateur existe déjà. J'aimerais quelque chose comme:

IF NOT EXISTS (SELECT * FROM pg_user WHERE username = 'my_user')
BEGIN
    CREATE ROLE my_user LOGIN PASSWORD 'my_password';
END;

... mais cela ne fonctionne pas - IFne semble pas être pris en charge en SQL brut.

J'ai un fichier batch qui crée une base de données PostgreSQL 9.1, un rôle et quelques autres choses. Il appelle psql.exe, en passant le nom d'un script SQL à exécuter. Jusqu'à présent, tous ces scripts sont du SQL pur et j'aimerais éviter PL / pgSQL et autres, si possible.

Simplifiez de la même manière que ce que vous aviez en tête:

DO
$do$
BEGIN
   IF NOT EXISTS (
      SELECT FROM pg_catalog.pg_roles  -- SELECT list can be empty for this
      WHERE  rolname = 'my_user') THEN

      CREATE ROLE my_user LOGIN PASSWORD 'my_password';
   END IF;
END
$do$;

(S'appuyant sur la réponse de @a_horse_with_no_name et amélioré avec le commentaire de @ Gregory .)

Contrairement à, par exemple, CREATE TABLEil n'y a pas de IF NOT EXISTSclause pour CREATE ROLE(jusqu'à au moins pg 12). Et vous ne pouvez pas exécuter des instructions DDL dynamiques en SQL brut.

Votre demande "d'éviter PL / pgSQL" est impossible sauf en utilisant un autre PL. L' DOinstruction utilise plpgsql comme langage procédural par défaut. La syntaxe permet d'omettre la déclaration explicite:

DO [ LANGUAGE lang_name ] code
... Le nom du langage procédural dans lequel le code est écrit. S'il est omis, la valeur par défaut est .
lang_name
plpgsql

La réponse acceptée souffre d'une condition de concurrence si deux de ces scripts sont exécutés simultanément sur le même cluster Postgres (serveur de base de données), comme cela est courant dans les environnements d'intégration continue .

Il est généralement plus sûr d'essayer de créer le rôle et de gérer les problèmes avec élégance lors de sa création:

DO $$
BEGIN
  CREATE ROLE my_role WITH NOLOGIN;
  EXCEPTION WHEN DUPLICATE_OBJECT THEN
  RAISE NOTICE 'not creating role my_role -- it already exists';
END
$$;

Ou si le rôle n'est le propriétaire d'aucun objet de base de données, on peut utiliser:

DROP ROLE IF EXISTS my_user;
CREATE ROLE my_user LOGIN PASSWORD 'my_password';

Mais seulement si la suppression de cet utilisateur ne fera aucun mal.

Alternative à Bash (pour les scripts Bash ):

psql -h localhost -U postgres -tc \
"SELECT 1 FROM pg_user WHERE usename = 'my_user'" \
| grep -q 1 \
|| psql -h localhost -U postgres \
-c "CREATE ROLE my_user LOGIN PASSWORD 'my_password';"

(n'est pas la réponse à la question! c'est seulement pour ceux qui peuvent être utiles)

Voici une solution générique utilisant plpgsql:

CREATE OR REPLACE FUNCTION create_role_if_not_exists(rolename NAME) RETURNS TEXT AS
$$
BEGIN
    IF NOT EXISTS (SELECT * FROM pg_roles WHERE rolname = rolename) THEN
        EXECUTE format('CREATE ROLE %I', rolename);
        RETURN 'CREATE ROLE';
    ELSE
        RETURN format('ROLE ''%I'' ALREADY EXISTS', rolename);
    END IF;
END;
$$
LANGUAGE plpgsql;

Usage:

posgres=# SELECT create_role_if_not_exists('ri');
 create_role_if_not_exists 
---------------------------
 CREATE ROLE
(1 row)
posgres=# SELECT create_role_if_not_exists('ri');
 create_role_if_not_exists 
---------------------------
 ROLE 'ri' ALREADY EXISTS
(1 row)

Quelques réponses suggèrent d'utiliser le modèle: vérifiez si le rôle n'existe pas et si ce n'est pas le cas, lancez la CREATE ROLEcommande. Cela a un inconvénient: la condition de course. Si quelqu'un d'autre crée un nouveau rôle entre la vérification et l'émission de la CREATE ROLEcommande, il CREATE ROLEéchoue évidemment avec une erreur fatale.

Pour résoudre le problème ci-dessus, d'autres réponses ont déjà mentionné l'utilisation de PL/pgSQL, l'émission CREATE ROLEinconditionnelle, puis la capture des exceptions de cet appel. Il n'y a qu'un seul problème avec ces solutions. Ils abandonnent silencieusement toutes les erreurs, y compris celles qui ne sont pas générées par le fait que ce rôle existe déjà. CREATE ROLEpeut également générer d'autres erreurs et la simulation IF NOT EXISTSne devrait faire taire l'erreur que lorsque le rôle existe déjà.

CREATE ROLElancer une duplicate_objecterreur lorsque le rôle existe déjà. Et le gestionnaire d'exceptions ne doit intercepter que cette seule erreur. Comme d'autres réponses l'ont mentionné, il est judicieux de convertir l'erreur fatale en simple avis. D'autres IF NOT EXISTScommandes PostgreSQL s'ajoutent , skippingà leur message, donc par souci de cohérence, je les ajoute ici aussi.

Voici le code SQL complet pour la simulation CREATE ROLE IF NOT EXISTSavec l'exception correcte et la propagation sqlstate:

DO $$
BEGIN
CREATE ROLE test;
EXCEPTION WHEN duplicate_object THEN RAISE NOTICE '%, skipping', SQLERRM USING ERRCODE = SQLSTATE;
END
$$;

Sortie de test (appelée deux fois via DO puis directement):

$ sudo -u postgres psql
psql (9.6.12)
Type "help" for help.

postgres=# \set ON_ERROR_STOP on
postgres=# \set VERBOSITY verbose
postgres=# 
postgres=# DO $$
postgres$# BEGIN
postgres$# CREATE ROLE test;
postgres$# EXCEPTION WHEN duplicate_object THEN RAISE NOTICE '%, skipping', SQLERRM USING ERRCODE = SQLSTATE;
postgres$# END
postgres$# $$;
DO
postgres=# 
postgres=# DO $$
postgres$# BEGIN
postgres$# CREATE ROLE test;
postgres$# EXCEPTION WHEN duplicate_object THEN RAISE NOTICE '%, skipping', SQLERRM USING ERRCODE = SQLSTATE;
postgres$# END
postgres$# $$;
NOTICE:  42710: role "test" already exists, skipping
LOCATION:  exec_stmt_raise, pl_exec.c:3165
DO
postgres=# 
postgres=# CREATE ROLE test;
ERROR:  42710: role "test" already exists
LOCATION:  CreateRole, user.c:337

Comme vous êtes sur 9.x, vous pouvez encapsuler cela dans une instruction DO:

do 
$body$
declare 
  num_users integer;
begin
   SELECT count(*) 
     into num_users
   FROM pg_user
   WHERE usename = 'my_user';

   IF num_users = 0 THEN
      CREATE ROLE my_user LOGIN PASSWORD 'my_password';
   END IF;
end
$body$
;

Mon équipe rencontrait une situation avec plusieurs bases de données sur un serveur, selon la base de données à laquelle vous vous êtes connecté, le ROLE en question n'a pas été renvoyé par SELECT * FROM pg_catalog.pg_user, comme proposé par @ erwin-brandstetter et @a_horse_with_no_name. Le bloc conditionnel s'est exécuté et nous avons frappé role "my_user" already exists.

Malheureusement, nous ne sommes pas sûrs des conditions exactes, mais cette solution résout le problème:

        DO  
        $body$
        BEGIN
            CREATE ROLE my_user LOGIN PASSWORD 'my_password';
        EXCEPTION WHEN others THEN
            RAISE NOTICE 'my_user role exists, not re-creating';
        END
        $body$

Il pourrait probablement être rendu plus précis pour exclure d'autres exceptions.

Vous pouvez le faire dans votre fichier de commandes en analysant la sortie de:

SELECT * FROM pg_user WHERE usename = 'my_user'

puis réexécutez psql.exesi le rôle n'existe pas.

La même solution que pour Simulate CREATE DATABASE IF NOT EXISTS pour PostgreSQL? devrait fonctionner - envoyez un CREATE USER …à \gexec.

Solution de contournement à partir de psql

SELECT 'CREATE USER my_user'
WHERE NOT EXISTS (SELECT FROM pg_catalog.pg_roles WHERE rolname = 'my_user')\gexec

Solution de contournement depuis le shell

echo "SELECT 'CREATE USER my_user' WHERE NOT EXISTS (SELECT FROM pg_catalog.pg_roles WHERE rolname = 'my_user')\gexec" | psql

Voir la réponse acceptée ici pour plus de détails.