snowflake.ProcedureJava
Explore with Pulumi AI
Import
$ pulumi import snowflake:index/procedureJava:ProcedureJava example '"<database_name>"."<schema_name>"."<function_name>"(varchar, varchar, varchar)'
Note: Snowflake is not returning all information needed to populate the state correctly after import (e.g. data types with attributes like NUMBER(32, 10) are returned as NUMBER, default values for arguments are not returned at all).
Also, ALTER for functions is very limited so most of the attributes on this resource are marked as force new. Because of that, in multiple situations plan won’t be empty after importing and manual state operations may be required.
Create ProcedureJava Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ProcedureJava(name: string, args: ProcedureJavaArgs, opts?: CustomResourceOptions);@overload
def ProcedureJava(resource_name: str,
                  args: ProcedureJavaArgs,
                  opts: Optional[ResourceOptions] = None)
@overload
def ProcedureJava(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  handler: Optional[str] = None,
                  snowpark_package: Optional[str] = None,
                  database: Optional[str] = None,
                  schema: Optional[str] = None,
                  runtime_version: Optional[str] = None,
                  return_type: Optional[str] = None,
                  external_access_integrations: Optional[Sequence[str]] = None,
                  packages: Optional[Sequence[str]] = None,
                  is_secure: Optional[str] = None,
                  log_level: Optional[str] = None,
                  metric_level: Optional[str] = None,
                  name: Optional[str] = None,
                  null_input_behavior: Optional[str] = None,
                  imports: Optional[Sequence[ProcedureJavaImportArgs]] = None,
                  procedure_definition: Optional[str] = None,
                  arguments: Optional[Sequence[ProcedureJavaArgumentArgs]] = None,
                  execute_as: Optional[str] = None,
                  enable_console_output: Optional[bool] = None,
                  secrets: Optional[Sequence[ProcedureJavaSecretArgs]] = None,
                  comment: Optional[str] = None,
                  target_path: Optional[ProcedureJavaTargetPathArgs] = None,
                  trace_level: Optional[str] = None)func NewProcedureJava(ctx *Context, name string, args ProcedureJavaArgs, opts ...ResourceOption) (*ProcedureJava, error)public ProcedureJava(string name, ProcedureJavaArgs args, CustomResourceOptions? opts = null)
