Deprecate schedule block in databricks_sql_query resource (#2078)

* [REDASH-4424] Add deprecation note to databricks_sql_query terraform resource docs

* add Deprecated: note

* Set Deprecated flag to true in the Query's StructToSchema block.

* Update test

Author: maksimyego-db

docs/resources/sql_query.md

@@ -29,12 +29,6 @@ resource "databricks_sql_query" "q1" {
   parent      = "folders/${databricks_directory.shared_dir.object_id}"
   run_as_role = "viewer"
 
-  schedule {
-    continuous {
-      interval_seconds = 5 * 60
-    }
-  }
-
   parameter {
     name  = "p1"
     title = "Title for p1"
@@ -106,6 +100,8 @@ $ terraform import databricks_sql_query.this <query-id>
 
 In case you see `Error: cannot create sql query: Internal Server Error` during `terraform apply`; double check that you are using the correct [`data_source_id`](sql_endpoint.md)
 
+Operations on `databricks_sql_query` schedules are ⛔️ deprecated. You can create, update or delete a schedule for SQLA and other Databricks resources using the [databricks_job](job.md#sql_task-configuration-block) resource.
+
 ## Related Resources
 
 The following resources are often used in the same context:
@@ -115,3 +111,4 @@ The following resources are often used in the same context:
 * [databricks_sql_endpoint](sql_endpoint.md) to manage Databricks SQL [Endpoints](https://docs.databricks.com/sql/admin/sql-endpoints.html).
 * [databricks_sql_global_config](sql_global_config.md) to configure the security policy, [databricks_instance_profile](instance_profile.md), and [data access properties](https://docs.databricks.com/sql/admin/data-access-configuration.html) for all [databricks_sql_endpoint](sql_endpoint.md) of workspace.
 * [databricks_sql_permissions](sql_permissions.md) to manage data object access control lists in Databricks workspaces for things like tables, views, databases, and [more](https://docs.databricks.com/security/access-control/table-acls/object-privileges.html).
+* [databricks_job](job.md#sql_task-configuration-block) to schedule Databricks SQL queries (as well as dashboards and alerts) using Databricks Jobs.

sql/api/query.go

@@ -12,6 +12,7 @@ type Query struct {
 	Name           string            `json:"name"`
 	Description    string            `json:"description"`
 	Query          string            `json:"query"`
+	// Deprecated: Use databricks_job resource to schedule a Query
 	Schedule       *QuerySchedule    `json:"schedule"`
 	Options        *QueryOptions     `json:"options,omitempty"`
 	Tags           []string          `json:"tags,omitempty"`
@@ -20,6 +21,7 @@ type Query struct {
 }
 
 // QuerySchedule ...
+// Deprecated: Use databricks_job resource to schedule a Query
 type QuerySchedule struct {
 	// Interval in seconds.
 	//

sql/resource_sql_query.go

@@ -20,6 +20,7 @@ type QueryEntity struct {
 	Name         string           `json:"name"`
 	Description  string           `json:"description,omitempty"`
 	Query        string           `json:"query"`
+	// Deprecated: Use databricks_job resource to schedule a Query
 	Schedule     *QuerySchedule   `json:"schedule,omitempty"`
 	Tags         []string         `json:"tags,omitempty"`
 	Parameter    []QueryParameter `json:"parameter,omitempty"`
@@ -28,26 +29,30 @@ type QueryEntity struct {
 }
 
 // QuerySchedule ...
+// Deprecated: Use databricks_job resource to schedule a Query
 type QuerySchedule struct {
 	Continuous *QueryScheduleContinuous `json:"continuous,omitempty"`
 	Daily      *QueryScheduleDaily      `json:"daily,omitempty"`
 	Weekly     *QueryScheduleWeekly     `json:"weekly,omitempty"`
 }
 
 // QueryScheduleContinuous ...
+// Deprecated: Use databricks_job resource to schedule a Query
 type QueryScheduleContinuous struct {
 	IntervalSeconds int    `json:"interval_seconds"`
 	UntilDate       string `json:"until_date,omitempty"`
 }
 
 // QueryScheduleDaily ...
+// Deprecated: Use databricks_job resource to schedule a Query
 type QueryScheduleDaily struct {
 	IntervalDays int    `json:"interval_days"`
 	TimeOfDay    string `json:"time_of_day"`
 	UntilDate    string `json:"until_date,omitempty"`
 }
 
 // QueryScheduleWeekly ...
+// Deprecated: Use databricks_job resource to schedule a Query
 type QueryScheduleWeekly struct {
 	IntervalWeeks int    `json:"interval_weeks"`
 	DayOfWeek     string `json:"day_of_week"`
@@ -508,6 +513,7 @@ func ResourceSqlQuery() *schema.Resource {
 	s := common.StructToSchema(
 		QueryEntity{},
 		func(m map[string]*schema.Schema) map[string]*schema.Schema {
+			m["schedule"].Deprecated = "Operations on `databricks_sql_query` schedules are deprecated. Please use `databricks_job` resource to schedule a `sql_task`."
 			schedule := m["schedule"].Elem.(*schema.Resource)
 
 			// Make different query schedule types mutually exclusive.

sql/resource_sql_query_test.go

@@ -90,7 +90,7 @@ func TestQueryCreateWithMultipleSchedules(t *testing.T) {
 				}
 			}
 		`,
-	}.ExpectError(t, "invalid config supplied. [schedule.#.continuous] Conflicting configuration arguments. [schedule.#.daily] Conflicting configuration arguments")
+	}.ExpectError(t, "invalid config supplied. [schedule.#.continuous] Conflicting configuration arguments. [schedule.#.daily] Conflicting configuration arguments. [schedule] Argument is deprecated")
 }
 
 func TestQueryCreateWithContinuousSchedule(t *testing.T) {