Databricks v1.56.0, Nov 12 24

Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi

databricks.getFunctions

Explore with Pulumi AI

Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi

pulumi/pulumi-databricks

Example Usage

List all functions defined in a specific schema (main.default in this example):

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

const all = databricks.getFunctions({
    catalogName: "main",
    schemaName: "default",
});
export const allExternalLocations = all.then(all => all.functions);

import pulumi
import pulumi_databricks as databricks

all = databricks.get_functions(catalog_name="main",
    schema_name="default")
pulumi.export("allExternalLocations", all.functions)

package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		all, err := databricks.GetFunctions(ctx, &databricks.GetFunctionsArgs{
			CatalogName: "main",
			SchemaName:  "default",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("allExternalLocations", all.Functions)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var all = Databricks.GetFunctions.Invoke(new()
    {
        CatalogName = "main",
        SchemaName = "default",
    });

    return new Dictionary<string, object?>
    {
        ["allExternalLocations"] = all.Apply(getFunctionsResult => getFunctionsResult.Functions),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetFunctionsArgs;
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) {
        final var all = DatabricksFunctions.getFunctions(GetFunctionsArgs.builder()
            .catalogName("main")
            .schemaName("default")
            .build());

        ctx.export("allExternalLocations", all.applyValue(getFunctionsResult -> getFunctionsResult.functions()));
    }
}

variables:
  all:
    fn::invoke:
      Function: databricks:getFunctions
      Arguments:
        catalogName: main
        schemaName: default
outputs:
  allExternalLocations: ${all.functions}

The following resources are used in the same context:

databricks.Schema to get information about a single schema

Using getFunctions

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getFunctions(args: GetFunctionsArgs, opts?: InvokeOptions): Promise<GetFunctionsResult>
function getFunctionsOutput(args: GetFunctionsOutputArgs, opts?: InvokeOptions): Output<GetFunctionsResult>

def get_functions(catalog_name: Optional[str] = None,
                  functions: Optional[Sequence[GetFunctionsFunction]] = None,
                  include_browse: Optional[bool] = None,
                  schema_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetFunctionsResult
def get_functions_output(catalog_name: Optional[pulumi.Input[str]] = None,
                  functions: Optional[pulumi.Input[Sequence[pulumi.Input[GetFunctionsFunctionArgs]]]] = None,
                  include_browse: Optional[pulumi.Input[bool]] = None,
                  schema_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetFunctionsResult]

func GetFunctions(ctx *Context, args *GetFunctionsArgs, opts ...InvokeOption) (*GetFunctionsResult, error)
func GetFunctionsOutput(ctx *Context, args *GetFunctionsOutputArgs, opts ...InvokeOption) GetFunctionsResultOutput

> Note: This function is named GetFunctions in the Go SDK.

public static class GetFunctions 
{
    public static Task<GetFunctionsResult> InvokeAsync(GetFunctionsArgs args, InvokeOptions? opts = null)
    public static Output<GetFunctionsResult> Invoke(GetFunctionsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetFunctionsResult> getFunctions(GetFunctionsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: databricks:index/getFunctions:getFunctions
  arguments:
    # arguments dictionary

The following arguments are supported:

CatalogName string: Name of databricks_catalog.
SchemaName string: Name of databricks_schema.
Functions List<GetFunctionsFunction>: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
IncludeBrowse bool: flag to specify if include UDFs in the response for which the principal can only access selective metadata for.

CatalogName string: Name of databricks_catalog.
SchemaName string: Name of databricks_schema.
Functions []GetFunctionsFunction: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
IncludeBrowse bool: flag to specify if include UDFs in the response for which the principal can only access selective metadata for.

catalogName String: Name of databricks_catalog.
schemaName String: Name of databricks_schema.
functions List<GetFunctionsFunction>: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
includeBrowse Boolean: flag to specify if include UDFs in the response for which the principal can only access selective metadata for.

catalogName string: Name of databricks_catalog.
schemaName string: Name of databricks_schema.
functions GetFunctionsFunction[]: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
includeBrowse boolean: flag to specify if include UDFs in the response for which the principal can only access selective metadata for.

catalog_name str: Name of databricks_catalog.
schema_name str: Name of databricks_schema.
functions Sequence[GetFunctionsFunction]: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
include_browse bool: flag to specify if include UDFs in the response for which the principal can only access selective metadata for.

catalogName String: Name of databricks_catalog.
schemaName String: Name of databricks_schema.
functions List<Property Map>: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
includeBrowse Boolean: flag to specify if include UDFs in the response for which the principal can only access selective metadata for.

getFunctions Result

The following output properties are available:

CatalogName string: Name of parent catalog.
Id string: The provider-assigned unique ID for this managed resource.
SchemaName string: Name of parent schema relative to its parent catalog.
Functions List<GetFunctionsFunction>: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
IncludeBrowse bool

CatalogName string: Name of parent catalog.
Id string: The provider-assigned unique ID for this managed resource.
SchemaName string: Name of parent schema relative to its parent catalog.
Functions []GetFunctionsFunction: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
IncludeBrowse bool

catalogName String: Name of parent catalog.
id String: The provider-assigned unique ID for this managed resource.
schemaName String: Name of parent schema relative to its parent catalog.
functions List<GetFunctionsFunction>: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
includeBrowse Boolean

catalogName string: Name of parent catalog.
id string: The provider-assigned unique ID for this managed resource.
schemaName string: Name of parent schema relative to its parent catalog.
functions GetFunctionsFunction[]: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
includeBrowse boolean

catalog_name str: Name of parent catalog.
id str: The provider-assigned unique ID for this managed resource.
schema_name str: Name of parent schema relative to its parent catalog.
functions Sequence[GetFunctionsFunction]: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
include_browse bool

catalogName String: Name of parent catalog.
id String: The provider-assigned unique ID for this managed resource.
schemaName String: Name of parent schema relative to its parent catalog.
functions List<Property Map>: list of objects describing individual UDF. Each object consists of the following attributes (refer to REST API documentation for up-to-date list of attributes. Default type is String):
includeBrowse Boolean

Supporting Types

GetFunctionsFunction

BrowseOnly bool: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
CatalogName string: Name of databricks_catalog.
Comment string: User-provided free-form text description.
CreatedAt int: Time at which this function was created, in epoch milliseconds.
CreatedBy string: Username of function creator.
DataType string: Scalar function return data type.
ExternalLanguage string: External function language.
ExternalName string: External function name.
FullDataType string: Pretty printed function data type.
FullName string: Full name of function, in form of catalog_name.schema_name.function__name
FunctionId string: Id of Function, relative to parent schema.
InputParams GetFunctionsFunctionInputParams: object describing input parameters. Consists of the single attribute:
IsDeterministic bool: Boolean flag specifying whether the function is deterministic.
IsNullCall bool: Boolean flag whether function null call.
MetastoreId string: Unique identifier of parent metastore.
Name string: Name of parameter.
Owner string: Username of current owner of function.
ParameterStyle string: Function parameter style. S is the value for SQL.
Properties string: JSON-serialized key-value pair map, encoded (escaped) as a string.
ReturnParams GetFunctionsFunctionReturnParams: Table function return parameters. See input_params for description.
RoutineBody string: Function language (SQL or EXTERNAL). When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.
RoutineDefinition string: Function body.
RoutineDependencies GetFunctionsFunctionRoutineDependencies: Function dependencies.
SchemaName string: Name of databricks_schema.
SecurityType string: Function security type. (Enum: DEFINER).
SpecificName string: Specific name of the function; Reserved for future use.
SqlDataAccess string: Function SQL data access (CONTAINS_SQL, READS_SQL_DATA, NO_SQL).
SqlPath string: List of schemes whose objects can be referenced without qualification.
UpdatedAt int: Time at which this function was created, in epoch milliseconds.
UpdatedBy string: Username of user who last modified function.

BrowseOnly bool: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
CatalogName string: Name of databricks_catalog.
Comment string: User-provided free-form text description.
CreatedAt int: Time at which this function was created, in epoch milliseconds.
CreatedBy string: Username of function creator.
DataType string: Scalar function return data type.
ExternalLanguage string: External function language.
ExternalName string: External function name.
FullDataType string: Pretty printed function data type.
FullName string: Full name of function, in form of catalog_name.schema_name.function__name
FunctionId string: Id of Function, relative to parent schema.
InputParams GetFunctionsFunctionInputParams: object describing input parameters. Consists of the single attribute:
IsDeterministic bool: Boolean flag specifying whether the function is deterministic.
IsNullCall bool: Boolean flag whether function null call.
MetastoreId string: Unique identifier of parent metastore.
Name string: Name of parameter.
Owner string: Username of current owner of function.
ParameterStyle string: Function parameter style. S is the value for SQL.
Properties string: JSON-serialized key-value pair map, encoded (escaped) as a string.
ReturnParams GetFunctionsFunctionReturnParams: Table function return parameters. See input_params for description.
RoutineBody string: Function language (SQL or EXTERNAL). When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.
RoutineDefinition string: Function body.
RoutineDependencies GetFunctionsFunctionRoutineDependencies: Function dependencies.
SchemaName string: Name of databricks_schema.
SecurityType string: Function security type. (Enum: DEFINER).
SpecificName string: Specific name of the function; Reserved for future use.
SqlDataAccess string: Function SQL data access (CONTAINS_SQL, READS_SQL_DATA, NO_SQL).
SqlPath string: List of schemes whose objects can be referenced without qualification.
UpdatedAt int: Time at which this function was created, in epoch milliseconds.
UpdatedBy string: Username of user who last modified function.

browseOnly Boolean: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
catalogName String: Name of databricks_catalog.
comment String: User-provided free-form text description.
createdAt Integer: Time at which this function was created, in epoch milliseconds.
createdBy String: Username of function creator.
dataType String: Scalar function return data type.
externalLanguage String: External function language.
externalName String: External function name.
fullDataType String: Pretty printed function data type.
fullName String: Full name of function, in form of catalog_name.schema_name.function__name
functionId String: Id of Function, relative to parent schema.
inputParams GetFunctionsFunctionInputParams: object describing input parameters. Consists of the single attribute:
isDeterministic Boolean: Boolean flag specifying whether the function is deterministic.
isNullCall Boolean: Boolean flag whether function null call.
metastoreId String: Unique identifier of parent metastore.
name String: Name of parameter.
owner String: Username of current owner of function.
parameterStyle String: Function parameter style. S is the value for SQL.
properties String: JSON-serialized key-value pair map, encoded (escaped) as a string.
returnParams GetFunctionsFunctionReturnParams: Table function return parameters. See input_params for description.
routineBody String: Function language (SQL or EXTERNAL). When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.
routineDefinition String: Function body.
routineDependencies GetFunctionsFunctionRoutineDependencies: Function dependencies.
schemaName String: Name of databricks_schema.
securityType String: Function security type. (Enum: DEFINER).
specificName String: Specific name of the function; Reserved for future use.
sqlDataAccess String: Function SQL data access (CONTAINS_SQL, READS_SQL_DATA, NO_SQL).
sqlPath String: List of schemes whose objects can be referenced without qualification.
updatedAt Integer: Time at which this function was created, in epoch milliseconds.
updatedBy String: Username of user who last modified function.

browseOnly boolean: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
catalogName string: Name of databricks_catalog.
comment string: User-provided free-form text description.
createdAt number: Time at which this function was created, in epoch milliseconds.
createdBy string: Username of function creator.
dataType string: Scalar function return data type.
externalLanguage string: External function language.
externalName string: External function name.
fullDataType string: Pretty printed function data type.
fullName string: Full name of function, in form of catalog_name.schema_name.function__name
functionId string: Id of Function, relative to parent schema.
inputParams GetFunctionsFunctionInputParams: object describing input parameters. Consists of the single attribute:
isDeterministic boolean: Boolean flag specifying whether the function is deterministic.
isNullCall boolean: Boolean flag whether function null call.
metastoreId string: Unique identifier of parent metastore.
name string: Name of parameter.
owner string: Username of current owner of function.
parameterStyle string: Function parameter style. S is the value for SQL.
properties string: JSON-serialized key-value pair map, encoded (escaped) as a string.
returnParams GetFunctionsFunctionReturnParams: Table function return parameters. See input_params for description.
routineBody string: Function language (SQL or EXTERNAL). When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.
routineDefinition string: Function body.
routineDependencies GetFunctionsFunctionRoutineDependencies: Function dependencies.
schemaName string: Name of databricks_schema.
securityType string: Function security type. (Enum: DEFINER).
specificName string: Specific name of the function; Reserved for future use.
sqlDataAccess string: Function SQL data access (CONTAINS_SQL, READS_SQL_DATA, NO_SQL).
sqlPath string: List of schemes whose objects can be referenced without qualification.
updatedAt number: Time at which this function was created, in epoch milliseconds.
updatedBy string: Username of user who last modified function.

browse_only bool: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
catalog_name str: Name of databricks_catalog.
comment str: User-provided free-form text description.
created_at int: Time at which this function was created, in epoch milliseconds.
created_by str: Username of function creator.
data_type str: Scalar function return data type.
external_language str: External function language.
external_name str: External function name.
full_data_type str: Pretty printed function data type.
full_name str: Full name of function, in form of catalog_name.schema_name.function__name
function_id str: Id of Function, relative to parent schema.
input_params GetFunctionsFunctionInputParams: object describing input parameters. Consists of the single attribute:
is_deterministic bool: Boolean flag specifying whether the function is deterministic.
is_null_call bool: Boolean flag whether function null call.
metastore_id str: Unique identifier of parent metastore.
name str: Name of parameter.
owner str: Username of current owner of function.
parameter_style str: Function parameter style. S is the value for SQL.
properties str: JSON-serialized key-value pair map, encoded (escaped) as a string.
return_params GetFunctionsFunctionReturnParams: Table function return parameters. See input_params for description.
routine_body str: Function language (SQL or EXTERNAL). When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.
routine_definition str: Function body.
routine_dependencies GetFunctionsFunctionRoutineDependencies: Function dependencies.
schema_name str: Name of databricks_schema.
security_type str: Function security type. (Enum: DEFINER).
specific_name str: Specific name of the function; Reserved for future use.
sql_data_access str: Function SQL data access (CONTAINS_SQL, READS_SQL_DATA, NO_SQL).
sql_path str: List of schemes whose objects can be referenced without qualification.
updated_at int: Time at which this function was created, in epoch milliseconds.
updated_by str: Username of user who last modified function.

browseOnly Boolean: Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.
catalogName String: Name of databricks_catalog.
comment String: User-provided free-form text description.
createdAt Number: Time at which this function was created, in epoch milliseconds.
createdBy String: Username of function creator.
dataType String: Scalar function return data type.
externalLanguage String: External function language.
externalName String: External function name.
fullDataType String: Pretty printed function data type.
fullName String: Full name of function, in form of catalog_name.schema_name.function__name
functionId String: Id of Function, relative to parent schema.
inputParams Property Map: object describing input parameters. Consists of the single attribute:
isDeterministic Boolean: Boolean flag specifying whether the function is deterministic.
isNullCall Boolean: Boolean flag whether function null call.
metastoreId String: Unique identifier of parent metastore.
name String: Name of parameter.
owner String: Username of current owner of function.
parameterStyle String: Function parameter style. S is the value for SQL.
properties String: JSON-serialized key-value pair map, encoded (escaped) as a string.
returnParams Property Map: Table function return parameters. See input_params for description.
routineBody String: Function language (SQL or EXTERNAL). When EXTERNAL is used, the language of the routine function should be specified in the external_language field, and the return_params of the function cannot be used (as TABLE return type is not supported), and the sql_data_access field must be NO_SQL.
routineDefinition String: Function body.
routineDependencies Property Map: Function dependencies.
schemaName String: Name of databricks_schema.
securityType String: Function security type. (Enum: DEFINER).
specificName String: Specific name of the function; Reserved for future use.
sqlDataAccess String: Function SQL data access (CONTAINS_SQL, READS_SQL_DATA, NO_SQL).
sqlPath String: List of schemes whose objects can be referenced without qualification.
updatedAt Number: Time at which this function was created, in epoch milliseconds.
updatedBy String: Username of user who last modified function.

GetFunctionsFunctionInputParams

Parameters List<GetFunctionsFunctionInputParamsParameter>: The array of definitions of the function's parameters:

Parameters []GetFunctionsFunctionInputParamsParameter: The array of definitions of the function's parameters:

parameters List<GetFunctionsFunctionInputParamsParameter>: The array of definitions of the function's parameters:

parameters GetFunctionsFunctionInputParamsParameter[]: The array of definitions of the function's parameters:

parameters Sequence[GetFunctionsFunctionInputParamsParameter]: The array of definitions of the function's parameters:

parameters List<Property Map>: The array of definitions of the function's parameters:

GetFunctionsFunctionInputParamsParameter

Name string: Name of parameter.
Position int: Ordinal position of column (starting at position 0).
TypeName string: Name of type (INT, STRUCT, MAP, etc.).
TypeText string: Full data type spec, SQL/catalogString text.
Comment string: User-provided free-form text description.
ParameterDefault string: Default value of the parameter.
ParameterMode string: The mode of the function parameter.
ParameterType string: The type of function parameter (PARAM or COLUMN).
TypeIntervalType string: Format of IntervalType.
TypeJson string: Full data type spec, JSON-serialized.
TypePrecision int: Digits of precision; required on Create for DecimalTypes.
TypeScale int: Digits to right of decimal; Required on Create for DecimalTypes.

Name string: Name of parameter.
Position int: Ordinal position of column (starting at position 0).
TypeName string: Name of type (INT, STRUCT, MAP, etc.).
TypeText string: Full data type spec, SQL/catalogString text.
Comment string: User-provided free-form text description.
ParameterDefault string: Default value of the parameter.
ParameterMode string: The mode of the function parameter.
ParameterType string: The type of function parameter (PARAM or COLUMN).
TypeIntervalType string: Format of IntervalType.
TypeJson string: Full data type spec, JSON-serialized.
TypePrecision int: Digits of precision; required on Create for DecimalTypes.
TypeScale int: Digits to right of decimal; Required on Create for DecimalTypes.

name String: Name of parameter.
position Integer: Ordinal position of column (starting at position 0).
typeName String: Name of type (INT, STRUCT, MAP, etc.).
typeText String: Full data type spec, SQL/catalogString text.
comment String: User-provided free-form text description.
parameterDefault String: Default value of the parameter.
parameterMode String: The mode of the function parameter.
parameterType String: The type of function parameter (PARAM or COLUMN).
typeIntervalType String: Format of IntervalType.
typeJson String: Full data type spec, JSON-serialized.
typePrecision Integer: Digits of precision; required on Create for DecimalTypes.
typeScale Integer: Digits to right of decimal; Required on Create for DecimalTypes.

name string: Name of parameter.
position number: Ordinal position of column (starting at position 0).
typeName string: Name of type (INT, STRUCT, MAP, etc.).
typeText string: Full data type spec, SQL/catalogString text.
comment string: User-provided free-form text description.
parameterDefault string: Default value of the parameter.
parameterMode string: The mode of the function parameter.
parameterType string: The type of function parameter (PARAM or COLUMN).
typeIntervalType string: Format of IntervalType.
typeJson string: Full data type spec, JSON-serialized.
typePrecision number: Digits of precision; required on Create for DecimalTypes.
typeScale number: Digits to right of decimal; Required on Create for DecimalTypes.

name str: Name of parameter.
position int: Ordinal position of column (starting at position 0).
type_name str: Name of type (INT, STRUCT, MAP, etc.).
type_text str: Full data type spec, SQL/catalogString text.
comment str: User-provided free-form text description.
parameter_default str: Default value of the parameter.
parameter_mode str: The mode of the function parameter.
parameter_type str: The type of function parameter (PARAM or COLUMN).
type_interval_type str: Format of IntervalType.
type_json str: Full data type spec, JSON-serialized.
type_precision int: Digits of precision; required on Create for DecimalTypes.
type_scale int: Digits to right of decimal; Required on Create for DecimalTypes.

name String: Name of parameter.
position Number: Ordinal position of column (starting at position 0).
typeName String: Name of type (INT, STRUCT, MAP, etc.).
typeText String: Full data type spec, SQL/catalogString text.
comment String: User-provided free-form text description.
parameterDefault String: Default value of the parameter.
parameterMode String: The mode of the function parameter.
parameterType String: The type of function parameter (PARAM or COLUMN).
typeIntervalType String: Format of IntervalType.
typeJson String: Full data type spec, JSON-serialized.
typePrecision Number: Digits of precision; required on Create for DecimalTypes.
typeScale Number: Digits to right of decimal; Required on Create for DecimalTypes.

GetFunctionsFunctionReturnParams

Parameters List<GetFunctionsFunctionReturnParamsParameter>: The array of definitions of the function's parameters:

Parameters []GetFunctionsFunctionReturnParamsParameter: The array of definitions of the function's parameters:

parameters List<GetFunctionsFunctionReturnParamsParameter>: The array of definitions of the function's parameters:

parameters GetFunctionsFunctionReturnParamsParameter[]: The array of definitions of the function's parameters:

parameters Sequence[GetFunctionsFunctionReturnParamsParameter]: The array of definitions of the function's parameters:

parameters List<Property Map>: The array of definitions of the function's parameters:

GetFunctionsFunctionReturnParamsParameter

Name string: Name of parameter.
Position int: Ordinal position of column (starting at position 0).
TypeName string: Name of type (INT, STRUCT, MAP, etc.).
TypeText string: Full data type spec, SQL/catalogString text.
Comment string: User-provided free-form text description.
ParameterDefault string: Default value of the parameter.
ParameterMode string: The mode of the function parameter.
ParameterType string: The type of function parameter (PARAM or COLUMN).
TypeIntervalType string: Format of IntervalType.
TypeJson string: Full data type spec, JSON-serialized.
TypePrecision int: Digits of precision; required on Create for DecimalTypes.
TypeScale int: Digits to right of decimal; Required on Create for DecimalTypes.

Name string: Name of parameter.
Position int: Ordinal position of column (starting at position 0).
TypeName string: Name of type (INT, STRUCT, MAP, etc.).
TypeText string: Full data type spec, SQL/catalogString text.
Comment string: User-provided free-form text description.
ParameterDefault string: Default value of the parameter.
ParameterMode string: The mode of the function parameter.
ParameterType string: The type of function parameter (PARAM or COLUMN).
TypeIntervalType string: Format of IntervalType.
TypeJson string: Full data type spec, JSON-serialized.
TypePrecision int: Digits of precision; required on Create for DecimalTypes.
TypeScale int: Digits to right of decimal; Required on Create for DecimalTypes.

name String: Name of parameter.
position Integer: Ordinal position of column (starting at position 0).
typeName String: Name of type (INT, STRUCT, MAP, etc.).
typeText String: Full data type spec, SQL/catalogString text.
comment String: User-provided free-form text description.
parameterDefault String: Default value of the parameter.
parameterMode String: The mode of the function parameter.
parameterType String: The type of function parameter (PARAM or COLUMN).
typeIntervalType String: Format of IntervalType.
typeJson String: Full data type spec, JSON-serialized.
typePrecision Integer: Digits of precision; required on Create for DecimalTypes.
typeScale Integer: Digits to right of decimal; Required on Create for DecimalTypes.

name string: Name of parameter.
position number: Ordinal position of column (starting at position 0).
typeName string: Name of type (INT, STRUCT, MAP, etc.).
typeText string: Full data type spec, SQL/catalogString text.
comment string: User-provided free-form text description.
parameterDefault string: Default value of the parameter.
parameterMode string: The mode of the function parameter.
parameterType string: The type of function parameter (PARAM or COLUMN).
typeIntervalType string: Format of IntervalType.
typeJson string: Full data type spec, JSON-serialized.
typePrecision number: Digits of precision; required on Create for DecimalTypes.
typeScale number: Digits to right of decimal; Required on Create for DecimalTypes.

name str: Name of parameter.
position int: Ordinal position of column (starting at position 0).
type_name str: Name of type (INT, STRUCT, MAP, etc.).
type_text str: Full data type spec, SQL/catalogString text.
comment str: User-provided free-form text description.
parameter_default str: Default value of the parameter.
parameter_mode str: The mode of the function parameter.
parameter_type str: The type of function parameter (PARAM or COLUMN).
type_interval_type str: Format of IntervalType.
type_json str: Full data type spec, JSON-serialized.
type_precision int: Digits of precision; required on Create for DecimalTypes.
type_scale int: Digits to right of decimal; Required on Create for DecimalTypes.

name String: Name of parameter.
position Number: Ordinal position of column (starting at position 0).
typeName String: Name of type (INT, STRUCT, MAP, etc.).
typeText String: Full data type spec, SQL/catalogString text.
comment String: User-provided free-form text description.
parameterDefault String: Default value of the parameter.
parameterMode String: The mode of the function parameter.
parameterType String: The type of function parameter (PARAM or COLUMN).
typeIntervalType String: Format of IntervalType.
typeJson String: Full data type spec, JSON-serialized.
typePrecision Number: Digits of precision; required on Create for DecimalTypes.
typeScale Number: Digits to right of decimal; Required on Create for DecimalTypes.

Package Details

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

Databricks v1.56.0 published on Tuesday, Nov 12, 2024 by Pulumi

pulumi/pulumi-databricks

databricks.getFunctions

On this page

On this page

Example Usage

Using getFunctions

getFunctions Result

Supporting Types

GetFunctionsFunction

GetFunctionsFunctionInputParams

GetFunctionsFunctionInputParamsParameter

GetFunctionsFunctionReturnParams

GetFunctionsFunctionReturnParamsParameter

GetFunctionsFunctionRoutineDependencies

GetFunctionsFunctionRoutineDependenciesDependency

GetFunctionsFunctionRoutineDependenciesDependencyFunction

GetFunctionsFunctionRoutineDependenciesDependencyTable

Package Details

On this page

On this page

databricks.getFunctions

On this page

On this page

Example Usage

Related Resources

Using getFunctions

getFunctions Result

Supporting Types

GetFunctionsFunction

GetFunctionsFunctionInputParams

GetFunctionsFunctionInputParamsParameter

GetFunctionsFunctionReturnParams

GetFunctionsFunctionReturnParamsParameter

GetFunctionsFunctionRoutineDependencies

GetFunctionsFunctionRoutineDependenciesDependency

GetFunctionsFunctionRoutineDependenciesDependencyFunction

GetFunctionsFunctionRoutineDependenciesDependencyTable

Package Details

On this page

On this page