public ProcedureJava(String name, ProcedureJavaArgs args)
public ProcedureJava(String name, ProcedureJavaArgs args, CustomResourceOptions options)
type: snowflake:ProcedureJava
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 ProcedureJavaArgs
- 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 ProcedureJavaArgs
- 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 ProcedureJavaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ProcedureJavaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ProcedureJavaArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var procedureJavaResource = new Snowflake.ProcedureJava("procedureJavaResource", new()
{
    Handler = "string",
    SnowparkPackage = "string",
    Database = "string",
    Schema = "string",
    RuntimeVersion = "string",
    ReturnType = "string",
    ExternalAccessIntegrations = new[]
    {
        "string",
    },
    Packages = new[]
    {
        "string",
    },
    IsSecure = "string",
    LogLevel = "string",
    MetricLevel = "string",
    Name = "string",
    NullInputBehavior = "string",
    Imports = new[]
    {
        new Snowflake.Inputs.ProcedureJavaImportArgs
        {
            PathOnStage = "string",
            StageLocation = "string",
        },
    },
    ProcedureDefinition = "string",
    Arguments = new[]
    {
        new Snowflake.Inputs.ProcedureJavaArgumentArgs
        {
            ArgDataType = "string",
            ArgName = "string",
            ArgDefaultValue = "string",
        },
    },
    ExecuteAs = "string",
    EnableConsoleOutput = false,
    Secrets = new[]
    {
        new Snowflake.Inputs.ProcedureJavaSecretArgs
        {
            SecretId = "string",
            SecretVariableName = "string",
        },
    },
    Comment = "string",
    TargetPath = new Snowflake.Inputs.ProcedureJavaTargetPathArgs
    {
        PathOnStage = "string",
        StageLocation = "string",
    },
    TraceLevel = "string",
});
example, err := snowflake.NewProcedureJava(ctx, "procedureJavaResource", &snowflake.ProcedureJavaArgs{
	Handler:         pulumi.String("string"),
	SnowparkPackage: pulumi.String("string"),
	Database:        pulumi.String("string"),
	Schema:          pulumi.String("string"),
	RuntimeVersion:  pulumi.String("string"),
	ReturnType:      pulumi.String("string"),
	ExternalAccessIntegrations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Packages: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsSecure:          pulumi.String("string"),
	LogLevel:          pulumi.String("string"),
	MetricLevel:       pulumi.String("string"),
	Name:              pulumi.String("string"),
	NullInputBehavior: pulumi.String("string"),
	Imports: snowflake.ProcedureJavaImportArray{
		&snowflake.ProcedureJavaImportArgs{
			PathOnStage:   pulumi.String("string"),
			StageLocation: pulumi.String("string"),
		},
	},
	ProcedureDefinition: pulumi.String("string"),
	Arguments: snowflake.ProcedureJavaArgumentArray{
		&snowflake.ProcedureJavaArgumentArgs{
			ArgDataType:     pulumi.String("string"),
			ArgName:         pulumi.String("string"),
			ArgDefaultValue: pulumi.String("string"),
		},
	},
	ExecuteAs:           pulumi.String("string"),
	EnableConsoleOutput: pulumi.Bool(false),
	Secrets: snowflake.ProcedureJavaSecretArray{
		&snowflake.ProcedureJavaSecretArgs{
			SecretId:           pulumi.String("string"),
			SecretVariableName: pulumi.String("string"),
		},
	},
	Comment: pulumi.String("string"),
	TargetPath: &snowflake.ProcedureJavaTargetPathArgs{
		PathOnStage:   pulumi.String("string"),
		StageLocation: pulumi.String("string"),
	},
	TraceLevel: pulumi.String("string"),
})
var procedureJavaResource = new ProcedureJava("procedureJavaResource", ProcedureJavaArgs.builder()
    .handler("string")
    .snowparkPackage("string")
    .database("string")
    .schema("string")
    .runtimeVersion("string")
    .returnType("string")
    .externalAccessIntegrations("string")
    .packages("string")
    .isSecure("string")
    .logLevel("string")
    .metricLevel("string")
    .name("string")
    .nullInputBehavior("string")
    .imports(ProcedureJavaImportArgs.builder()
        .pathOnStage("string")
        .stageLocation("string")
        .build())
    .procedureDefinition("string")
    .arguments(ProcedureJavaArgumentArgs.builder()
        .argDataType("string")
        .argName("string")
        .argDefaultValue("string")
        .build())
    .executeAs("string")
    .enableConsoleOutput(false)
    .secrets(ProcedureJavaSecretArgs.builder()
        .secretId("string")
        .secretVariableName("string")
        .build())
    .comment("string")
    .targetPath(ProcedureJavaTargetPathArgs.builder()
        .pathOnStage("string")
        .stageLocation("string")
        .build())
    .traceLevel("string")
    .build());
procedure_java_resource = snowflake.ProcedureJava("procedureJavaResource",
    handler="string",
    snowpark_package="string",
    database="string",
    schema="string",
    runtime_version="string",
    return_type="string",
    external_access_integrations=["string"],
    packages=["string"],
    is_secure="string",
    log_level="string",
    metric_level="string",
    name="string",
    null_input_behavior="string",
    imports=[{
        "path_on_stage": "string",
        "stage_location": "string",
    }],
    procedure_definition="string",
    arguments=[{
        "arg_data_type": "string",
        "arg_name": "string",
        "arg_default_value": "string",
    }],
    execute_as="string",
    enable_console_output=False,
    secrets=[{
        "secret_id": "string",
        "secret_variable_name": "string",
    }],
    comment="string",
    target_path={
        "path_on_stage": "string",
        "stage_location": "string",
    },
    trace_level="string")
