El nombre (opcionalmente calificado por esquema) de la función que se va a crear.

El modo de un argumento: IN, OUT, INOUT o VARIADIC. Si se omite, el valor predeterminado es IN. Solo los argumentos OUT pueden seguir a uno VARIADIC. Además, los argumentos OUT y INOUT no se pueden usar junto con la notación RETURNS TABLE.

El nombre de un argumento. Algunos lenguajes (incluidos SQL y PL/pgSQL) te permiten usar el nombre en el cuerpo de la función. Para otros lenguajes, el nombre de un argumento de entrada es solo documentación adicional en lo que respecta a la función en sí; pero puedes usar los nombres de los argumentos de entrada al llamar a una función para mejorar la legibilidad (consulta la Section 4.3). En cualquier caso, el nombre de un argumento de salida es significativo, porque define el nombre de la columna en el tipo de fila del resultado. (Si omites el nombre de un argumento de salida, el sistema elegirá un nombre de columna por defecto).

El tipo o tipos de datos de los argumentos de la función (opcionalmente calificados por esquema), si los hay. Los tipos de argumentos pueden ser tipos base, compuestos o dominios, o pueden hacer referencia al tipo de una columna de tabla.

Según el lenguaje de implementación, también puede estar permitido especificar «pseudotipos» como cstring. Los pseudotipos indican que el tipo de argumento real está especificado de forma incompleta o está fuera del conjunto de tipos de datos SQL ordinarios.

Se hace referencia al tipo de una columna escribiendo nombre_tabla.nombre_columna%TYPE. El uso de esta característica a veces puede ayudar a que una función sea independiente de los cambios en la definición de una tabla.

Una expresión que se utilizará como valor predeterminado si no se especifica el parámetro. La expresión debe ser coercible al tipo de argumento del parámetro. Solo los parámetros de entrada (incluido INOUT) pueden tener un valor predeterminado. Todos los parámetros de entrada que siguen a un parámetro con un valor predeterminado también deben tener valores predeterminados.

El tipo de datos de retorno (opcionalmente calificado por esquema). El tipo de retorno puede ser un tipo base, compuesto o dominio, o puede hacer referencia al tipo de una columna de tabla. Según el lenguaje de implementación, también puede estar permitido especificar «pseudotipos» como cstring. Si la función no debe devolver un valor, especifica void como tipo de retorno.

Cuando hay parámetros OUT o INOUT, la cláusula RETURNS se puede omitir. Si está presente, debe coincidir con el tipo de resultado implícito por los parámetros de salida: RECORD si hay múltiples parámetros de salida, o el mismo tipo que el único parámetro de salida.

El modificador SETOF indica que la función devolverá un conjunto de elementos, en lugar de un solo elemento.

Se hace referencia al tipo de una columna escribiendo nombre_tabla.nombre_columna%TYPE.

El nombre de una columna de salida en la sintaxis RETURNS TABLE. Esta es efectivamente otra forma de declarar un parámetro OUT nombrado, excepto que RETURNS TABLE también implica RETURNS SETOF.

El tipo de datos de una columna de salida en la sintaxis RETURNS TABLE.

El nombre del lenguaje en el que está implementada la función. Puede ser sql, c, internal o el nombre de un lenguaje procedimental definido por el usuario, por ejemplo, plpgsql. El valor por defecto es sql si se especifica cuerpo_sql. Encerrar el nombre entre comillas simples está obsoleto y requiere que coincidan las mayúsculas y minúsculas.

Enumera qué transformaciones debe aplicar una llamada a la función. Las transformaciones convierten entre tipos SQL y tipos de datos específicos del lenguaje; consulta la CREATE TRANSFORM. Las implementaciones de lenguajes procedimentales suelen tener un conocimiento codificado de los tipos incorporados, por lo que no es necesario enumerarlos aquí. Si una implementación de lenguaje procedimental no sabe cómo manejar un tipo y no se proporciona ninguna transformación, recurrirá a un comportamiento predeterminado para convertir los tipos de datos, pero esto depende de la implementación.

WINDOW indica que la función es una función de ventana (window function) en lugar de una función común. Actualmente, esto solo es útil para funciones escritas en C. El atributo WINDOW no se puede cambiar al reemplazar la definición de una función existente.

Estos atributos informan al optimizador de consultas sobre el comportamiento de la función. Se puede especificar como máximo una opción. Si no aparece ninguna de estas, se asume VOLATILE por defecto.

IMMUTABLE indica que la función no puede modificar la base de datos y siempre devuelve el mismo resultado cuando se le proporcionan los mismos valores de argumentos; es decir, no realiza búsquedas en la base de datos ni utiliza de otro modo información que no esté directamente presente en su lista de argumentos. Si se proporciona esta opción, cualquier llamada a la función con argumentos completamente constantes se puede reemplazar inmediatamente por el valor de la función.

