¿Cómo agregar una columna si no existe en PostgreSQL?

La pregunta es simple. ¿Cómo agregar una columna xa la tabla y, pero solo cuando la xcolumna no existe? Aquí solo encontré una solución para verificar si existe una columna.

SELECT column_name 
FROM information_schema.columns 
WHERE table_name='x' and column_name='y';

Aquí hay una versión corta y dulce que usa la declaración "DO":

DO $$ 
    BEGIN
        BEGIN
            ALTER TABLE <table_name> ADD COLUMN <column_name> <column_type>;
        EXCEPTION
            WHEN duplicate_column THEN RAISE NOTICE 'column <column_name> already exists in <table_name>.';
        END;
    END;
$$

No puede pasarlos como parámetros, deberá realizar una sustitución de variables en la cadena en el lado del cliente, pero esta es una consulta autónoma que solo emite un mensaje si la columna ya existe, agrega si no es así y continuará fallando en otros errores (como un tipo de datos no válido).

No recomiendo hacer CUALQUIERA de estos métodos si se trata de cadenas aleatorias que provienen de fuentes externas. Independientemente del método que utilice (cadenas dinámicas del lado de la hendidura o del lado del servidor ejecutadas como consultas), sería una receta para el desastre, ya que lo abre a los ataques de inyección SQL.

Con Postgres 9.6 esto se puede hacer usando la opciónif not exists

ALTER TABLE table_name ADD COLUMN IF NOT EXISTS column_name INTEGER;

CREATE OR REPLACE function f_add_col(_tbl regclass, _col  text, _type regtype)
  RETURNS bool AS
$func$
BEGIN
   IF EXISTS (SELECT 1 FROM pg_attribute
              WHERE  attrelid = _tbl
              AND    attname = _col
              AND    NOT attisdropped) THEN
      RETURN FALSE;
   ELSE
      EXECUTE format('ALTER TABLE %s ADD COLUMN %I %s', _tbl, _col, _type);
      RETURN TRUE;
   END IF;
END
$func$  LANGUAGE plpgsql;

Llamada:

SELECT f_add_col('public.kat', 'pfad1', 'int');

Devuelve TRUEen caso de éxito, de lo contrario FALSE(la columna ya existe).
Provoca una excepción para una tabla o nombre de tipo no válido.

¿Por qué otra versión?

• Esto podría hacerse con una DOdeclaración, pero las DOdeclaraciones no pueden devolver nada. Y si es para uso repetido, crearía una función.

• Utilizo los tipos de identificadores de objetos regclass y regtypepara _tbly _typeque a) evita la inyección de SQL yb) verifica la validez de ambos de forma inmediata (la forma más barata posible). El nombre de la columna _colaún no se ha desinfectado EXECUTEcon quote_ident(). Más explicación en esta respuesta relacionada:

  • Nombre de la tabla como parámetro de la función PostgreSQL

• format()requiere Postgres 9.1+. Para versiones anteriores concatene manualmente:

  EXECUTE 'ALTER TABLE ' || _tbl || ' ADD COLUMN ' || quote_ident(_col) || ' ' || _type;

• Puede calificar esquemáticamente el nombre de su tabla, pero no tiene que hacerlo.
  Puede comillas dobles los identificadores en la llamada de función para preservar el caso de camello y las palabras reservadas (pero no debe usar nada de esto de todos modos).

• Pregunto en pg_cataloglugar de la information_schema. Explicación detallada:

  • Cómo verificar si existe una tabla en un esquema dado

• Los bloques que contienen una EXCEPTIONcláusula como la respuesta actualmente aceptada son sustancialmente más lentos. Esto es generalmente más simple y rápido. La documentación:

Consejo: Un bloque que contiene una EXCEPTIONcláusula es significativamente más costoso para entrar y salir que un bloque sin una. Por lo tanto, no lo use EXCEPTIONsin necesidad.

La siguiente consulta de selección volverá true/false, utilizando la EXISTS()función.

EXISTS () :
el argumento de EXISTS es una sentencia SELECT arbitraria, o subconsulta. La subconsulta se evalúa para determinar si devuelve alguna fila. Si devuelve al menos una fila, el resultado de EXISTS es "verdadero"; si la subconsulta no devuelve filas, el resultado de EXISTS es "falso"

SELECT EXISTS(SELECT  column_name 
                FROM  information_schema.columns 
               WHERE  table_schema = 'public' 
                 AND  table_name = 'x' 
                 AND  column_name = 'y'); 

y use la siguiente instrucción SQL dinámica para alterar su tabla