const procedureJavaResource = new snowflake.ProcedureJava("procedureJavaResource", {
    handler: "string",
    snowparkPackage: "string",
    database: "string",
    schema: "string",
    runtimeVersion: "string",
    returnType: "string",
    externalAccessIntegrations: ["string"],
    packages: ["string"],
    isSecure: "string",
    logLevel: "string",
    metricLevel: "string",
    name: "string",
    nullInputBehavior: "string",
    imports: [{
        pathOnStage: "string",
        stageLocation: "string",
    }],
    procedureDefinition: "string",
    arguments: [{
        argDataType: "string",
        argName: "string",
        argDefaultValue: "string",
    }],
    executeAs: "string",
    enableConsoleOutput: false,
    secrets: [{
        secretId: "string",
        secretVariableName: "string",
    }],
    comment: "string",
    targetPath: {
        pathOnStage: "string",
        stageLocation: "string",
    },
    traceLevel: "string",
});
type: snowflake:ProcedureJava
properties:
    arguments:
        - argDataType: string
          argDefaultValue: string
          argName: string
    comment: string
    database: string
    enableConsoleOutput: false
    executeAs: string
    externalAccessIntegrations:
        - string
    handler: string
    imports:
        - pathOnStage: string
          stageLocation: string
    isSecure: string
    logLevel: string
    metricLevel: string
    name: string
    nullInputBehavior: string
    packages:
        - string
    procedureDefinition: string
    returnType: string
    runtimeVersion: string
    schema: string
    secrets:
        - secretId: string
          secretVariableName: string
    snowparkPackage: string
    targetPath:
        pathOnStage: string
        stageLocation: string
    traceLevel: string
