Snowflake v0.52.0, Apr 18 24

Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi

snowflake.Procedure

Explore with Pulumi AI

Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.Database;
import com.pulumi.snowflake.DatabaseArgs;
import com.pulumi.snowflake.Schema;
import com.pulumi.snowflake.SchemaArgs;
import com.pulumi.snowflake.Procedure;
import com.pulumi.snowflake.ProcedureArgs;
import com.pulumi.snowflake.inputs.ProcedureArgumentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var db = new Database("db", DatabaseArgs.builder()        
            .dataRetentionDays(1)
            .build());

        var schema = new Schema("schema", SchemaArgs.builder()        
            .database(db.name())
            .dataRetentionDays(1)
            .build());

        var proc = new Procedure("proc", ProcedureArgs.builder()        
            .database(db.name())
            .schema(schema.name())
            .language("JAVASCRIPT")
            .arguments(            
                ProcedureArgumentArgs.builder()
                    .name("arg1")
                    .type("varchar")
                    .build(),
                ProcedureArgumentArgs.builder()
                    .name("arg2")
                    .type("DATE")
                    .build())
            .comment("Procedure with 2 arguments")
            .returnType("VARCHAR")
            .executeAs("CALLER")
            .returnBehavior("IMMUTABLE")
            .nullInputBehavior("RETURNS NULL ON NULL INPUT")
            .statement("""
var X=1
return X
            """)
            .build());

    }
}

resources:
  db:
    type: snowflake:Database
    properties:
      dataRetentionDays: 1
  schema:
    type: snowflake:Schema
    properties:
      database: ${db.name}
      dataRetentionDays: 1
  proc:
    type: snowflake:Procedure
    properties:
      database: ${db.name}
      schema: ${schema.name}
      language: JAVASCRIPT
      arguments:
        - name: arg1
          type: varchar
        - name: arg2
          type: DATE
      comment: Procedure with 2 arguments
      returnType: VARCHAR
      executeAs: CALLER
      returnBehavior: IMMUTABLE
      nullInputBehavior: RETURNS NULL ON NULL INPUT
      statement: |
        var X=1
        return X

Create Procedure Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Procedure(name: string, args: ProcedureArgs, opts?: CustomResourceOptions);

