1. Packages
  2. Snowflake
  3. API Docs
  4. Function
Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi

snowflake.Function

Explore with Pulumi AI

snowflake logo
Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.snowflake.Database;
    import com.pulumi.snowflake.DatabaseArgs;
    import com.pulumi.snowflake.Schema;
    import com.pulumi.snowflake.SchemaArgs;
    import com.pulumi.snowflake.Function;
    import com.pulumi.snowflake.FunctionArgs;
    import com.pulumi.snowflake.inputs.FunctionArgumentArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // Create database
            var db = new Database("db", DatabaseArgs.builder()        
                .dataRetentionDays(1)
                .build());
    
            // Create schema
            var schema = new Schema("schema", SchemaArgs.builder()        
                .database(db.name())
                .dataRetentionDays(1)
                .build());
    
            // Example for Java language
            var testFunctJava = new Function("testFunctJava", FunctionArgs.builder()        
                .database("MY_DB")
                .schema("MY_SCHEMA")
                .arguments(FunctionArgumentArgs.builder()
                    .name("arg1")
                    .type("number")
                    .build())
                .comment("Example for java language")
                .returnType("varchar")
                .language("java")
                .handler("CoolFunc.test")
                .statement("class CoolFunc {public static String test(int n) {return \"hello!\";}}")
                .build());
    
            // Example for Python language
            var pythonTest = new Function("pythonTest", FunctionArgs.builder()        
                .database("MY_DB")
                .schema("MY_SCHEMA")
                .arguments(FunctionArgumentArgs.builder()
                    .name("arg1")
                    .type("number")
                    .build())
                .comment("Example for Python language")
                .returnType("NUMBER(38,0)")
                .nullInputBehavior("CALLED ON NULL INPUT")
                .returnBehavior("VOLATILE")
                .language("python")
                .runtimeVersion("3.8")
                .handler("add_py")
                .statement("def add_py(i): return i+1")
                .build());
    
            // Example SQL language
            var sqlTest = new Function("sqlTest", FunctionArgs.builder()        
                .database("MY_DB")
                .schema("MY_SCHEMA")
                .arguments(FunctionArgumentArgs.builder()
                    .name("arg1")
                    .type("number")
                    .build())
                .comment("Example for SQL language")
                .returnType("NUMBER(38,0)")
                .nullInputBehavior("CALLED ON NULL INPUT")
                .returnBehavior("VOLATILE")
                .statement("select arg1 + 1")
                .build());
    
        }
    }
    
    resources:
      # Create database
      db:
        type: snowflake:Database
        properties:
          dataRetentionDays: 1
      # Create schema
      schema:
        type: snowflake:Schema
        properties:
          database: ${db.name}
          dataRetentionDays: 1
      # Example for Java language
      testFunctJava:
        type: snowflake:Function
        properties:
          database: MY_DB
          schema: MY_SCHEMA
          arguments:
            - name: arg1
              type: number
          comment: Example for java language
          returnType: varchar
          language: java
          handler: CoolFunc.test
          statement: class CoolFunc {public static String test(int n) {return "hello!";}}
      # Example for Python language
      pythonTest:
        type: snowflake:Function
        properties:
          database: MY_DB
          schema: MY_SCHEMA
          arguments:
            - name: arg1
              type: number
          comment: Example for Python language
          returnType: NUMBER(38,0)
          nullInputBehavior: CALLED ON NULL INPUT
          returnBehavior: VOLATILE
          language: python
          runtimeVersion: '3.8'
          handler: add_py
          statement: 'def add_py(i): return i+1'
      # Example SQL language
      sqlTest:
        type: snowflake:Function
        properties:
          database: MY_DB
          schema: MY_SCHEMA
          arguments:
            - name: arg1
              type: number
          comment: Example for SQL language
          returnType: NUMBER(38,0)
          nullInputBehavior: CALLED ON NULL INPUT
          returnBehavior: VOLATILE
          statement: select arg1 + 1
    

    Create Function Resource

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

    Constructor syntax

    new Function(name: string, args: FunctionArgs, opts?: CustomResourceOptions);
    @overload
    def Function(resource_name: str,
                 args: FunctionArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Function(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 return_type: Optional[str] = None,
                 statement: Optional[str] = None,
                 database: Optional[str] = None,
                 schema: Optional[str] = None,
                 null_input_behavior: Optional[str] = None,
                 is_secure: Optional[bool] = None,
                 language: Optional[str] = None,
                 name: Optional[str] = None,
                 arguments: Optional[Sequence[FunctionArgumentArgs]] = None,
                 packages: Optional[Sequence[str]] = None,
                 return_behavior: Optional[str] = None,
                 imports: Optional[Sequence[str]] = None,
                 runtime_version: Optional[str] = None,
                 handler: Optional[str] = None,
                 comment: Optional[str] = None,
                 target_path: Optional[str] = None)
    func NewFunction(ctx *Context, name string, args FunctionArgs, opts ...ResourceOption) (*Function, error)
    public Function(string name, FunctionArgs args, CustomResourceOptions? opts = null)
    public Function(String name, FunctionArgs args)
    public Function(String name, FunctionArgs args, CustomResourceOptions options)
    
    type: snowflake:Function
    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 FunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FunctionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FunctionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FunctionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FunctionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var functionResource = new Snowflake.Function("functionResource", new()
    {
        ReturnType = "string",
        Statement = "string",
        Database = "string",
        Schema = "string",
        NullInputBehavior = "string",
        IsSecure = false,
        Language = "string",
        Name = "string",
        Arguments = new[]
        {
            new Snowflake.Inputs.FunctionArgumentArgs
            {
                Name = "string",
                Type = "string",
            },
        },
        Packages = new[]
        {
            "string",
        },
        ReturnBehavior = "string",
        Imports = new[]
        {
            "string",
        },
        RuntimeVersion = "string",
        Handler = "string",
        Comment = "string",
        TargetPath = "string",
    });
    
    example, err := snowflake.NewFunction(ctx, "functionResource", &snowflake.FunctionArgs{
    	ReturnType:        pulumi.String("string"),
    	Statement:         pulumi.String("string"),
    	Database:          pulumi.String("string"),
    	Schema:            pulumi.String("string"),
    	NullInputBehavior: pulumi.String("string"),
    	IsSecure:          pulumi.Bool(false),
    	Language:          pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Arguments: snowflake.FunctionArgumentArray{
    		&snowflake.FunctionArgumentArgs{
    			Name: pulumi.String("string"),
    			Type: pulumi.String("string"),
    		},
    	},
    	Packages: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ReturnBehavior: pulumi.String("string"),
    	Imports: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RuntimeVersion: pulumi.String("string"),
    	Handler:        pulumi.String("string"),
    	Comment:        pulumi.String("string"),
    	TargetPath:     pulumi.String("string"),
    })
    
    var functionResource = new Function("functionResource", FunctionArgs.builder()        
        .returnType("string")
        .statement("string")
        .database("string")
        .schema("string")
        .nullInputBehavior("string")
        .isSecure(false)
        .language("string")
        .name("string")
        .arguments(FunctionArgumentArgs.builder()
            .name("string")
            .type("string")
            .build())
        .packages("string")
        .returnBehavior("string")
        .imports("string")
        .runtimeVersion("string")
        .handler("string")
        .comment("string")
        .targetPath("string")
        .build());
    
    function_resource = snowflake.Function("functionResource",
        return_type="string",
        statement="string",
        database="string",
        schema="string",
        null_input_behavior="string",
        is_secure=False,
        language="string",
        name="string",
        arguments=[snowflake.FunctionArgumentArgs(
            name="string",
            type="string",
        )],
        packages=["string"],
        return_behavior="string",
        imports=["string"],
        runtime_version="string",
        handler="string",
        comment="string",
        target_path="string")
    
    const functionResource = new snowflake.Function("functionResource", {
        returnType: "string",
        statement: "string",
        database: "string",
        schema: "string",
        nullInputBehavior: "string",
        isSecure: false,
        language: "string",
        name: "string",
        arguments: [{
            name: "string",
            type: "string",
        }],
        packages: ["string"],
        returnBehavior: "string",
        imports: ["string"],
        runtimeVersion: "string",
        handler: "string",
        comment: "string",
        targetPath: "string",
    });
    
    type: snowflake:Function
    properties:
        arguments:
            - name: string
              type: string
        comment: string
        database: string
        handler: string
        imports:
            - string
        isSecure: false
        language: string
        name: string
        nullInputBehavior: string
        packages:
            - string
        returnBehavior: string
        returnType: string
        runtimeVersion: string
        schema: string
        statement: string
        targetPath: string
    

    Function Resource Properties

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

    Inputs

    The Function resource accepts the following input properties:

    Database string
    The database in which to create the function. Don't use the | character.
    ReturnType string
    The return type of the function
    Schema string
    The schema in which to create the function. Don't use the | character.
    Statement string
    Specifies the javascript / java / scala / sql / python code used to create the function.
    Arguments List<FunctionArgument>
    List of the arguments for the function
    Comment string
    Specifies a comment for the function.
    Handler string
    The handler method for Java / Python function.
    Imports List<string>
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    IsSecure bool
    Specifies that the function is secure.
    Language string
    Specifies the language of the stored function code.
    Name string
    The argument name
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs.
    Packages List<string>
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    ReturnBehavior string
    Specifies the behavior of the function when returning results
    RuntimeVersion string
    Required for Python functions. Specifies Python runtime version.
    TargetPath string
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    Database string
    The database in which to create the function. Don't use the | character.
    ReturnType string
    The return type of the function
    Schema string
    The schema in which to create the function. Don't use the | character.
    Statement string
    Specifies the javascript / java / scala / sql / python code used to create the function.
    Arguments []FunctionArgumentArgs
    List of the arguments for the function
    Comment string
    Specifies a comment for the function.
    Handler string
    The handler method for Java / Python function.
    Imports []string
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    IsSecure bool
    Specifies that the function is secure.
    Language string
    Specifies the language of the stored function code.
    Name string
    The argument name
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs.
    Packages []string
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    ReturnBehavior string
    Specifies the behavior of the function when returning results
    RuntimeVersion string
    Required for Python functions. Specifies Python runtime version.
    TargetPath string
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    database String
    The database in which to create the function. Don't use the | character.
    returnType String
    The return type of the function
    schema String
    The schema in which to create the function. Don't use the | character.
    statement String
    Specifies the javascript / java / scala / sql / python code used to create the function.
    arguments List<FunctionArgument>
    List of the arguments for the function
    comment String
    Specifies a comment for the function.
    handler String
    The handler method for Java / Python function.
    imports List<String>
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    isSecure Boolean
    Specifies that the function is secure.
    language String
    Specifies the language of the stored function code.
    name String
    The argument name
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs.
    packages List<String>
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    returnBehavior String
    Specifies the behavior of the function when returning results
    runtimeVersion String
    Required for Python functions. Specifies Python runtime version.
    targetPath String
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    database string
    The database in which to create the function. Don't use the | character.
    returnType string
    The return type of the function
    schema string
    The schema in which to create the function. Don't use the | character.
    statement string
    Specifies the javascript / java / scala / sql / python code used to create the function.
    arguments FunctionArgument[]
    List of the arguments for the function
    comment string
    Specifies a comment for the function.
    handler string
    The handler method for Java / Python function.
    imports string[]
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    isSecure boolean
    Specifies that the function is secure.
    language string
    Specifies the language of the stored function code.
    name string
    The argument name
    nullInputBehavior string
    Specifies the behavior of the function when called with null inputs.
    packages string[]
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    returnBehavior string
    Specifies the behavior of the function when returning results
    runtimeVersion string
    Required for Python functions. Specifies Python runtime version.
    targetPath string
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    database str
    The database in which to create the function. Don't use the | character.
    return_type str
    The return type of the function
    schema str
    The schema in which to create the function. Don't use the | character.
    statement str
    Specifies the javascript / java / scala / sql / python code used to create the function.
    arguments Sequence[FunctionArgumentArgs]
    List of the arguments for the function
    comment str
    Specifies a comment for the function.
    handler str
    The handler method for Java / Python function.
    imports Sequence[str]
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    is_secure bool
    Specifies that the function is secure.
    language str
    Specifies the language of the stored function code.
    name str
    The argument name
    null_input_behavior str
    Specifies the behavior of the function when called with null inputs.
    packages Sequence[str]
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    return_behavior str
    Specifies the behavior of the function when returning results
    runtime_version str
    Required for Python functions. Specifies Python runtime version.
    target_path str
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    database String
    The database in which to create the function. Don't use the | character.
    returnType String
    The return type of the function
    schema String
    The schema in which to create the function. Don't use the | character.
    statement String
    Specifies the javascript / java / scala / sql / python code used to create the function.
    arguments List<Property Map>
    List of the arguments for the function
    comment String
    Specifies a comment for the function.
    handler String
    The handler method for Java / Python function.
    imports List<String>
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    isSecure Boolean
    Specifies that the function is secure.
    language String
    Specifies the language of the stored function code.
    name String
    The argument name
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs.
    packages List<String>
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    returnBehavior String
    Specifies the behavior of the function when returning results
    runtimeVersion String
    Required for Python functions. Specifies Python runtime version.
    targetPath String
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Function Resource

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

    public static get(name: string, id: Input<ID>, state?: FunctionState, opts?: CustomResourceOptions): Function
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arguments: Optional[Sequence[FunctionArgumentArgs]] = None,
            comment: Optional[str] = None,
            database: Optional[str] = None,
            handler: Optional[str] = None,
            imports: Optional[Sequence[str]] = None,
            is_secure: Optional[bool] = None,
            language: Optional[str] = None,
            name: Optional[str] = None,
            null_input_behavior: Optional[str] = None,
            packages: Optional[Sequence[str]] = None,
            return_behavior: Optional[str] = None,
            return_type: Optional[str] = None,
            runtime_version: Optional[str] = None,
            schema: Optional[str] = None,
            statement: Optional[str] = None,
            target_path: Optional[str] = None) -> Function
    func GetFunction(ctx *Context, name string, id IDInput, state *FunctionState, opts ...ResourceOption) (*Function, error)
    public static Function Get(string name, Input<string> id, FunctionState? state, CustomResourceOptions? opts = null)
    public static Function get(String name, Output<String> id, FunctionState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arguments List<FunctionArgument>
    List of the arguments for the function
    Comment string
    Specifies a comment for the function.
    Database string
    The database in which to create the function. Don't use the | character.
    Handler string
    The handler method for Java / Python function.
    Imports List<string>
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    IsSecure bool
    Specifies that the function is secure.
    Language string
    Specifies the language of the stored function code.
    Name string
    The argument name
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs.
    Packages List<string>
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    ReturnBehavior string
    Specifies the behavior of the function when returning results
    ReturnType string
    The return type of the function
    RuntimeVersion string
    Required for Python functions. Specifies Python runtime version.
    Schema string
    The schema in which to create the function. Don't use the | character.
    Statement string
    Specifies the javascript / java / scala / sql / python code used to create the function.
    TargetPath string
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    Arguments []FunctionArgumentArgs
    List of the arguments for the function
    Comment string
    Specifies a comment for the function.
    Database string
    The database in which to create the function. Don't use the | character.
    Handler string
    The handler method for Java / Python function.
    Imports []string
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    IsSecure bool
    Specifies that the function is secure.
    Language string
    Specifies the language of the stored function code.
    Name string
    The argument name
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs.
    Packages []string
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    ReturnBehavior string
    Specifies the behavior of the function when returning results
    ReturnType string
    The return type of the function
    RuntimeVersion string
    Required for Python functions. Specifies Python runtime version.
    Schema string
    The schema in which to create the function. Don't use the | character.
    Statement string
    Specifies the javascript / java / scala / sql / python code used to create the function.
    TargetPath string
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    arguments List<FunctionArgument>
    List of the arguments for the function
    comment String
    Specifies a comment for the function.
    database String
    The database in which to create the function. Don't use the | character.
    handler String
    The handler method for Java / Python function.
    imports List<String>
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    isSecure Boolean
    Specifies that the function is secure.
    language String
    Specifies the language of the stored function code.
    name String
    The argument name
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs.
    packages List<String>
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    returnBehavior String
    Specifies the behavior of the function when returning results
    returnType String
    The return type of the function
    runtimeVersion String
    Required for Python functions. Specifies Python runtime version.
    schema String
    The schema in which to create the function. Don't use the | character.
    statement String
    Specifies the javascript / java / scala / sql / python code used to create the function.
    targetPath String
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    arguments FunctionArgument[]
    List of the arguments for the function
    comment string
    Specifies a comment for the function.
    database string
    The database in which to create the function. Don't use the | character.
    handler string
    The handler method for Java / Python function.
    imports string[]
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    isSecure boolean
    Specifies that the function is secure.
    language string
    Specifies the language of the stored function code.
    name string
    The argument name
    nullInputBehavior string
    Specifies the behavior of the function when called with null inputs.
    packages string[]
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    returnBehavior string
    Specifies the behavior of the function when returning results
    returnType string
    The return type of the function
    runtimeVersion string
    Required for Python functions. Specifies Python runtime version.
    schema string
    The schema in which to create the function. Don't use the | character.
    statement string
    Specifies the javascript / java / scala / sql / python code used to create the function.
    targetPath string
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    arguments Sequence[FunctionArgumentArgs]
    List of the arguments for the function
    comment str
    Specifies a comment for the function.
    database str
    The database in which to create the function. Don't use the | character.
    handler str
    The handler method for Java / Python function.
    imports Sequence[str]
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    is_secure bool
    Specifies that the function is secure.
    language str
    Specifies the language of the stored function code.
    name str
    The argument name
    null_input_behavior str
    Specifies the behavior of the function when called with null inputs.
    packages Sequence[str]
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    return_behavior str
    Specifies the behavior of the function when returning results
    return_type str
    The return type of the function
    runtime_version str
    Required for Python functions. Specifies Python runtime version.
    schema str
    The schema in which to create the function. Don't use the | character.
    statement str
    Specifies the javascript / java / scala / sql / python code used to create the function.
    target_path str
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.
    arguments List<Property Map>
    List of the arguments for the function
    comment String
    Specifies a comment for the function.
    database String
    The database in which to create the function. Don't use the | character.
    handler String
    The handler method for Java / Python function.
    imports List<String>
    Imports for Java / Python functions. For Java this a list of jar files, for Python this is a list of Python files.
    isSecure Boolean
    Specifies that the function is secure.
    language String
    Specifies the language of the stored function code.
    name String
    The argument name
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs.
    packages List<String>
    List of package imports to use for Java / Python functions. For Java, package imports should be of the form: packagename:versionnumber, where packagename is snowflakedomain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').
    returnBehavior String
    Specifies the behavior of the function when returning results
    returnType String
    The return type of the function
    runtimeVersion String
    Required for Python functions. Specifies Python runtime version.
    schema String
    The schema in which to create the function. Don't use the | character.
    statement String
    Specifies the javascript / java / scala / sql / python code used to create the function.
    targetPath String
    The target path for the Java / Python functions. For Java, it is the path of compiled jar files and for the Python it is the path of the Python files.

    Supporting Types

    FunctionArgument, FunctionArgumentArgs

    Name string
    The argument name
    Type string
    The argument type
    Name string
    The argument name
    Type string
    The argument type
    name String
    The argument name
    type String
    The argument type
    name string
    The argument name
    type string
    The argument type
    name str
    The argument name
    type str
    The argument type
    name String
    The argument name
    type String
    The argument type

    Import

    format is database name | schema name | function name | <list of arg types, separated with ‘-'>

    $ pulumi import snowflake:index/function:Function example 'dbName|schemaName|functionName|varchar-varchar-varchar'
    

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

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Snowflake v0.51.0 published on Wednesday, Apr 10, 2024 by Pulumi