Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add functions to sdk #2205

Merged
merged 21 commits into from
Dec 21, 2023
Merged

feat: add functions to sdk #2205

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
5a72736
add functions to sdk
sfc-gh-swinkler Nov 22, 2023
fc6b2e0
update
sfc-gh-swinkler Nov 27, 2023
17ef49f
update functions
sfc-gh-swinkler Dec 5, 2023
c7fbc46
Merge branch 'main' into functions-sdk
sfc-gh-swinkler Dec 5, 2023
7d9ca23
update error func
sfc-gh-swinkler Dec 7, 2023
a121f43
Merge branch 'functions-sdk' of https://github.com/Snowflake-Labs/ter…
sfc-gh-swinkler Dec 7, 2023
6f9c4a5
Merge branch 'main' into functions-sdk
sfc-gh-swinkler Dec 7, 2023
641b0b8
add todo
sfc-gh-swinkler Dec 8, 2023
3ad3e24
Merge branch 'functions-sdk' of https://github.com/Snowflake-Labs/ter…
sfc-gh-swinkler Dec 8, 2023
f1757e4
add todo
sfc-gh-swinkler Dec 8, 2023
364ce2e
Merge branch 'main' into functions-sdk
sfc-gh-swinkler Dec 8, 2023
7cb75f8
Merge branch 'main' into functions-sdk
sfc-gh-swinkler Dec 9, 2023
571486b
update
sfc-gh-swinkler Dec 18, 2023
d532974
Merge branch 'functions-sdk' of https://github.com/Snowflake-Labs/ter…
sfc-gh-swinkler Dec 18, 2023
11d8d82
Merge branch 'main' into functions-sdk
sfc-gh-swinkler Dec 18, 2023
2e6c0e9
fmt
sfc-gh-swinkler Dec 18, 2023
a5436b0
add validations
sfc-gh-swinkler Dec 20, 2023
3af6f87
Merge branch 'main' into functions-sdk
sfc-gh-swinkler Dec 20, 2023
c7462cb
add unit tests for desc
sfc-gh-swinkler Dec 21, 2023
a7fd45b
Merge branch 'functions-sdk' of https://github.com/Snowflake-Labs/ter…
sfc-gh-swinkler Dec 21, 2023
53acfd5
Merge branch 'main' into functions-sdk
sfc-gh-swinkler Dec 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pkg/sdk/client.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ type Client struct {
ExternalTables ExternalTables
FailoverGroups FailoverGroups
FileFormats FileFormats
Functions Functions
Grants Grants
MaskingPolicies MaskingPolicies
NetworkPolicies NetworkPolicies
Expand Down Expand Up @@ -165,6 +166,7 @@ func (c *Client) initialize() {
c.ExternalTables = &externalTables{client: c}
c.FailoverGroups = &failoverGroups{client: c}
c.FileFormats = &fileFormats{client: c}
c.Functions = &functions{client: c}
c.Grants = &grants{client: c}
c.MaskingPolicies = &maskingPolicies{client: c}
c.NetworkPolicies = &networkPolicies{client: c}
Expand Down
39 changes: 39 additions & 0 deletions pkg/sdk/common_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,3 +207,42 @@ func (row *propertyRow) toBoolProperty() *BoolProperty {
Description: row.Description,
}
}

type NullInputBehavior string

func NullInputBehaviorPointer(v NullInputBehavior) *NullInputBehavior {
return &v
}

const (
NullInputBehaviorCalledOnNullInput NullInputBehavior = "CALLED ON NULL INPUT"
NullInputBehaviorReturnNullInput NullInputBehavior = "RETURN NULL ON NULL INPUT"
NullInputBehaviorStrict NullInputBehavior = "STRICT"
)

type ReturnResultsBehavior string

var (
ReturnResultsBehaviorVolatile ReturnResultsBehavior = "VOLATILE"
ReturnResultsBehaviorImmutable ReturnResultsBehavior = "IMMUTABLE"
)

func ReturnResultsBehaviorPointer(v ReturnResultsBehavior) *ReturnResultsBehavior {
return &v
}

type ReturnNullValues string

var (
ReturnNullValuesNull ReturnNullValues = "NULL"
ReturnNullValuesNotNull ReturnNullValues = "NOT NULL"
)

func ReturnNullValuesPointer(v ReturnNullValues) *ReturnNullValues {
return &v
}

type Secret struct {
VariableName string `ddl:"keyword,single_quotes"`
Name string `ddl:"parameter,no_quotes"`
}
310 changes: 310 additions & 0 deletions pkg/sdk/functions_def.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,310 @@
package sdk

import g "github.com/Snowflake-Labs/terraform-provider-snowflake/pkg/sdk/poc/generator"

//go:generate go run ./poc/main.go

var functionArgument = g.NewQueryStruct("FunctionArgument").
Text("ArgName", g.KeywordOptions().NoQuotes().Required()).
PredefinedQueryStructField("ArgDataType", "DataType", g.KeywordOptions().NoQuotes().Required()).
PredefinedQueryStructField("DefaultValue", "*string", g.ParameterOptions().NoEquals().SQL("DEFAULT"))

var functionColumn = g.NewQueryStruct("FunctionColumn").
Text("ColumnName", g.KeywordOptions().NoQuotes().Required()).
PredefinedQueryStructField("ColumnDataType", "DataType", g.KeywordOptions().NoQuotes().Required())

var functionReturns = g.NewQueryStruct("FunctionReturns").
OptionalQueryStructField(
"ResultDataType",
g.NewQueryStruct("FunctionReturnsResultDataType").
PredefinedQueryStructField("ResultDataType", "DataType", g.KeywordOptions().NoQuotes().Required()),
g.KeywordOptions(),
).
OptionalQueryStructField(
"Table",
sfc-gh-jcieslak marked this conversation as resolved.
Show resolved Hide resolved
g.NewQueryStruct("FunctionReturnsTable").
ListQueryStructField(
"Columns",
functionColumn,
g.ParameterOptions().Parentheses().NoEquals(),
),
g.KeywordOptions().SQL("TABLE"),
).WithValidation(g.ExactlyOneValueSet, "ResultDataType", "Table")

var (
functionImports = g.NewQueryStruct("FunctionImports").Text("Import", g.KeywordOptions().SingleQuotes())
functionPackages = g.NewQueryStruct("FunctionPackages").Text("Package", g.KeywordOptions().SingleQuotes())
)

var FunctionsDef = g.NewInterface(
"Functions",
"Function",
g.KindOfT[SchemaObjectIdentifier](),
).CustomOperation(
"CreateForJava",
"https://docs.snowflake.com/en/sql-reference/sql/create-function#java-handler",
g.NewQueryStruct("CreateForJava").
Create().
OrReplace().
OptionalSQL("TEMPORARY").
OptionalSQL("SECURE").
SQL("FUNCTION").
IfNotExists().
Name().
ListQueryStructField(
"Arguments",
functionArgument,
g.ParameterOptions().Parentheses().NoEquals()).
OptionalSQL("COPY GRANTS").
QueryStructField(
"Returns",
functionReturns,
g.KeywordOptions().SQL("RETURNS").Required(),
).
PredefinedQueryStructField("ReturnNullValues", "*ReturnNullValues", g.KeywordOptions()).
SQL("LANGUAGE JAVA").
PredefinedQueryStructField("NullInputBehavior", "*NullInputBehavior", g.KeywordOptions()).
PredefinedQueryStructField("ReturnResultsBehavior", "*ReturnResultsBehavior", g.KeywordOptions()).
OptionalTextAssignment("RUNTIME_VERSION", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("COMMENT", g.ParameterOptions().SingleQuotes()).
ListQueryStructField(
"Imports",
functionImports,
g.ParameterOptions().Parentheses().SQL("IMPORTS"),
).
ListQueryStructField(
"Packages",
functionPackages,
g.ParameterOptions().Parentheses().SQL("PACKAGES"),
).
TextAssignment("HANDLER", g.ParameterOptions().SingleQuotes().Required()).
ListAssignment("EXTERNAL_ACCESS_INTEGRATIONS", "AccountObjectIdentifier", g.ParameterOptions().Parentheses()).
ListAssignment("SECRETS", "Secret", g.ParameterOptions().Parentheses()).
OptionalTextAssignment("TARGET_PATH", g.ParameterOptions().SingleQuotes()).
PredefinedQueryStructField("FunctionDefinition", "*string", g.ParameterOptions().NoEquals().SingleQuotes().SQL("AS")).
WithValidation(g.ValidIdentifier, "name").
WithValidation(g.ConflictingFields, "OrReplace", "IfNotExists"),
).CustomOperation(
"CreateForJavascript",
"https://docs.snowflake.com/en/sql-reference/sql/create-function#javascript-handler",
g.NewQueryStruct("CreateForJavascript").
Create().
OrReplace().
OptionalSQL("TEMPORARY").
OptionalSQL("SECURE").
SQL("FUNCTION").
Name().
ListQueryStructField(
"Arguments",
functionArgument,
g.ParameterOptions().Parentheses().NoEquals()).
OptionalSQL("COPY GRANTS").
QueryStructField(
"Returns",
functionReturns,
g.KeywordOptions().SQL("RETURNS").Required(),
).
PredefinedQueryStructField("ReturnNullValues", "*ReturnNullValues", g.KeywordOptions()).
SQL("LANGUAGE JAVASCRIPT").
PredefinedQueryStructField("NullInputBehavior", "*NullInputBehavior", g.KeywordOptions()).
PredefinedQueryStructField("ReturnResultsBehavior", "*ReturnResultsBehavior", g.KeywordOptions()).
OptionalTextAssignment("COMMENT", g.ParameterOptions().SingleQuotes()).
PredefinedQueryStructField("FunctionDefinition", "*string", g.ParameterOptions().NoEquals().SingleQuotes().SQL("AS").Required()).
WithValidation(g.ValidIdentifier, "name"),
).CustomOperation(
"CreateForPython",
"https://docs.snowflake.com/en/sql-reference/sql/create-function#python-handler",
g.NewQueryStruct("CreateForPython").
Create().
OrReplace().
OptionalSQL("TEMPORARY").
OptionalSQL("SECURE").
SQL("FUNCTION").
IfNotExists().
Name().
ListQueryStructField(
"Arguments",
functionArgument,
g.ParameterOptions().Parentheses().NoEquals()).
OptionalSQL("COPY GRANTS").
QueryStructField(
"Returns",
functionReturns,
g.KeywordOptions().SQL("RETURNS").Required(),
).
PredefinedQueryStructField("ReturnNullValues", "*ReturnNullValues", g.KeywordOptions()).
SQL("LANGUAGE PYTHON").
PredefinedQueryStructField("NullInputBehavior", "*NullInputBehavior", g.KeywordOptions()).
PredefinedQueryStructField("ReturnResultsBehavior", "*ReturnResultsBehavior", g.KeywordOptions()).
TextAssignment("RUNTIME_VERSION", g.ParameterOptions().SingleQuotes().Required()).
OptionalTextAssignment("COMMENT", g.ParameterOptions().SingleQuotes()).
ListQueryStructField(
"Imports",
functionImports,
g.ParameterOptions().Parentheses().SQL("IMPORTS"),
).
ListQueryStructField(
"Packages",
functionPackages,
g.ParameterOptions().Parentheses().SQL("PACKAGES"),
).
TextAssignment("HANDLER", g.ParameterOptions().SingleQuotes().Required()).
ListAssignment("EXTERNAL_ACCESS_INTEGRATIONS", "AccountObjectIdentifier", g.ParameterOptions().Parentheses()).
ListAssignment("SECRETS", "Secret", g.ParameterOptions().Parentheses()).
PredefinedQueryStructField("FunctionDefinition", "*string", g.ParameterOptions().NoEquals().SingleQuotes().SQL("AS")).
WithValidation(g.ValidIdentifier, "name").
WithValidation(g.ConflictingFields, "OrReplace", "IfNotExists"),
).CustomOperation(
"CreateForScala",
"https://docs.snowflake.com/en/sql-reference/sql/create-function#scala-handler",
g.NewQueryStruct("CreateForScala").
Create().
OrReplace().
OptionalSQL("TEMPORARY").
OptionalSQL("SECURE").
SQL("FUNCTION").
IfNotExists().
Name().
ListQueryStructField(
"Arguments",
functionArgument,
g.ParameterOptions().Parentheses().NoEquals()).
OptionalSQL("COPY GRANTS").
PredefinedQueryStructField("ResultDataType", "DataType", g.ParameterOptions().NoEquals().SQL("RETURNS").Required()).
PredefinedQueryStructField("ReturnNullValues", "*ReturnNullValues", g.KeywordOptions()).
SQL("LANGUAGE SCALA").
PredefinedQueryStructField("NullInputBehavior", "*NullInputBehavior", g.KeywordOptions()).
PredefinedQueryStructField("ReturnResultsBehavior", "*ReturnResultsBehavior", g.KeywordOptions()).
OptionalTextAssignment("RUNTIME_VERSION", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("COMMENT", g.ParameterOptions().SingleQuotes()).
ListQueryStructField(
"Imports",
functionImports,
g.ParameterOptions().Parentheses().SQL("IMPORTS"),
).
ListQueryStructField(
"Packages",
functionPackages,
g.ParameterOptions().Parentheses().SQL("PACKAGES"),
).
TextAssignment("HANDLER", g.ParameterOptions().SingleQuotes().Required()).
OptionalTextAssignment("TARGET_PATH", g.ParameterOptions().SingleQuotes()).
PredefinedQueryStructField("FunctionDefinition", "*string", g.ParameterOptions().NoEquals().SingleQuotes().SQL("AS")).
WithValidation(g.ValidIdentifier, "name").
WithValidation(g.ConflictingFields, "OrReplace", "IfNotExists"),
).CustomOperation(
"CreateForSQL",
"https://docs.snowflake.com/en/sql-reference/sql/create-function#sql-handler",
g.NewQueryStruct("CreateForSQL").
Create().
OrReplace().
OptionalSQL("TEMPORARY").
OptionalSQL("SECURE").
SQL("FUNCTION").
Name().
ListQueryStructField(
"Arguments",
functionArgument,
g.ParameterOptions().Parentheses().NoEquals()).
OptionalSQL("COPY GRANTS").
QueryStructField(
"Returns",
functionReturns,
g.KeywordOptions().SQL("RETURNS").Required(),
).
PredefinedQueryStructField("ReturnNullValues", "*ReturnNullValues", g.KeywordOptions()).
PredefinedQueryStructField("ReturnResultsBehavior", "*ReturnResultsBehavior", g.KeywordOptions()).
OptionalSQL("MEMOIZABLE").
OptionalTextAssignment("COMMENT", g.ParameterOptions().SingleQuotes()).
PredefinedQueryStructField("FunctionDefinition", "*string", g.ParameterOptions().NoEquals().SingleQuotes().SQL("AS").Required()).
WithValidation(g.ValidIdentifier, "name"),
).AlterOperation(
"https://docs.snowflake.com/en/sql-reference/sql/alter-function",
g.NewQueryStruct("AlterFunction").
Alter().
SQL("FUNCTION").
IfExists().
Name().
PredefinedQueryStructField("ArgumentDataTypes", "[]DataType", g.KeywordOptions().Parentheses().Required()).
Identifier("RenameTo", g.KindOfTPointer[SchemaObjectIdentifier](), g.IdentifierOptions().SQL("RENAME TO")).
OptionalTextAssignment("SET COMMENT", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("SET LOG_LEVEL", g.ParameterOptions().SingleQuotes()).
OptionalTextAssignment("SET TRACE_LEVEL", g.ParameterOptions().SingleQuotes()).
OptionalSQL("SET SECURE").
OptionalSQL("UNSET SECURE").
OptionalSQL("UNSET LOG_LEVEL").
OptionalSQL("UNSET TRACE_LEVEL").
OptionalSQL("UNSET COMMENT").
OptionalSetTags().
OptionalUnsetTags().
WithValidation(g.ValidIdentifier, "name").
WithValidation(g.ValidIdentifierIfSet, "RenameTo").
WithValidation(g.ExactlyOneValueSet, "RenameTo", "SetComment", "SetLogLevel", "SetTraceLevel", "SetSecure", "UnsetLogLevel", "UnsetTraceLevel", "UnsetSecure", "UnsetComment", "SetTags", "UnsetTags"),
).DropOperation(
"https://docs.snowflake.com/en/sql-reference/sql/drop-function",
g.NewQueryStruct("DropFunction").
Drop().
SQL("FUNCTION").
IfExists().
Name().
PredefinedQueryStructField("ArgumentDataTypes", "[]DataType", g.KeywordOptions().Parentheses().Required()).
WithValidation(g.ValidIdentifier, "name"),
).ShowOperation(
"https://docs.snowflake.com/en/sql-reference/sql/show-user-functions",
g.DbStruct("functionRow").
sfc-gh-jcieslak marked this conversation as resolved.
Show resolved Hide resolved
Field("created_on", "string").
Field("name", "string").
Field("schema_name", "string").
Field("is_builtin", "string").
Field("is_aggregate", "string").
Field("is_ansi", "string").
Field("min_num_arguments", "int").
Field("max_num_arguments", "int").
Field("arguments", "string").
Field("description", "string").
Field("catalog_name", "string").
Field("is_table_function", "string").
Field("valid_for_clustering", "string").
Field("is_secure", "sql.NullString").
Field("is_external_function", "string").
Field("language", "string").
Field("is_memoizable", "sql.NullString"),
g.PlainStruct("Function").
Field("CreatedOn", "string").
Field("Name", "string").
Field("SchemaName", "string").
Field("IsBuiltin", "bool").
Field("IsAggregate", "bool").
Field("IsAnsi", "bool").
Field("MinNumArguments", "int").
Field("MaxNumArguments", "int").
Field("Arguments", "string").
Field("Description", "string").
Field("CatalogName", "string").
Field("IsTableFunction", "bool").
Field("ValidForClustering", "bool").
Field("IsSecure", "bool").
Field("IsExternalFunction", "bool").
Field("Language", "string").
Field("IsMemoizable", "bool"),
g.NewQueryStruct("ShowFunctions").
Show().
SQL("USER FUNCTIONS").
OptionalLike().
OptionalIn(),
).ShowByIdOperation().DescribeOperation(
g.DescriptionMappingKindSlice,
"https://docs.snowflake.com/en/sql-reference/sql/desc-function",
g.DbStruct("functionDetailRow").
Field("property", "string").
Field("value", "string"),
g.PlainStruct("FunctionDetail").
Field("Property", "string").
Field("Value", "string"),
g.NewQueryStruct("DescribeFunction").
Describe().
SQL("FUNCTION").
Name().
PredefinedQueryStructField("ArgumentDataTypes", "[]DataType", g.KeywordOptions().Parentheses().Required()).
WithValidation(g.ValidIdentifier, "name"),
)
Loading
Loading