ProcedureJava Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ProcedureJava resource accepts the following input properties:
- Database string
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- Handler string
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- ReturnType string
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- RuntimeVersion string
- The language runtime version to use. Currently, the supported versions are: 11.
- Schema string
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- SnowparkPackage string
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- Arguments
List<ProcedureJava Argument> 
- List of the arguments for the procedure. Consult the docs for more details.
- Comment string
- Specifies a comment for the procedure.
- EnableConsole boolOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- ExecuteAs string
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- ExternalAccess List<string>Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- Imports
List<ProcedureJava Import> 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- IsSecure string
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- LogLevel string
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- MetricLevel string
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- Name string
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NullInput stringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- Packages List<string>
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- ProcedureDefinition string
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- Secrets
List<ProcedureJava Secret> 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- TargetPath ProcedureJava Target Path 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- TraceLevel string
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- Database string
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- Handler string
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- ReturnType string
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- RuntimeVersion string
- The language runtime version to use. Currently, the supported versions are: 11.
- Schema string
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- SnowparkPackage string
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- Arguments
[]ProcedureJava Argument Args 
- List of the arguments for the procedure. Consult the docs for more details.
- Comment string
- Specifies a comment for the procedure.
- EnableConsole boolOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- ExecuteAs string
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- ExternalAccess []stringIntegrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- Imports
[]ProcedureJava Import Args 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- IsSecure string
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- LogLevel string
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- MetricLevel string
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- Name string
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NullInput stringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- Packages []string
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- ProcedureDefinition string
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- Secrets
[]ProcedureJava Secret Args 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- TargetPath ProcedureJava Target Path Args 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- TraceLevel string
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- database String
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- handler String
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- returnType String
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtimeVersion String
- The language runtime version to use. Currently, the supported versions are: 11.
- schema String
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- snowparkPackage String
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- arguments
List<ProcedureJava Argument> 
- List of the arguments for the procedure. Consult the docs for more details.
- comment String
- Specifies a comment for the procedure.
- enableConsole BooleanOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- executeAs String
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- externalAccess List<String>Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- imports
List<ProcedureJava Import> 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- isSecure String
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- logLevel String
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metricLevel String
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name String
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- nullInput StringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages List<String>
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- procedureDefinition String
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- secrets
List<ProcedureJava Secret> 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- targetPath ProcedureJava Target Path 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- traceLevel String
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- database string
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- handler string
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- returnType string
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtimeVersion string
- The language runtime version to use. Currently, the supported versions are: 11.
- schema string
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- snowparkPackage string
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- arguments
ProcedureJava Argument[] 
- List of the arguments for the procedure. Consult the docs for more details.
- comment string
- Specifies a comment for the procedure.
- enableConsole booleanOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- executeAs string
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- externalAccess string[]Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- imports
ProcedureJava Import[] 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- isSecure string
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- logLevel string
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metricLevel string
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name string
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- nullInput stringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages string[]
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- procedureDefinition string
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- secrets
ProcedureJava Secret[] 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- targetPath ProcedureJava Target Path 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- traceLevel string
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- database str
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- handler str
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- return_type str
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtime_version str
- The language runtime version to use. Currently, the supported versions are: 11.
- schema str
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- snowpark_package str
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- arguments
Sequence[ProcedureJava Argument Args] 
- List of the arguments for the procedure. Consult the docs for more details.
- comment str
- Specifies a comment for the procedure.
- enable_console_ booloutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- execute_as str
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- external_access_ Sequence[str]integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- imports
Sequence[ProcedureJava Import Args] 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- is_secure str
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- log_level str
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metric_level str
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name str
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- null_input_ strbehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages Sequence[str]
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- procedure_definition str
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- secrets
Sequence[ProcedureJava Secret Args] 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- target_path ProcedureJava Target Path Args 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- trace_level str
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- database String
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- handler String
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- returnType String
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtimeVersion String
- The language runtime version to use. Currently, the supported versions are: 11.
- schema String
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- snowparkPackage String
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- arguments List<Property Map>
- List of the arguments for the procedure. Consult the docs for more details.
- comment String
- Specifies a comment for the procedure.
- enableConsole BooleanOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- executeAs String
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- externalAccess List<String>Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- imports List<Property Map>
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- isSecure String
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- logLevel String
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metricLevel String
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name String
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- nullInput StringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages List<String>
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- procedureDefinition String
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- secrets List<Property Map>
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- targetPath Property Map
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- traceLevel String
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
Outputs
All input properties are implicitly available as output properties. Additionally, the ProcedureJava resource produces the following output properties:
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameters
List<ProcedureJava Parameter> 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- ProcedureLanguage string
- Specifies language for the procedure. Used to detect external changes.
- ShowOutputs List<ProcedureJava Show Output> 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Id string
- The provider-assigned unique ID for this managed resource.
- Parameters
[]ProcedureJava Parameter 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- ProcedureLanguage string
- Specifies language for the procedure. Used to detect external changes.
- ShowOutputs []ProcedureJava Show Output 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- parameters
List<ProcedureJava Parameter> 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedureLanguage String
- Specifies language for the procedure. Used to detect external changes.
- showOutputs List<ProcedureJava Show Output> 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- fullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- id string
- The provider-assigned unique ID for this managed resource.
- parameters
ProcedureJava Parameter[] 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedureLanguage string
- Specifies language for the procedure. Used to detect external changes.
- showOutputs ProcedureJava Show Output[] 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- fully_qualified_ strname 
- Fully qualified name of the resource. For more information, see object name resolution.
- id str
- The provider-assigned unique ID for this managed resource.
- parameters
Sequence[ProcedureJava Parameter] 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedure_language str
- Specifies language for the procedure. Used to detect external changes.
- show_outputs Sequence[ProcedureJava Show Output] 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- id String
- The provider-assigned unique ID for this managed resource.
- parameters List<Property Map>
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedureLanguage String
- Specifies language for the procedure. Used to detect external changes.
- showOutputs List<Property Map>
- Outputs the result of SHOW PROCEDUREfor the given procedure.
Look up Existing ProcedureJava Resource
Get an existing ProcedureJava 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?: ProcedureJavaState, opts?: CustomResourceOptions): ProcedureJava@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arguments: Optional[Sequence[ProcedureJavaArgumentArgs]] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        enable_console_output: Optional[bool] = None,
        execute_as: Optional[str] = None,
        external_access_integrations: Optional[Sequence[str]] = None,
        fully_qualified_name: Optional[str] = None,
        handler: Optional[str] = None,
        imports: Optional[Sequence[ProcedureJavaImportArgs]] = None,
        is_secure: Optional[str] = None,
        log_level: Optional[str] = None,
        metric_level: Optional[str] = None,
        name: Optional[str] = None,
        null_input_behavior: Optional[str] = None,
        packages: Optional[Sequence[str]] = None,
        parameters: Optional[Sequence[ProcedureJavaParameterArgs]] = None,
        procedure_definition: Optional[str] = None,
        procedure_language: Optional[str] = None,
        return_type: Optional[str] = None,
        runtime_version: Optional[str] = None,
        schema: Optional[str] = None,
        secrets: Optional[Sequence[ProcedureJavaSecretArgs]] = None,
        show_outputs: Optional[Sequence[ProcedureJavaShowOutputArgs]] = None,
        snowpark_package: Optional[str] = None,
        target_path: Optional[ProcedureJavaTargetPathArgs] = None,
        trace_level: Optional[str] = None) -> ProcedureJavafunc GetProcedureJava(ctx *Context, name string, id IDInput, state *ProcedureJavaState, opts ...ResourceOption) (*ProcedureJava, error)public static ProcedureJava Get(string name, Input<string> id, ProcedureJavaState? state, CustomResourceOptions? opts = null)public static ProcedureJava get(String name, Output<String> id, ProcedureJavaState state, CustomResourceOptions options)resources:  _:    type: snowflake:ProcedureJava    get:      id: ${id}- 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.