STABLE indica que la función no puede modificar la base de datos y que, dentro de un mismo escaneo de tabla, devolverá consistentemente el mismo resultado para los mismos valores de argumentos, pero que su resultado podría cambiar entre sentencias SQL. Esta es la selección adecuada para funciones cuyos resultados dependen de búsquedas en la base de datos, variables de parámetros (como la zona horaria actual), etc. (Es inapropiada para disparadores AFTER que desean consultar filas modificadas por el comando actual). Ten en cuenta también que la familia de funciones current_timestamp califica como estable, ya que sus valores no cambian dentro de una transacción.

VOLATILE indica que el valor de la función puede cambiar incluso dentro de un mismo escaneo de tabla, por lo que no se pueden realizar optimizaciones. Relativamente pocas funciones de base de datos son volátiles en este sentido; algunos ejemplos son random(), currval(), timeofday(). Pero ten en cuenta que cualquier función que tenga efectos secundarios debe clasificarse como volátil, incluso si su resultado es bastante predecible, para evitar que las llamadas se optimicen y eliminen; un ejemplo es setval().

Para obtener detalles adicionales, consulta la Section 36.7.

LEAKPROOF indica que la función no tiene efectos secundarios. No revela información sobre sus argumentos más que a través de su valor de retorno. Por ejemplo, una función que lanza un mensaje de error para algunos valores de argumentos pero no para otros, o que incluye los valores de los argumentos en cualquier mensaje de error, no es estanca (leakproof). Esto afecta a cómo el sistema ejecuta las consultas contra vistas creadas con la opción security_barrier o tablas con seguridad a nivel de fila (RLS) habilitada. El sistema hará cumplir las condiciones de las políticas de seguridad y de las vistas de barrera de seguridad antes de cualquier condición proporcionada por el usuario desde la propia consulta que contenga funciones no estancas, con el fin de evitar la exposición involuntaria de datos. Las funciones y operadores marcados como estancos se asumen confiables y pueden ejecutarse antes de las condiciones de las políticas de seguridad y vistas de barrera de seguridad. Además, las funciones que no reciben argumentos o a las que no se les pasa ningún argumento desde la vista de barrera de seguridad o la tabla no tienen que estar marcadas como estancas para ejecutarse antes de las condiciones de seguridad. Consulta la CREATE VIEW y la Section 39.5. Esta opción solo puede ser establecida por el superusuario.

CALLED ON NULL INPUT (el valor predeterminado) indica que la función se llamará normalmente cuando algunos de sus argumentos sean nulos. Es entonces responsabilidad del autor de la función verificar si hay valores nulos si es necesario y responder adecuadamente.

RETURNS NULL ON NULL INPUT o STRICT indica que la función siempre devuelve nulo cuando alguno de sus argumentos es nulo. Si se especifica este parámetro, la función no se ejecuta cuando hay argumentos nulos; en su lugar, se asume automáticamente un resultado nulo.

SECURITY INVOKER indica que la función se debe ejecutar con los privilegios del usuario que la llama. Ese es el valor predeterminado. SECURITY DEFINER especifica que la función se debe ejecutar con los privilegios del usuario que la posee. Para obtener información sobre cómo escribir funciones SECURITY DEFINER de forma segura, consulta más abajo.

La palabra clave EXTERNAL se permite para cumplir con el estándar SQL, pero es opcional ya que, a diferencia de SQL, esta característica se aplica a todas las funciones, no solo a las externas.

PARALLEL UNSAFE indica que la función no se puede ejecutar en modo paralelo; la presencia de dicha función en una sentencia SQL fuerza un plan de ejecución secuencial. Este es el valor por defecto. PARALLEL RESTRICTED indica que la función se puede ejecutar en modo paralelo, pero solo en el proceso líder del grupo paralelo. PARALLEL SAFE indica que la función es segura para ejecutarse en modo paralelo sin restricciones, incluso en procesos trabajadores paralelos.

Las funciones deben etiquetarse como inseguras para paralelismo (parallel unsafe) si modifican cualquier estado de la base de datos, cambian el estado de la transacción (salvo mediante el uso de una subtransacción para la recuperación de errores), acceden a secuencias (por ejemplo, llamando a currval) o realizan cambios persistentes en la configuración. Deben etiquetarse como restringidas para paralelismo (parallel restricted) si acceden a tablas temporales, al estado de la conexión del cliente, cursores, sentencias preparadas o estado local del backend diverso que el sistema no puede sincronizar en modo paralelo (por ejemplo, setseed no puede ser ejecutado por otro proceso que no sea el líder del grupo porque un cambio realizado por otro proceso no se reflejaría en el líder). En general, si una función se etiqueta como segura cuando en realidad es restringida o insegura, o si se etiqueta como restringida cuando en realidad es insegura, puede lanzar errores o producir respuestas incorrectas cuando se utiliza en una consulta paralela. Las funciones en lenguaje C podrían, en teoría, exhibir un comportamiento totalmente indefinido si se etiquetan incorrectamente, ya que no hay forma de que el sistema se proteja contra código C arbitrario, pero en la mayoría de los casos probables el resultado no será peor que para cualquier otra función. En caso de duda, las funciones deben etiquetarse como UNSAFE, que es el valor por defecto.

