← All packages

PostgreSQL

Pulumi Official

Package maintained by Pulumi

v3.5.0 published on Wednesday, Jun 15, 2022 by Pulumi

Source code

Function

The postgresql.Function resource creates and manages a function on a PostgreSQL server.

Usage

import * as pulumi from "@pulumi/pulumi";
import * as postgresql from "@pulumi/postgresql";

const increment = new postgresql.Function("increment", {
    args: [{
        name: "i",
        type: "integer",
    }],
    body: `    AS $
    BEGIN
        RETURN i + 1;
    END;
    $ LANGUAGE plpgsql;
`,
    returns: "integer",
});

import pulumi
import pulumi_postgresql as postgresql

increment = postgresql.Function("increment",
    args=[postgresql.FunctionArgArgs(
        name="i",
        type="integer",
    )],
    body="""    AS $
    BEGIN
        RETURN i + 1;
    END;
    $ LANGUAGE plpgsql;

""",
    returns="integer")

using Pulumi;
using PostgreSql = Pulumi.PostgreSql;

class MyStack : Stack
{
    public MyStack()
    {
        var increment = new PostgreSql.Function("increment", new PostgreSql.FunctionArgs
        {
            Args = 
            {
                new PostgreSql.Inputs.FunctionArgArgs
                {
                    Name = "i",
                    Type = "integer",
                },
            },
            Body = @"    AS $
    BEGIN
        RETURN i + 1;
    END;
    $ LANGUAGE plpgsql;

",
            Returns = "integer",
        });
    }

}

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-postgresql/sdk/v3/go/postgresql"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := postgresql.NewFunction(ctx, "increment", &postgresql.FunctionArgs{
			Args: FunctionArgArray{
				&FunctionArgArgs{
					Name: pulumi.String("i"),
					Type: pulumi.String("integer"),
				},
			},
			Body:    pulumi.String(fmt.Sprintf("%v%v%v%v%v%v%v%v%v%v", "    AS ", "$", "\n", "    BEGIN\n", "        RETURN i + 1;\n", "    END;\n", "    ", "$", " LANGUAGE plpgsql;\n", "\n")),
			Returns: pulumi.String("integer"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var increment = new Function("increment", FunctionArgs.builder()        
            .args(FunctionArg.builder()
                .name("i")
                .type("integer")
                .build())
            .body("""
    AS $
    BEGIN
        RETURN i + 1;
    END;
    $ LANGUAGE plpgsql;

            """)
            .returns("integer")
            .build());

        }
}

resources:
  increment:
    type: postgresql:Function
    properties:
      args:
        - name: i
          type: integer
      body: |2+
            AS $
            BEGIN
                RETURN i + 1;
            END;
            $ LANGUAGE plpgsql;

      returns: integer

Create a Function Resource

new Function(name: string, args: FunctionArgs, opts?: CustomResourceOptions);

@overload
def Function(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             args: Optional[Sequence[FunctionArgArgs]] = None,
             body: Optional[str] = None,
             drop_cascade: Optional[bool] = None,
             name: Optional[str] = None,
             returns: Optional[str] = None,
             schema: Optional[str] = None)
@overload
def Function(resource_name: str,
             args: FunctionArgs,
             opts: Optional[ResourceOptions] = None)

func NewFunction(ctx *Context, name string, args FunctionArgs, opts ...ResourceOption) (*Function, error)

public Function(string name, FunctionArgs args, CustomResourceOptions? opts = null)

public Function(String name, FunctionArgs args)
public Function(String name, FunctionArgs args, CustomResourceOptions options)

type: postgresql:Function
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FunctionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args FunctionArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args FunctionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FunctionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FunctionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Function Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Function resource accepts the following input properties:

Body string: Function body. This should be everything after the return type in the function definition.
Args List<Pulumi.PostgreSql.Inputs.FunctionArgArgs>: List of arguments for the function.
DropCascade bool: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
Name string: The name of the argument.
Returns string: Type that the function returns.
Schema string: The schema where the function is located. If not specified, the function is created in the current schema.

Body string: Function body. This should be everything after the return type in the function definition.
Args []FunctionArgArgs: List of arguments for the function.
DropCascade bool: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
Name string: The name of the argument.
Returns string: Type that the function returns.
Schema string: The schema where the function is located. If not specified, the function is created in the current schema.

body String: Function body. This should be everything after the return type in the function definition.
args List<FunctionArgArgs>: List of arguments for the function.
dropCascade Boolean: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name String: The name of the argument.
returns String: Type that the function returns.
schema String: The schema where the function is located. If not specified, the function is created in the current schema.

