1. Packages
  2. Snowflake Provider
  3. API Docs
  4. FunctionSql
Snowflake v1.1.0 published on Monday, Jan 13, 2025 by Pulumi

snowflake.FunctionSql

Explore with Pulumi AI

snowflake logo
Snowflake v1.1.0 published on Monday, Jan 13, 2025 by Pulumi

    Import

    $ pulumi import snowflake:index/functionSql:FunctionSql 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 FunctionSql Resource

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

    Constructor syntax

    new FunctionSql(name: string, args: FunctionSqlArgs, opts?: CustomResourceOptions);
    @overload
    def FunctionSql(resource_name: str,
                    args: FunctionSqlArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def FunctionSql(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    function_definition: Optional[str] = None,
                    schema: Optional[str] = None,
                    database: Optional[str] = None,
                    return_type: Optional[str] = None,
                    log_level: Optional[str] = None,
                    is_secure: Optional[str] = None,
                    arguments: Optional[Sequence[FunctionSqlArgumentArgs]] = None,
                    metric_level: Optional[str] = None,
                    name: Optional[str] = None,
                    return_results_behavior: Optional[str] = None,
                    enable_console_output: Optional[bool] = None,
                    comment: Optional[str] = None,
                    trace_level: Optional[str] = None)
    func NewFunctionSql(ctx *Context, name string, args FunctionSqlArgs, opts ...ResourceOption) (*FunctionSql, error)
    public FunctionSql(string name, FunctionSqlArgs args, CustomResourceOptions? opts = null)
    public FunctionSql(String name, FunctionSqlArgs args)
    public FunctionSql(String name, FunctionSqlArgs args, CustomResourceOptions options)
    
    type: snowflake:FunctionSql
    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 FunctionSqlArgs
    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 FunctionSqlArgs
    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 FunctionSqlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FunctionSqlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FunctionSqlArgs
    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 functionSqlResource = new Snowflake.FunctionSql("functionSqlResource", new()
    {
        FunctionDefinition = "string",
        Schema = "string",
        Database = "string",
        ReturnType = "string",
        LogLevel = "string",
        IsSecure = "string",
        Arguments = new[]
        {
            new Snowflake.Inputs.FunctionSqlArgumentArgs
            {
                ArgDataType = "string",
                ArgName = "string",
                ArgDefaultValue = "string",
            },
        },
        MetricLevel = "string",
        Name = "string",
        ReturnResultsBehavior = "string",
        EnableConsoleOutput = false,
        Comment = "string",
        TraceLevel = "string",
    });
    
    example, err := snowflake.NewFunctionSql(ctx, "functionSqlResource", &snowflake.FunctionSqlArgs{
    	FunctionDefinition: pulumi.String("string"),
    	Schema:             pulumi.String("string"),
    	Database:           pulumi.String("string"),
    	ReturnType:         pulumi.String("string"),
    	LogLevel:           pulumi.String("string"),
    	IsSecure:           pulumi.String("string"),
    	Arguments: snowflake.FunctionSqlArgumentArray{
    		&snowflake.FunctionSqlArgumentArgs{
    			ArgDataType:     pulumi.String("string"),
    			ArgName:         pulumi.String("string"),
    			ArgDefaultValue: pulumi.String("string"),
    		},
    	},
    	MetricLevel:           pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	ReturnResultsBehavior: pulumi.String("string"),
    	EnableConsoleOutput:   pulumi.Bool(false),
    	Comment:               pulumi.String("string"),
    	TraceLevel:            pulumi.String("string"),
    })
    
    var functionSqlResource = new FunctionSql("functionSqlResource", FunctionSqlArgs.builder()
        .functionDefinition("string")
        .schema("string")
        .database("string")
        .returnType("string")
        .logLevel("string")
        .isSecure("string")
        .arguments(FunctionSqlArgumentArgs.builder()
            .argDataType("string")
            .argName("string")
            .argDefaultValue("string")
            .build())
        .metricLevel("string")
        .name("string")
        .returnResultsBehavior("string")
        .enableConsoleOutput(false)
        .comment("string")
        .traceLevel("string")
        .build());
    
    function_sql_resource = snowflake.FunctionSql("functionSqlResource",
        function_definition="string",
        schema="string",
        database="string",
        return_type="string",
        log_level="string",
        is_secure="string",
        arguments=[{
            "arg_data_type": "string",
            "arg_name": "string",
            "arg_default_value": "string",
        }],
        metric_level="string",
        name="string",
        return_results_behavior="string",
        enable_console_output=False,
        comment="string",
        trace_level="string")
    
    const functionSqlResource = new snowflake.FunctionSql("functionSqlResource", {
        functionDefinition: "string",
        schema: "string",
        database: "string",
        returnType: "string",
        logLevel: "string",
        isSecure: "string",
        arguments: [{
            argDataType: "string",
            argName: "string",
            argDefaultValue: "string",
        }],
        metricLevel: "string",
        name: "string",
        returnResultsBehavior: "string",
        enableConsoleOutput: false,
        comment: "string",
        traceLevel: "string",
    });
    
    type: snowflake:FunctionSql
    properties:
        arguments:
            - argDataType: string
              argDefaultValue: string
              argName: string
        comment: string
        database: string
        enableConsoleOutput: false
        functionDefinition: string
        isSecure: string
        logLevel: string
        metricLevel: string
        name: string
        returnResultsBehavior: string
        returnType: string
        schema: string
        traceLevel: string
    

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

    Database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Arguments List<FunctionSqlArgument>
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    EnableConsoleOutput bool
    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.
    IsSecure string
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    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 function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Arguments []FunctionSqlArgumentArgs
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    EnableConsoleOutput bool
    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.
    IsSecure string
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    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 function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments List<FunctionSqlArgument>
    List of the arguments for the function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    enableConsoleOutput Boolean
    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.
    isSecure String
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    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 function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    functionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    returnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments FunctionSqlArgument[]
    List of the arguments for the function. Consult the docs for more details.
    comment string
    Specifies a comment for the function.
    enableConsoleOutput boolean
    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.
    isSecure string
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    returnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    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 function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    function_definition str
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    return_type str
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema str
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments Sequence[FunctionSqlArgumentArgs]
    List of the arguments for the function. Consult the docs for more details.
    comment str
    Specifies a comment for the function.
    enable_console_output bool
    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.
    is_secure str
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    return_results_behavior str
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    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 function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments List<Property Map>
    List of the arguments for the function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    enableConsoleOutput Boolean
    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.
    isSecure String
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    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 FunctionSql resource produces the following output properties:

    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters List<FunctionSqlParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ShowOutputs List<FunctionSqlShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters []FunctionSqlParameter
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ShowOutputs []FunctionSqlShowOutput
    Outputs the result of SHOW FUNCTION for the given function.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<FunctionSqlParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs List<FunctionSqlShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    functionLanguage string
    Specifies language for the user. Used to detect external changes.
    id string
    The provider-assigned unique ID for this managed resource.
    parameters FunctionSqlParameter[]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs FunctionSqlShowOutput[]
    Outputs the result of SHOW FUNCTION for the given function.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    function_language str
    Specifies language for the user. Used to detect external changes.
    id str
    The provider-assigned unique ID for this managed resource.
    parameters Sequence[FunctionSqlParameter]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    show_outputs Sequence[FunctionSqlShowOutput]
    Outputs the result of SHOW FUNCTION for the given function.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs List<Property Map>
    Outputs the result of SHOW FUNCTION for the given function.

    Look up Existing FunctionSql Resource

    Get an existing FunctionSql 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?: FunctionSqlState, opts?: CustomResourceOptions): FunctionSql
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arguments: Optional[Sequence[FunctionSqlArgumentArgs]] = None,
            comment: Optional[str] = None,
            database: Optional[str] = None,
            enable_console_output: Optional[bool] = None,
            fully_qualified_name: Optional[str] = None,
            function_definition: Optional[str] = None,
            function_language: Optional[str] = None,
            is_secure: Optional[str] = None,
            log_level: Optional[str] = None,
            metric_level: Optional[str] = None,
            name: Optional[str] = None,
            parameters: Optional[Sequence[FunctionSqlParameterArgs]] = None,
            return_results_behavior: Optional[str] = None,
            return_type: Optional[str] = None,
            schema: Optional[str] = None,
            show_outputs: Optional[Sequence[FunctionSqlShowOutputArgs]] = None,
            trace_level: Optional[str] = None) -> FunctionSql
    func GetFunctionSql(ctx *Context, name string, id IDInput, state *FunctionSqlState, opts ...ResourceOption) (*FunctionSql, error)
    public static FunctionSql Get(string name, Input<string> id, FunctionSqlState? state, CustomResourceOptions? opts = null)
    public static FunctionSql get(String name, Output<String> id, FunctionSqlState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arguments List<FunctionSqlArgument>
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    Database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    EnableConsoleOutput bool
    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.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    IsSecure string
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Parameters List<FunctionSqlParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs List<FunctionSqlShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    Arguments []FunctionSqlArgumentArgs
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    Database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    EnableConsoleOutput bool
    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.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    IsSecure string
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Parameters []FunctionSqlParameterArgs
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs []FunctionSqlShowOutputArgs
    Outputs the result of SHOW FUNCTION for the given function.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments List<FunctionSqlArgument>
    List of the arguments for the function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    database String
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enableConsoleOutput Boolean
    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.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    isSecure String
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters List<FunctionSqlParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<FunctionSqlShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments FunctionSqlArgument[]
    List of the arguments for the function. Consult the docs for more details.
    comment string
    Specifies a comment for the function.
    database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enableConsoleOutput boolean
    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.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    functionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    functionLanguage string
    Specifies language for the user. Used to detect external changes.
    isSecure string
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters FunctionSqlParameter[]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    returnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    returnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs FunctionSqlShowOutput[]
    Outputs the result of SHOW FUNCTION for the given function.
    traceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments Sequence[FunctionSqlArgumentArgs]
    List of the arguments for the function. Consult the docs for more details.
    comment str
    Specifies a comment for the function.
    database str
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enable_console_output bool
    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.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    function_definition str
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    function_language str
    Specifies language for the user. Used to detect external changes.
    is_secure str
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters Sequence[FunctionSqlParameterArgs]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    return_results_behavior str
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    return_type str
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema str
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs Sequence[FunctionSqlShowOutputArgs]
    Outputs the result of SHOW FUNCTION for the given function.
    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 function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    database String
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enableConsoleOutput Boolean
    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.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be SQL source code. For more information, see Introduction to SQL UDFs. 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.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    isSecure String
    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 function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<Property Map>
    Outputs the result of SHOW FUNCTION for the given function.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.

    Supporting Types

    FunctionSqlArgument, FunctionSqlArgumentArgs

    ArgDataType string
    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 function definition.
    ArgDefaultValue string
    ArgDataType string
    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 function definition.
    ArgDefaultValue string
    argDataType String
    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 function definition.
    argDefaultValue String
    argDataType string
    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 function definition.
    argDefaultValue string
    arg_data_type str
    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 function definition.
    arg_default_value str
    argDataType String
    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 function definition.
    argDefaultValue String

    FunctionSqlParameter, FunctionSqlParameterArgs

    FunctionSqlParameterEnableConsoleOutput, FunctionSqlParameterEnableConsoleOutputArgs

    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 String
    description String
    key String
    level String
    value String

    FunctionSqlParameterLogLevel, FunctionSqlParameterLogLevelArgs

    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 String
    description String
    key String
    level String
    value String

    FunctionSqlParameterMetricLevel, FunctionSqlParameterMetricLevelArgs

    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 String
    description String
    key String
    level String
    value String

    FunctionSqlParameterTraceLevel, FunctionSqlParameterTraceLevelArgs

    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 String
    description String
    key String
    level String
    value String

    FunctionSqlShowOutput, FunctionSqlShowOutputArgs

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v1.1.0 published on Monday, Jan 13, 2025 by Pulumi