Un número positivo que indica el costo de ejecución estimado para la función, en unidades de cpu_operator_cost. Si la función devuelve un conjunto, este es el costo por fila devuelta. Si no se especifica el costo, se asume 1 unidad para las funciones en lenguaje C e internas, y 100 unidades para las funciones en todos los demás lenguajes. Los valores más grandes hacen que el planificador intente evitar evaluar la función más a menudo de lo necesario.

Un número positivo que proporciona el número estimado de filas que el planificador debe esperar que devuelva la función. Esto solo se permite cuando la función se declara para devolver un conjunto. Se asume por defecto 1000 filas.

El nombre (opcionalmente calificado por esquema) de una función de soporte del planificador (planner support function) para usar con esta función. Consulta la Section 36.11 para más detalles. Debes ser superusuario para usar esta opción.

La cláusula SET hace que el parámetro de configuración especificado se establezca en el valor indicado al entrar a la función, y luego se restaure a su valor anterior al salir de ella. SET FROM CURRENT guarda el valor del parámetro que está activo cuando se ejecuta CREATE FUNCTION como el valor que se aplicará al entrar a la función.

Si se adjunta una cláusula SET a una función, los efectos de un comando SET LOCAL ejecutado dentro de la función para la misma variable se limitan a la función: el valor anterior del parámetro de configuración se restaura al salir de la función. Sin embargo, un comando SET ordinario (sin LOCAL) anula la cláusula SET, al igual que lo haría para un comando SET LOCAL anterior: los efectos de dicho comando persistirán después de salir de la función, a menos que se revierta la transacción actual.

Consulta la SET y la Chapter 19 para obtener más información sobre los nombres y valores de parámetros permitidos.

Una constante de cadena que define la función; el significado depende del lenguaje. Puede ser el nombre de una función interna, la ruta a un archivo de objeto, un comando SQL o texto en un lenguaje procedimental.

A menudo resulta útil usar la delimitación por dólares (dollar quoting, consulta la Section 4.1.2.4) para escribir la cadena de definición de la función, en lugar de la sintaxis normal de comillas simples. Sin la delimitación por dólares, las comillas simples o barras invertidas en la definición de la función deben escaparse duplicándolas.

Esta forma de la cláusula AS se utiliza para funciones en lenguaje C cargables dinámicamente cuando el nombre de la función en el código fuente del lenguaje C no es el mismo que el nombre de la función SQL. La cadena archivo_objeto es el nombre del archivo de biblioteca compartida que contiene la función C compilada, y se interpreta como en el comando LOAD. La cadena símbolo_enlace es el símbolo de enlace de la función, es decir, el nombre de la función en el código fuente del lenguaje C. Si se omite el símbolo de enlace, se asume que es el mismo que el nombre de la función SQL que se está definiendo. Los nombres C de todas las funciones deben ser diferentes, por lo que debes dar a las funciones C sobrecargadas diferentes nombres C (por ejemplo, usar los tipos de argumentos como parte de los nombres C).

Cuando llamadas repetidas a CREATE FUNCTION hacen referencia al mismo archivo de objeto, el archivo solo se carga una vez por sesión. Para descargar y volver a cargar el archivo (quizás durante el desarrollo), inicia una nueva sesión.

El cuerpo de una función LANGUAGE SQL. Esto puede ser una sola sentencia

RETURN expresión

o un bloque

BEGIN ATOMIC
  sentencia;
  sentencia;
  ...
  sentencia;
END

Esto es similar a escribir el texto del cuerpo de la función como una constante de cadena (consulta definición más arriba), pero existen algunas diferencias: esta forma solo funciona para LANGUAGE SQL, mientras que la forma de constante de cadena funciona para todos los lenguajes. Esta forma se analiza (parse) en el momento de la definición de la función, mientras que la forma de constante de cadena se analiza en el momento de la ejecución; por lo tanto, esta forma no admite tipos de argumentos polimórficos ni otros constructos que no se puedan resolver en el momento de la definición de la función. Esta forma rastrea las dependencias entre la función y los objetos utilizados en el cuerpo de la función, por lo que DROP ... CASCADE funcionará correctamente, mientras que la forma que utiliza literales de cadena puede dejar funciones huérfanas. Finalmente, esta forma es más compatible con el estándar SQL y otras implementaciones de SQL.