- Arguments
List<ProcedureJava Argument> 
- List of the arguments for the procedure. Consult the docs for more details.
- Comment string
- Specifies a comment for the procedure.
- Database string
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- EnableConsole boolOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- ExecuteAs string
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- ExternalAccess List<string>Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Handler string
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- Imports
List<ProcedureJava Import> 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- IsSecure string
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- LogLevel string
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- MetricLevel string
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- Name string
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NullInput stringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- Packages List<string>
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- Parameters
List<ProcedureJava Parameter> 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- ProcedureDefinition string
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- ProcedureLanguage string
- Specifies language for the procedure. Used to detect external changes.
- ReturnType string
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- RuntimeVersion string
- The language runtime version to use. Currently, the supported versions are: 11.
- Schema string
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- Secrets
List<ProcedureJava Secret> 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- ShowOutputs List<ProcedureJava Show Output> 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- SnowparkPackage string
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- TargetPath ProcedureJava Target Path 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- TraceLevel string
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- Arguments
[]ProcedureJava Argument Args 
- List of the arguments for the procedure. Consult the docs for more details.
- Comment string
- Specifies a comment for the procedure.
- Database string
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- EnableConsole boolOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- ExecuteAs string
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- ExternalAccess []stringIntegrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- FullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- Handler string
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- Imports
[]ProcedureJava Import Args 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- IsSecure string
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- LogLevel string
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- MetricLevel string
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- Name string
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- NullInput stringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- Packages []string
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- Parameters
[]ProcedureJava Parameter Args 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- ProcedureDefinition string
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- ProcedureLanguage string
- Specifies language for the procedure. Used to detect external changes.
- ReturnType string
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- RuntimeVersion string
- The language runtime version to use. Currently, the supported versions are: 11.
- Schema string
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- Secrets
[]ProcedureJava Secret Args 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- ShowOutputs []ProcedureJava Show Output Args 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- SnowparkPackage string
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- TargetPath ProcedureJava Target Path Args 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- TraceLevel string
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- arguments
List<ProcedureJava Argument> 
- List of the arguments for the procedure. Consult the docs for more details.
- comment String
- Specifies a comment for the procedure.
- database String
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- enableConsole BooleanOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- executeAs String
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- externalAccess List<String>Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- handler String
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- imports
List<ProcedureJava Import> 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- isSecure String
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- logLevel String
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metricLevel String
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name String
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- nullInput StringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages List<String>
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- parameters
List<ProcedureJava Parameter> 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedureDefinition String
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- procedureLanguage String
- Specifies language for the procedure. Used to detect external changes.
- returnType String
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtimeVersion String
- The language runtime version to use. Currently, the supported versions are: 11.
- schema String
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- secrets
List<ProcedureJava Secret> 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- showOutputs List<ProcedureJava Show Output> 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- snowparkPackage String
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- targetPath ProcedureJava Target Path 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- traceLevel String
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- arguments
ProcedureJava Argument[] 
- List of the arguments for the procedure. Consult the docs for more details.
- comment string
- Specifies a comment for the procedure.
- database string
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- enableConsole booleanOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- executeAs string
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- externalAccess string[]Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- fullyQualified stringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- handler string
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- imports
ProcedureJava Import[] 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- isSecure string
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- logLevel string
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metricLevel string
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name string
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- nullInput stringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages string[]
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- parameters
ProcedureJava Parameter[] 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedureDefinition string
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- procedureLanguage string
- Specifies language for the procedure. Used to detect external changes.
- returnType string
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtimeVersion string
- The language runtime version to use. Currently, the supported versions are: 11.
- schema string
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- secrets
ProcedureJava Secret[] 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- showOutputs ProcedureJava Show Output[] 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- snowparkPackage string
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- targetPath ProcedureJava Target Path 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- traceLevel string
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- arguments
Sequence[ProcedureJava Argument Args] 
- List of the arguments for the procedure. Consult the docs for more details.
- comment str
- Specifies a comment for the procedure.
- database str
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- enable_console_ booloutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- execute_as str
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- external_access_ Sequence[str]integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- fully_qualified_ strname 
- Fully qualified name of the resource. For more information, see object name resolution.
- handler str
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- imports
Sequence[ProcedureJava Import Args] 
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- is_secure str
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- log_level str
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metric_level str
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name str
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- null_input_ strbehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages Sequence[str]
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- parameters
Sequence[ProcedureJava Parameter Args] 
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedure_definition str
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- procedure_language str
- Specifies language for the procedure. Used to detect external changes.
- return_type str
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtime_version str
- The language runtime version to use. Currently, the supported versions are: 11.
- schema str
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- secrets
Sequence[ProcedureJava Secret Args] 
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- show_outputs Sequence[ProcedureJava Show Output Args] 
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- snowpark_package str
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- target_path ProcedureJava Target Path Args 
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- trace_level str
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
- arguments List<Property Map>
- List of the arguments for the procedure. Consult the docs for more details.
- comment String
- Specifies a comment for the procedure.
- database String
- The database in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- enableConsole BooleanOutput 
- Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
- executeAs String
- Specifies whether the stored procedure executes with the privileges of the owner (an “owner’s rights” stored procedure) or with the privileges of the caller (a “caller’s rights” stored procedure). If you execute the statement CREATE PROCEDURE … EXECUTE AS CALLER, then in the future the procedure will execute as a caller’s rights procedure. If you execute CREATE PROCEDURE … EXECUTE AS OWNER, then the procedure will execute as an owner’s rights procedure. For more information, see Understanding caller’s rights and owner’s rights stored procedures. Valid values are (case-insensitive): CALLER|OWNER.
- externalAccess List<String>Integrations 
- The names of external access integrations needed in order for this procedure’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
- fullyQualified StringName 
- Fully qualified name of the resource. For more information, see object name resolution.
- handler String
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- imports List<Property Map>
- The location (stage), path, and name of the file(s) to import. You must set the IMPORTS clause to include any files that your stored procedure depends on. If you are writing an in-line stored procedure, you can omit this clause, unless your code depends on classes defined outside the stored procedure or resource files. If you are writing a stored procedure with a staged handler, you must also include a path to the JAR file containing the stored procedure’s handler code. The IMPORTS definition cannot reference variables from arguments that are passed into the stored procedure. Each file in the IMPORTS clause must have a unique name, even if the files are in different subdirectories or different stages.
- isSecure String
- Specifies that the procedure is secure. For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
- logLevel String
- LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
- metricLevel String
- METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
- name String
- The name of the procedure; the identifier does not need to be unique for the schema in which the procedure is created because stored procedures are identified and resolved by the combination of the name and argument types. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- nullInput StringBehavior 
- Specifies the behavior of the procedure when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT|RETURNS NULL ON NULL INPUT.
- packages List<String>
- List of the names of packages deployed in Snowflake that should be included in the handler code’s execution environment. The Snowpark package is required for stored procedures, but is specified in the snowpark_packageattribute. For more information about Snowpark, see Snowpark API.
- parameters List<Property Map>
- Outputs the result of SHOW PARAMETERS IN PROCEDUREfor the given procedure.
- procedureDefinition String
- Defines the code executed by the stored procedure. The definition can consist of any valid code. Wrapping $$signs are added by the provider automatically; do not include them. Theprocedure_definitionvalue must be Java source code. For more information, see Java (using Snowpark). To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
- procedureLanguage String
- Specifies language for the procedure. Used to detect external changes.
- returnType String
- Specifies the type of the result returned by the stored procedure. For <result_data_type>, use the Snowflake data type that corresponds to the type of the language that you are using (see SQL-Java Data Type Mappings). ForRETURNS TABLE ( [ col_name col_data_type [ , ... ] ] ), if you know the Snowflake data types of the columns in the returned table, specify the column names and types. Otherwise (e.g. if you are determining the column types during run time), you can omit the column names and types (i.e.TABLE ()).
- runtimeVersion String
- The language runtime version to use. Currently, the supported versions are: 11.
- schema String
- The schema in which to create the procedure. Due to technical limitations (read more here), avoid using the following characters: |,.,".
- secrets List<Property Map>
- Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
- showOutputs List<Property Map>
- Outputs the result of SHOW PROCEDUREfor the given procedure.
- snowparkPackage String
- The Snowpark package is required for stored procedures, so it must always be present. For more information about Snowpark, see Snowpark API.
- targetPath Property Map
- Use the fully qualified name of the method or function for the stored procedure. This is typically in the following form com.my_company.my_package.MyClass.myMethodwherecom.my_company.my_packagecorresponds to the package containing the object or class:package com.my_company.my_package;.
- traceLevel String
- Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
Supporting Types
ProcedureJavaArgument, ProcedureJavaArgumentArgs      
- ArgData stringType 
- The argument type.
- ArgName string
- The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the procedure definition.
- ArgDefault stringValue 
- ArgData stringType 
- The argument type.
- ArgName string
- The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the procedure definition.
- ArgDefault stringValue 
- argData StringType 
- The argument type.
- argName String
- The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the procedure definition.
- argDefault StringValue 
- argData stringType 
- The argument type.
- argName string
- The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the procedure definition.
- argDefault stringValue 
- arg_data_ strtype 
- The argument type.
- arg_name str
- The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the procedure definition.
- arg_default_ strvalue 
- argData StringType 
- The argument type.
- argName String
- The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the procedure definition.
- argDefault StringValue 
ProcedureJavaImport, ProcedureJavaImportArgs      
- PathOn stringStage 
- Path for import on stage, without the leading /.
- StageLocation string
- PathOn stringStage 
- Path for import on stage, without the leading /.
- StageLocation string
- pathOn StringStage 
- Path for import on stage, without the leading /.
- stageLocation String
- pathOn stringStage 
- Path for import on stage, without the leading /.
- stageLocation string
- path_on_ strstage 
- Path for import on stage, without the leading /.
- stage_location str
- pathOn StringStage 
- Path for import on stage, without the leading /.
- stageLocation String
ProcedureJavaParameter, ProcedureJavaParameterArgs      
ProcedureJavaParameterEnableConsoleOutput, ProcedureJavaParameterEnableConsoleOutputArgs            
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
ProcedureJavaParameterLogLevel, ProcedureJavaParameterLogLevelArgs          
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
ProcedureJavaParameterMetricLevel, ProcedureJavaParameterMetricLevelArgs          
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
ProcedureJavaParameterTraceLevel, ProcedureJavaParameterTraceLevelArgs          
- Default string
- Description string
- Key string
- Level string
- Value string
- Default string
- Description string
- Key string
- Level string
- Value string
- default_ String
- description String
- key String
- level String
- value String
- default string
- description string
- key string
- level string
- value string
- default str
- description str
- key str
- level str
- value str
- default String
- description String
- key String
- level String
- value String
ProcedureJavaSecret, ProcedureJavaSecretArgs      
- SecretId string
- Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
- SecretVariable stringName 
- The variable that will be used in handler code when retrieving information from the secret.
- SecretId string
- Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
- SecretVariable stringName 
- The variable that will be used in handler code when retrieving information from the secret.
- secretId String
- Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
- secretVariable StringName 
- The variable that will be used in handler code when retrieving information from the secret.
- secretId string
- Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
- secretVariable stringName 
- The variable that will be used in handler code when retrieving information from the secret.
- secret_id str
- Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
- secret_variable_ strname 
- The variable that will be used in handler code when retrieving information from the secret.
- secretId String
- Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
- secretVariable StringName 
- The variable that will be used in handler code when retrieving information from the secret.
ProcedureJavaShowOutput, ProcedureJavaShowOutputArgs        
- ArgumentsRaw string
- CatalogName string
- CreatedOn string
- Description string
- ExternalAccess stringIntegrations 
- IsAggregate bool
- IsAnsi bool
- IsBuiltin bool
- IsSecure bool
- IsTable boolFunction 
- MaxNum intArguments 
- MinNum intArguments 
- Name string
- SchemaName string
- Secrets string
- ValidFor boolClustering 
- ArgumentsRaw string
- CatalogName string
- CreatedOn string
- Description string
- ExternalAccess stringIntegrations 
- IsAggregate bool
- IsAnsi bool
- IsBuiltin bool
- IsSecure bool
- IsTable boolFunction 
- MaxNum intArguments 
- MinNum intArguments 
- Name string
- SchemaName string
- Secrets string
- ValidFor boolClustering 
- argumentsRaw String
- catalogName String
- createdOn String
- description String
- externalAccess StringIntegrations 
- isAggregate Boolean
- isAnsi Boolean
- isBuiltin Boolean
- isSecure Boolean
- isTable BooleanFunction 
- maxNum IntegerArguments 
- minNum IntegerArguments 
- name String
- schemaName String
- secrets String
- validFor BooleanClustering 
- argumentsRaw string
- catalogName string
- createdOn string
- description string
- externalAccess stringIntegrations 
- isAggregate boolean
- isAnsi boolean
- isBuiltin boolean
- isSecure boolean
- isTable booleanFunction 
- maxNum numberArguments 
- minNum numberArguments 
- name string
- schemaName string
- secrets string
- validFor booleanClustering 
- arguments_raw str
- catalog_name str
- created_on str
- description str
- external_access_ strintegrations 
- is_aggregate bool
- is_ansi bool
- is_builtin bool
- is_secure bool
- is_table_ boolfunction 
- max_num_ intarguments 
- min_num_ intarguments 
- name str
- schema_name str
- secrets str
- valid_for_ boolclustering 
- argumentsRaw String
- catalogName String
- createdOn String
- description String
- externalAccess StringIntegrations 
- isAggregate Boolean
- isAnsi Boolean
- isBuiltin Boolean
- isSecure Boolean
- isTable BooleanFunction 
- maxNum NumberArguments 
- minNum NumberArguments 
- name String
- schemaName String
- secrets String
- validFor BooleanClustering 
ProcedureJavaTargetPath, ProcedureJavaTargetPathArgs        
- PathOn stringStage 
- Path for import on stage, without the leading /.
- StageLocation string
- PathOn stringStage 
- Path for import on stage, without the leading /.
- StageLocation string
- pathOn StringStage 
- Path for import on stage, without the leading /.
- stageLocation String
- pathOn stringStage 
- Path for import on stage, without the leading /.
- stageLocation string
- path_on_ strstage 
- Path for import on stage, without the leading /.
- stage_location str
- pathOn StringStage 
- Path for import on stage, without the leading /.
- stageLocation String
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the snowflakeTerraform Provider.