Fix destroy of SQL Global config with instance profile setup (#1080)

Also added a new parameter `sql_config_params`

this fixes #1076

Author: alexott

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## 0.4.8
 
 * Added support for `tf:suppress_diff` on primitive types ([#984](https://github.com/databrickslabs/terraform-provider-databricks/issues/984)).
+* Fixed issue arises when destroying `databricks_sql_global_config` with instance profile set ([#1076](https://github.com/databrickslabs/terraform-provider-databricks/issues/1076)).
+* Added setting of SQL configuration parameters in `databricks_sql_global_config` ([#1080](https://github.com/databrickslabs/terraform-provider-databricks/pull/1080)).
 
 Updated dependency versions:
 

docs/resources/sql_global_config.md

@@ -33,6 +33,9 @@ resource "databricks_sql_global_config" "this" {
     "spark.hadoop.fs.azure.account.oauth2.client.secret" : "{{secrets/${local.secret_scope}/${local.secret_key}}}",
     "spark.hadoop.fs.azure.account.oauth2.client.endpoint" : "https://login.microsoftonline.com/${var.tenant_id}/oauth2/token"
   }
+  sql_config_params = {
+    "ANSI_MODE": "true"
+  }
 }
 ```
 
@@ -44,6 +47,7 @@ The following arguments are supported (see [documentation](https://docs.databric
 * `security_policy` (Optional, String) - The policy for controlling access to datasets. Default value: `DATA_ACCESS_CONTROL`, consult documentation for list of possible values
 * `data_access_config` (Optional, Map) - data access configuration for [databricks_sql_endpoint](sql_endpoint.md), such as configuration for an external Hive metastore, Hadoop Filesystem configuration, etc.  Please note that the list of supported configuration properties is limited, so refer to the [documentation](https://docs.databricks.com/sql/admin/data-access-configuration.html#supported-properties) for a full list.  Apply will fail if you're specifying not permitted configuration.
 * `instance_profile_arn` (Optional, String) - [databricks_instance_profile](instance_profile.md) used to access storage from [databricks_sql_endpoint](sql_endpoint.md). Please note that this parameter is only for AWS, and will generate an error if used on other clouds. 
+* `sql_config_params` (Optional, Map) - SQL Configuration Parameters let you override the default behavior for all sessions with all endpoints.
 
 ## Import
 

sqlanalytics/resource_sql_global_config.go

@@ -9,25 +9,31 @@ import (
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 )
 
-type ConfPair struct {
+type confPair struct {
 	Key   string `json:"key"`
 	Value string `json:"value"`
 }
 
+type repeatedEndpointConfPairs struct {
+	ConfigPairs []confPair `json:"configuration_pairs,omitempty"`
+}
+
 // GlobalConfig used to generate Terraform resource schema and bind to resource data
 type GlobalConfig struct {
 	SecurityPolicy          string            `json:"security_policy,omitempty" tf:"default:DATA_ACCESS_CONTROL"`
 	DataAccessConfig        map[string]string `json:"data_access_config,omitempty"`
 	InstanceProfileARN      string            `json:"instance_profile_arn,omitempty"`
 	EnableServerlessCompute bool              `json:"enable_serverless_compute,omitempty" tf:"default:false"`
+	SqlConfigParams         map[string]string `json:"sql_config_params,omitempty"`
 }
 
 // GlobalConfigForRead used to talk to REST API
 type GlobalConfigForRead struct {
-	SecurityPolicy          string     `json:"security_policy"`
-	DataAccessConfig        []ConfPair `json:"data_access_config"`
-	InstanceProfileARN      string     `json:"instance_profile_arn,omitempty"`
-	EnableServerlessCompute bool       `json:"enable_serverless_compute,omitempty"`
+	SecurityPolicy             string                     `json:"security_policy"`
+	DataAccessConfig           []confPair                 `json:"data_access_config"`
+	InstanceProfileARN         string                     `json:"instance_profile_arn,omitempty"`
+	EnableServerlessCompute    bool                       `json:"enable_serverless_compute"`
+	SqlConfigurationParameters *repeatedEndpointConfPairs `json:"sql_configuration_parameters,omitempty"`
 }
 
 func NewSqlGlobalConfigAPI(ctx context.Context, m interface{}) globalConfigAPI {
@@ -50,16 +56,26 @@ func (a globalConfigAPI) Set(gc GlobalConfig) error {
 			return err
 		}
 	}
-	if a.client.IsAws() {
-		data["instance_profile_arn"] = gc.InstanceProfileARN
-	} else if gc.InstanceProfileARN != "" {
-		return fmt.Errorf("can't use instance_profile_arn outside of AWS")
+	if gc.InstanceProfileARN != "" {
+		if a.client.IsAws() {
+			data["instance_profile_arn"] = gc.InstanceProfileARN
+		} else {
+			return fmt.Errorf("can't use instance_profile_arn outside of AWS")
+		}
 	}
-	cfg := make([]ConfPair, 0, len(gc.DataAccessConfig))
+	cfg := make([]confPair, 0, len(gc.DataAccessConfig))
 	for k, v := range gc.DataAccessConfig {
-		cfg = append(cfg, ConfPair{Key: k, Value: v})
+		cfg = append(cfg, confPair{Key: k, Value: v})
 	}
 	data["data_access_config"] = cfg
+	if len(gc.SqlConfigParams) > 0 {
+		sql_params := repeatedEndpointConfPairs{}
+		sql_params.ConfigPairs = make([]confPair, 0, len(gc.SqlConfigParams))
+		for k, v := range gc.SqlConfigParams {
+			sql_params.ConfigPairs = append(sql_params.ConfigPairs, confPair{Key: k, Value: v})
+		}
+		data["sql_configuration_parameters"] = sql_params
+	}
 
 	return a.client.Put(a.context, "/sql/config/endpoints", data)
 }
@@ -84,7 +100,6 @@ func (a globalConfigAPI) Get() (GlobalConfig, error) {
 func ResourceSQLGlobalConfig() *schema.Resource {
 	s := common.StructToSchema(GlobalConfig{}, func(
 		m map[string]*schema.Schema) map[string]*schema.Schema {
-		m["instance_profile_arn"].Default = ""
 		return m
 	})
 	setGlobalConfig := func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {

sqlanalytics/resource_sql_global_config_test.go

@@ -18,7 +18,6 @@ func TestResourceSQLGlobalConfigCreateDefault(t *testing.T) {
 				ExpectedRequest: map[string]interface{}{
 					"data_access_config":        []interface{}{},
 					"enable_serverless_compute": false,
-					"instance_profile_arn":      "",
 					"security_policy":           "DATA_ACCESS_CONTROL",
 				},
 			},
@@ -50,7 +49,6 @@ func TestResourceSQLGlobalConfigDelete(t *testing.T) {
 				ExpectedRequest: map[string]interface{}{
 					"data_access_config":        []interface{}{},
 					"enable_serverless_compute": false,
-					"instance_profile_arn":      "",
 					"security_policy":           "DATA_ACCESS_CONTROL",
 				},
 			},
@@ -80,27 +78,29 @@ func TestResourceSQLGlobalConfigCreateWithData(t *testing.T) {
 			{
 				Method:   "PUT",
 				Resource: "/api/2.0/sql/config/endpoints",
-				ExpectedRequest: map[string]interface{}{
-					"data_access_config": []interface{}{
-						map[string]interface{}{
-							"key":   "spark.sql.session.timeZone",
-							"value": "UTC",
-						},
-					},
-					"enable_serverless_compute": false,
-					"instance_profile_arn":      "arn:...",
-					"security_policy":           "PASSTHROUGH"},
+				ExpectedRequest: GlobalConfigForRead{
+					DataAccessConfig:           []confPair{{Key: "spark.sql.session.timeZone", Value: "UTC"}},
+					SqlConfigurationParameters: &repeatedEndpointConfPairs{ConfigPairs: []confPair{{Key: "ANSI_MODE", Value: "true"}}},
+					EnableServerlessCompute:    false,
+					SecurityPolicy:             "PASSTHROUGH",
+					InstanceProfileARN:         "arn:...",
+				},
 			},
 			{
 				Method:       "GET",
 				Resource:     "/api/2.0/sql/config/endpoints",
 				ReuseRequest: true,
 				Response: GlobalConfigForRead{
 					SecurityPolicy: "PASSTHROUGH",
-					DataAccessConfig: []ConfPair{
+					DataAccessConfig: []confPair{
 						{Key: "spark.sql.session.timeZone", Value: "UTC"},
 					},
 					InstanceProfileARN: "arn:...",
+					SqlConfigurationParameters: &repeatedEndpointConfPairs{
+						ConfigPairs: []confPair{
+							{Key: "ANSI_MODE", Value: "true"},
+						},
+					},
 				},
 			},
 		},
@@ -112,6 +112,9 @@ func TestResourceSQLGlobalConfigCreateWithData(t *testing.T) {
 			"data_access_config": map[string]interface{}{
 				"spark.sql.session.timeZone": "UTC",
 			},
+			"sql_config_params": map[string]interface{}{
+				"ANSI_MODE": "true",
+			},
 		},
 	}.Apply(t)
 	require.NoError(t, err, err)