body string: Function body. This should be everything after the return type in the function definition.
args FunctionArgArgs[]: List of arguments for the function.
dropCascade boolean: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name string: The name of the argument.
returns string: Type that the function returns.
schema string: The schema where the function is located. If not specified, the function is created in the current schema.

body str: Function body. This should be everything after the return type in the function definition.
args Sequence[FunctionArgArgs]: List of arguments for the function.
drop_cascade bool: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name str: The name of the argument.
returns str: Type that the function returns.
schema str: The schema where the function is located. If not specified, the function is created in the current schema.

body String: Function body. This should be everything after the return type in the function definition.
args List<Property Map>: List of arguments for the function.
dropCascade Boolean: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name String: The name of the argument.
returns String: Type that the function returns.
schema String: The schema where the function is located. If not specified, the function is created in the current schema.

Outputs

All input properties are implicitly available as output properties. Additionally, the Function resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up an Existing Function Resource

Get an existing Function resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FunctionState, opts?: CustomResourceOptions): Function

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        args: Optional[Sequence[FunctionArgArgs]] = None,
        body: Optional[str] = None,
        drop_cascade: Optional[bool] = None,
        name: Optional[str] = None,
        returns: Optional[str] = None,
        schema: Optional[str] = None) -> Function

func GetFunction(ctx *Context, name string, id IDInput, state *FunctionState, opts ...ResourceOption) (*Function, error)

public static Function Get(string name, Input<string> id, FunctionState? state, CustomResourceOptions? opts = null)

public static Function get(String name, Output<String> id, FunctionState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Args List<Pulumi.PostgreSql.Inputs.FunctionArgArgs>: List of arguments for the function.
Body string: Function body. This should be everything after the return type in the function definition.
DropCascade bool: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
Name string: The name of the argument.
Returns string: Type that the function returns.
Schema string: The schema where the function is located. If not specified, the function is created in the current schema.

Args []FunctionArgArgs: List of arguments for the function.
Body string: Function body. This should be everything after the return type in the function definition.
DropCascade bool: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
Name string: The name of the argument.
Returns string: Type that the function returns.
Schema string: The schema where the function is located. If not specified, the function is created in the current schema.

args List<FunctionArgArgs>: List of arguments for the function.
body String: Function body. This should be everything after the return type in the function definition.
dropCascade Boolean: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name String: The name of the argument.
returns String: Type that the function returns.
schema String: The schema where the function is located. If not specified, the function is created in the current schema.

args FunctionArgArgs[]: List of arguments for the function.
body string: Function body. This should be everything after the return type in the function definition.
dropCascade boolean: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name string: The name of the argument.
returns string: Type that the function returns.
schema string: The schema where the function is located. If not specified, the function is created in the current schema.

args Sequence[FunctionArgArgs]: List of arguments for the function.
body str: Function body. This should be everything after the return type in the function definition.
drop_cascade bool: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name str: The name of the argument.
returns str: Type that the function returns.
schema str: The schema where the function is located. If not specified, the function is created in the current schema.

args List<Property Map>: List of arguments for the function.
body String: Function body. This should be everything after the return type in the function definition.
dropCascade Boolean: True to automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects. Default is false.
name String: The name of the argument.
returns String: Type that the function returns.
schema String: The schema where the function is located. If not specified, the function is created in the current schema.

Supporting Types

FunctionArg

Type string: The type of the argument.
Default string: An expression to be used as default value if the parameter is not specified.
Mode string: Can be one of IN, INOUT, OUT, or VARIADIC. Default is IN.
Name string: The name of the argument.

Type string: The type of the argument.
Default string: An expression to be used as default value if the parameter is not specified.
Mode string: Can be one of IN, INOUT, OUT, or VARIADIC. Default is IN.
Name string: The name of the argument.

type String: The type of the argument.
default_ String: An expression to be used as default value if the parameter is not specified.
mode String: Can be one of IN, INOUT, OUT, or VARIADIC. Default is IN.
name String: The name of the argument.

type string: The type of the argument.
default string: An expression to be used as default value if the parameter is not specified.
mode string: Can be one of IN, INOUT, OUT, or VARIADIC. Default is IN.
name string: The name of the argument.

type str: The type of the argument.
default str: An expression to be used as default value if the parameter is not specified.
mode str: Can be one of IN, INOUT, OUT, or VARIADIC. Default is IN.
name str: The name of the argument.

type String: The type of the argument.
default String: An expression to be used as default value if the parameter is not specified.
mode String: Can be one of IN, INOUT, OUT, or VARIADIC. Default is IN.
name String: The name of the argument.

Package Details

Repository: https://github.com/pulumi/pulumi-postgresql
License: Apache-2.0
Notes: This Pulumi package is based on the postgresql Terraform Provider.