@overload
def Procedure(resource_name: str,
              args: ProcedureArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Procedure(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              return_type: Optional[str] = None,
              statement: Optional[str] = None,
              database: Optional[str] = None,
              schema: Optional[str] = None,
              null_input_behavior: Optional[str] = None,
              imports: Optional[Sequence[str]] = None,
              language: Optional[str] = None,
              name: Optional[str] = None,
              arguments: Optional[Sequence[ProcedureArgumentArgs]] = None,
              packages: Optional[Sequence[str]] = None,
              return_behavior: Optional[str] = None,
              handler: Optional[str] = None,
              runtime_version: Optional[str] = None,
              execute_as: Optional[str] = None,
              secure: Optional[bool] = None,
              comment: Optional[str] = None)

func NewProcedure(ctx *Context, name string, args ProcedureArgs, opts ...ResourceOption) (*Procedure, error)

public Procedure(string name, ProcedureArgs args, CustomResourceOptions? opts = null)

public Procedure(String name, ProcedureArgs args)
public Procedure(String name, ProcedureArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args ProcedureArgs: 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 ProcedureArgs: 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 ProcedureArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

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

Example

The following reference example uses placeholder values for all input properties.

var procedureResource = new Snowflake.Procedure("procedureResource", new()
{
    ReturnType = "string",
    Statement = "string",
    Database = "string",
    Schema = "string",
    NullInputBehavior = "string",
    Imports = new[]
    {
        "string",
    },
    Language = "string",
    Name = "string",
    Arguments = new[]
    {
        new Snowflake.Inputs.ProcedureArgumentArgs
        {
            Name = "string",
            Type = "string",
        },
    },
    Packages = new[]
    {
        "string",
    },
    Handler = "string",
    RuntimeVersion = "string",
    ExecuteAs = "string",
    Secure = false,
    Comment = "string",
});

example, err := snowflake.NewProcedure(ctx, "procedureResource", &snowflake.ProcedureArgs{
	ReturnType:        pulumi.String("string"),
	Statement:         pulumi.String("string"),
	Database:          pulumi.String("string"),
	Schema:            pulumi.String("string"),
	NullInputBehavior: pulumi.String("string"),
	Imports: pulumi.StringArray{
		pulumi.String("string"),
	},
	Language: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Arguments: snowflake.ProcedureArgumentArray{
		&snowflake.ProcedureArgumentArgs{
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	Packages: pulumi.StringArray{
		pulumi.String("string"),
	},
	Handler:        pulumi.String("string"),
	RuntimeVersion: pulumi.String("string"),
	ExecuteAs:      pulumi.String("string"),
	Secure:         pulumi.Bool(false),
	Comment:        pulumi.String("string"),
})

var procedureResource = new Procedure("procedureResource", ProcedureArgs.builder()        
    .returnType("string")
    .statement("string")
    .database("string")
    .schema("string")
    .nullInputBehavior("string")
    .imports("string")
    .language("string")
    .name("string")
    .arguments(ProcedureArgumentArgs.builder()
        .name("string")
        .type("string")
        .build())
    .packages("string")
    .handler("string")
    .runtimeVersion("string")
    .executeAs("string")
    .secure(false)
    .comment("string")
    .build());

procedure_resource = snowflake.Procedure("procedureResource",
    return_type="string",
    statement="string",
    database="string",
    schema="string",
    null_input_behavior="string",
    imports=["string"],
    language="string",
    name="string",
    arguments=[snowflake.ProcedureArgumentArgs(
        name="string",
        type="string",
    )],
    packages=["string"],
    handler="string",
    runtime_version="string",
    execute_as="string",
    secure=False,
    comment="string")

const procedureResource = new snowflake.Procedure("procedureResource", {
    returnType: "string",
    statement: "string",
    database: "string",
    schema: "string",
    nullInputBehavior: "string",
    imports: ["string"],
    language: "string",
    name: "string",
    arguments: [{
        name: "string",
        type: "string",
    }],
    packages: ["string"],
    handler: "string",
    runtimeVersion: "string",
    executeAs: "string",
    secure: false,
    comment: "string",
});

type: snowflake:Procedure
properties:
    arguments:
        - name: string
          type: string
    comment: string
    database: string
    executeAs: string
    handler: string
    imports:
        - string
    language: string
    name: string
    nullInputBehavior: string
    packages:
        - string
    returnType: string
    runtimeVersion: string
    schema: string
    secure: false
    statement: string

Procedure 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 Procedure resource accepts the following input properties:

Database string: The database in which to create the procedure. Don't use the | character.
ReturnType string: The return type of the procedure
Schema string: The schema in which to create the procedure. Don't use the | character.
Statement string: Specifies the code used to create the procedure.
Arguments List<ProcedureArgument>: List of the arguments for the procedure
Comment string: Specifies a comment for the procedure.
ExecuteAs string: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
Handler string: The handler method for Java / Python procedures.
Imports List<string>: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
Language string: Specifies the language of the stored procedure code.
Name string: The argument name
NullInputBehavior string: Specifies the behavior of the procedure when called with null inputs.
Packages List<string>: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
ReturnBehavior string: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
RuntimeVersion string: Required for Python procedures. Specifies Python runtime version.
Secure bool: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.

Database string: The database in which to create the procedure. Don't use the | character.
ReturnType string: The return type of the procedure
Schema string: The schema in which to create the procedure. Don't use the | character.
Statement string: Specifies the code used to create the procedure.
Arguments []ProcedureArgumentArgs: List of the arguments for the procedure
Comment string: Specifies a comment for the procedure.
ExecuteAs string: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
Handler string: The handler method for Java / Python procedures.
Imports []string: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
Language string: Specifies the language of the stored procedure code.
Name string: The argument name
NullInputBehavior string: Specifies the behavior of the procedure when called with null inputs.
Packages []string: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
ReturnBehavior string: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
RuntimeVersion string: Required for Python procedures. Specifies Python runtime version.
Secure bool: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.

database String: The database in which to create the procedure. Don't use the | character.
returnType String: The return type of the procedure
schema String: The schema in which to create the procedure. Don't use the | character.
statement String: Specifies the code used to create the procedure.
arguments List<ProcedureArgument>: List of the arguments for the procedure
comment String: Specifies a comment for the procedure.
executeAs String: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler String: The handler method for Java / Python procedures.
imports List<String>: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language String: Specifies the language of the stored procedure code.
name String: The argument name
nullInputBehavior String: Specifies the behavior of the procedure when called with null inputs.
packages List<String>: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
returnBehavior String: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
runtimeVersion String: Required for Python procedures. Specifies Python runtime version.
secure Boolean: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.

database string: The database in which to create the procedure. Don't use the | character.
returnType string: The return type of the procedure
schema string: The schema in which to create the procedure. Don't use the | character.
statement string: Specifies the code used to create the procedure.
arguments ProcedureArgument[]: List of the arguments for the procedure
comment string: Specifies a comment for the procedure.
executeAs string: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler string: The handler method for Java / Python procedures.
imports string[]: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language string: Specifies the language of the stored procedure code.
name string: The argument name
nullInputBehavior string: Specifies the behavior of the procedure when called with null inputs.
packages string[]: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
returnBehavior string: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
runtimeVersion string: Required for Python procedures. Specifies Python runtime version.
secure boolean: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.

database str: The database in which to create the procedure. Don't use the | character.
return_type str: The return type of the procedure
schema str: The schema in which to create the procedure. Don't use the | character.
statement str: Specifies the code used to create the procedure.
arguments Sequence[ProcedureArgumentArgs]: List of the arguments for the procedure
comment str: Specifies a comment for the procedure.
execute_as str: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler str: The handler method for Java / Python procedures.
imports Sequence[str]: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language str: Specifies the language of the stored procedure code.
name str: The argument name
null_input_behavior str: Specifies the behavior of the procedure when called with null inputs.
packages Sequence[str]: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
return_behavior str: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
runtime_version str: Required for Python procedures. Specifies Python runtime version.
secure bool: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.

database String: The database in which to create the procedure. Don't use the | character.
returnType String: The return type of the procedure
schema String: The schema in which to create the procedure. Don't use the | character.
statement String: Specifies the code used to create the procedure.
arguments List<Property Map>: List of the arguments for the procedure
comment String: Specifies a comment for the procedure.
executeAs String: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler String: The handler method for Java / Python procedures.
imports List<String>: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language String: Specifies the language of the stored procedure code.
name String: The argument name
nullInputBehavior String: Specifies the behavior of the procedure when called with null inputs.
packages List<String>: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
returnBehavior String: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
runtimeVersion String: Required for Python procedures. Specifies Python runtime version.
secure Boolean: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.

Outputs

All input properties are implicitly available as output properties. Additionally, the Procedure 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 Existing Procedure Resource

Get an existing Procedure 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?: ProcedureState, opts?: CustomResourceOptions): Procedure

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arguments: Optional[Sequence[ProcedureArgumentArgs]] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        execute_as: Optional[str] = None,
        handler: Optional[str] = None,
        imports: Optional[Sequence[str]] = None,
        language: Optional[str] = None,
        name: Optional[str] = None,
        null_input_behavior: Optional[str] = None,
        packages: Optional[Sequence[str]] = None,
        return_behavior: Optional[str] = None,
        return_type: Optional[str] = None,
        runtime_version: Optional[str] = None,
        schema: Optional[str] = None,
        secure: Optional[bool] = None,
        statement: Optional[str] = None) -> Procedure

func GetProcedure(ctx *Context, name string, id IDInput, state *ProcedureState, opts ...ResourceOption) (*Procedure, error)

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

public static Procedure get(String name, Output<String> id, ProcedureState 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:

Arguments List<ProcedureArgument>: List of the arguments for the procedure
Comment string: Specifies a comment for the procedure.
Database string: The database in which to create the procedure. Don't use the | character.
ExecuteAs string: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
Handler string: The handler method for Java / Python procedures.
Imports List<string>: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
Language string: Specifies the language of the stored procedure code.
Name string: The argument name
NullInputBehavior string: Specifies the behavior of the procedure when called with null inputs.
Packages List<string>: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
ReturnBehavior string: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
ReturnType string: The return type of the procedure
RuntimeVersion string: Required for Python procedures. Specifies Python runtime version.
Schema string: The schema in which to create the procedure. Don't use the | character.
Secure bool: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.
Statement string: Specifies the code used to create the procedure.

Arguments []ProcedureArgumentArgs: List of the arguments for the procedure
Comment string: Specifies a comment for the procedure.
Database string: The database in which to create the procedure. Don't use the | character.
ExecuteAs string: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
Handler string: The handler method for Java / Python procedures.
Imports []string: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
Language string: Specifies the language of the stored procedure code.
Name string: The argument name
NullInputBehavior string: Specifies the behavior of the procedure when called with null inputs.
Packages []string: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
ReturnBehavior string: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
ReturnType string: The return type of the procedure
RuntimeVersion string: Required for Python procedures. Specifies Python runtime version.
Schema string: The schema in which to create the procedure. Don't use the | character.
Secure bool: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.
Statement string: Specifies the code used to create the procedure.

arguments List<ProcedureArgument>: List of the arguments for the procedure
comment String: Specifies a comment for the procedure.
database String: The database in which to create the procedure. Don't use the | character.
executeAs String: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler String: The handler method for Java / Python procedures.
imports List<String>: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language String: Specifies the language of the stored procedure code.
name String: The argument name
nullInputBehavior String: Specifies the behavior of the procedure when called with null inputs.
packages List<String>: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
returnBehavior String: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
returnType String: The return type of the procedure
runtimeVersion String: Required for Python procedures. Specifies Python runtime version.
schema String: The schema in which to create the procedure. Don't use the | character.
secure Boolean: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.
statement String: Specifies the code used to create the procedure.

arguments ProcedureArgument[]: List of the arguments for the procedure
comment string: Specifies a comment for the procedure.
database string: The database in which to create the procedure. Don't use the | character.
executeAs string: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler string: The handler method for Java / Python procedures.
imports string[]: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language string: Specifies the language of the stored procedure code.
name string: The argument name
nullInputBehavior string: Specifies the behavior of the procedure when called with null inputs.
packages string[]: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
returnBehavior string: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
returnType string: The return type of the procedure
runtimeVersion string: Required for Python procedures. Specifies Python runtime version.
schema string: The schema in which to create the procedure. Don't use the | character.
secure boolean: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.
statement string: Specifies the code used to create the procedure.

arguments Sequence[ProcedureArgumentArgs]: List of the arguments for the procedure
comment str: Specifies a comment for the procedure.
database str: The database in which to create the procedure. Don't use the | character.
execute_as str: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler str: The handler method for Java / Python procedures.
imports Sequence[str]: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language str: Specifies the language of the stored procedure code.
name str: The argument name
null_input_behavior str: Specifies the behavior of the procedure when called with null inputs.
packages Sequence[str]: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
return_behavior str: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
return_type str: The return type of the procedure
runtime_version str: Required for Python procedures. Specifies Python runtime version.
schema str: The schema in which to create the procedure. Don't use the | character.
secure bool: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.
statement str: Specifies the code used to create the procedure.

arguments List<Property Map>: List of the arguments for the procedure
comment String: Specifies a comment for the procedure.
database String: The database in which to create the procedure. Don't use the | character.
executeAs String: Sets execution context. Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.
handler String: The handler method for Java / Python procedures.
imports List<String>: Imports for Java / Python procedures. For Java this a list of jar files, for Python this is a list of Python files.
language String: Specifies the language of the stored procedure code.
name String: The argument name
nullInputBehavior String: Specifies the behavior of the procedure when called with null inputs.
packages List<String>: List of package imports to use for Java / Python procedures. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
returnBehavior String: Specifies the behavior of the function when returning results
Deprecated: These keywords are deprecated for stored procedures. These keywords are not intended to apply to stored procedures. In a future release, these keywords will be removed from the documentation.
returnType String: The return type of the procedure
runtimeVersion String: Required for Python procedures. Specifies Python runtime version.
schema String: The schema in which to create the procedure. Don't use the | character.
secure Boolean: Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.
statement String: Specifies the code used to create the procedure.

Supporting Types

ProcedureArgument, ProcedureArgumentArgs

Name string: The argument name
Type string: The argument type

Name string: The argument name
Type string: The argument type

name String: The argument name
type String: The argument type

name string: The argument name
type string: The argument type

name str: The argument name
type str: The argument type

name String: The argument name
type String: The argument type

Import

format is <database_name>.<schema_name>.<procedure_name>(<arg types, separated with ‘,’>)

$ pulumi import snowflake:index/procedure:Procedure example 'dbName.schemaName.procedureName(varchar, varchar, varchar)'

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Snowflake pulumi/pulumi-snowflake
License: Apache-2.0
Notes: This Pulumi package is based on the snowflake Terraform Provider.

Snowflake v0.52.0 published on Thursday, Apr 18, 2024 by Pulumi

pulumi/pulumi-snowflake

snowflake.Procedure

On this page

On this page

Example Usage

Create Procedure Resource

Constructor syntax

Parameters

Example

Procedure Resource Properties

Inputs

Outputs

Look up Existing Procedure Resource

Supporting Types

ProcedureArgument, ProcedureArgumentArgs

Import

Package Details

On this page

On this page