DO
$$
BEGIN
IF NOT EXISTS (SELECT column_name 
                 FROM  information_schema.columns 
                WHERE  table_schema = 'public' 
                  AND  table_name = 'x' 
                  AND  column_name = 'y') THEN
ALTER TABLE x ADD COLUMN y int DEFAULT NULL;
ELSE
RAISE NOTICE 'Already exists';
END IF;
END
$$

Para aquellos que usan Postgre 9.5+ (creo que la mayoría de ustedes lo hacen), existe una solución bastante simple y limpia

ALTER TABLE if exists <tablename> add if not exists <columnname> <columntype>

la siguiente función verificará la columna si existe, devolverá el mensaje apropiado; de lo contrario, agregará la columna a la tabla.

create or replace function addcol(schemaname varchar, tablename varchar, colname varchar, coltype varchar)
returns varchar 
language 'plpgsql'
as 
$$
declare 
    col_name varchar ;
begin 
      execute 'select column_name from information_schema.columns  where  table_schema = ' ||
      quote_literal(schemaname)||' and table_name='|| quote_literal(tablename) || '   and    column_name= '|| quote_literal(colname)    
      into   col_name ;   

      raise info  ' the val : % ', col_name;
      if(col_name is null ) then 
          col_name := colname;
          execute 'alter table ' ||schemaname|| '.'|| tablename || ' add column '|| colname || '  ' || coltype; 
      else
           col_name := colname ||' Already exist';
      end if;
return col_name;
end;
$$

Esta es básicamente la solución de sola, pero solo se limpió un poco. Es lo suficientemente diferente como para no solo querer "mejorar" su solución (además, creo que es grosero).

La principal diferencia es que usa el formato EXECUTE. Lo que creo que es un poco más limpio, pero creo que significa que debes estar en PostgresSQL 9.1 o más reciente.

Esto ha sido probado en 9.1 y funciona. Nota: generará un error si el esquema / nombre_tabla / o tipo_datos no son válidos. Eso podría "arreglarse", pero podría ser el comportamiento correcto en muchos casos.

CREATE OR REPLACE FUNCTION add_column(schema_name TEXT, table_name TEXT, 
column_name TEXT, data_type TEXT)
RETURNS BOOLEAN
AS
$BODY$
DECLARE
  _tmp text;
BEGIN

  EXECUTE format('SELECT COLUMN_NAME FROM information_schema.columns WHERE 
    table_schema=%L
    AND table_name=%L
    AND column_name=%L', schema_name, table_name, column_name)
  INTO _tmp;

  IF _tmp IS NOT NULL THEN
    RAISE NOTICE 'Column % already exists in %.%', column_name, schema_name, table_name;
    RETURN FALSE;
  END IF;

  EXECUTE format('ALTER TABLE %I.%I ADD COLUMN %I %s;', schema_name, table_name, column_name, data_type);

  RAISE NOTICE 'Column % added to %.%', column_name, schema_name, table_name;

  RETURN TRUE;
END;
$BODY$
LANGUAGE 'plpgsql';

uso:

select add_column('public', 'foo', 'bar', 'varchar(30)');

Se puede agregar a la función de invocación de scripts de migración y soltar cuando haya terminado.

create or replace function patch_column() returns void as
$$
begin
    if exists (
        select * from information_schema.columns
            where table_name='my_table'
            and column_name='missing_col'
     )
    then
        raise notice 'missing_col already exists';
    else
        alter table my_table
            add column missing_col varchar;
    end if;
end;
$$ language plpgsql;

select patch_column();

drop function if exists patch_column();

En mi caso, por cómo se creó, es un poco difícil para nuestros scripts de migración atravesar diferentes esquemas.

Para evitar esto, usamos una excepción que simplemente captó e ignoró el error. Esto también tuvo el agradable efecto secundario de ser mucho más fácil de ver.

Sin embargo, tenga cuidado de que las otras soluciones tengan sus propias ventajas que probablemente superen a esta solución:

DO $$
BEGIN
  BEGIN
    ALTER TABLE IF EXISTS bobby_tables RENAME COLUMN "dckx" TO "xkcd";
  EXCEPTION
    WHEN undefined_column THEN RAISE NOTICE 'Column was already renamed';
  END;
END $$;

Puedes hacerlo de la siguiente manera.

ALTER TABLE tableName drop column if exists columnName; 
ALTER TABLE tableName ADD COLUMN columnName character varying(8);

Por lo tanto, soltará la columna si ya existe. Y luego agregue la columna a una tabla en particular.

Simplemente verifique si la consulta devolvió un column_name.

Si no, ejecute algo como esto:

ALTER TABLE x ADD COLUMN y int;

Donde pones algo útil para 'x' e 'y' y, por supuesto, un tipo de datos adecuado donde utilicé int.