[Feature] Added no_wait option for warehouses to skip waiting to start on creation (#5014)

## Changes
- Resolves #5006

## Tests
<!--
How is this tested? Please see the checklist below and also describe any
other relevant tests
-->

- [x] `make test` run locally
- [x] relevant change in `docs/` folder
- [x] covered with integration tests in `internal/acceptance`
- [x] using Go SDK
- [x] has entry in `NEXT_CHANGELOG.md` file

---------

Co-authored-by: Alex Ott <[email protected]>

Author: nkvuong

NEXT_CHANGELOG.md

@@ -6,6 +6,8 @@
 
 ### New Features and Improvements
 
+* Added `no_wait` option for `databricks_sql_endpoint` to skip waiting to start on warehouse creation
+
 ### Bug Fixes
 
 ### Documentation

docs/resources/sql_endpoint.md

@@ -47,6 +47,7 @@ The following arguments are supported:
   * `name` - Name of the Databricks SQL release channel. Possible values are: `CHANNEL_NAME_PREVIEW` and `CHANNEL_NAME_CURRENT`. Default is `CHANNEL_NAME_CURRENT`.
 
 * `warehouse_type` - SQL warehouse type. See for [AWS](https://docs.databricks.com/sql/admin/sql-endpoints.html#switch-the-sql-warehouse-type-pro-classic-or-serverless) or [Azure](https://learn.microsoft.com/en-us/azure/databricks/sql/admin/create-sql-warehouse#--upgrade-a-pro-or-classic-sql-warehouse-to-a-serverless-sql-warehouse). Set to `PRO` or `CLASSIC`. If the field `enable_serverless_compute` has the value `true` either explicitly or through the default logic (see that field above for details), the default is `PRO`, which is required for serverless SQL warehouses. Otherwise, the default is `CLASSIC`.
+* `no_wait` - (Optional) Whether to skip waiting for the SQL warehouse to start after creation. Default is `false`. When set to `true`, Terraform will create the warehouse but won't wait for it to be in a running state before completing.
 
 ## Attribute reference
 

sql/resource_sql_endpoint.go

@@ -83,6 +83,21 @@ func ResourceSqlEndpoint() common.Resource {
 		common.CustomizeSchemaPath(m, "warehouse_type").
 			SetSuppressDiff().
 			SetValidateDiagFunc(validation.ToDiagFunc(validation.StringInSlice([]string{"PRO", "CLASSIC"}, false)))
+
+		// Add no_wait field to schema
+		m["no_wait"] = &schema.Schema{
+			Type:        schema.TypeBool,
+			Optional:    true,
+			Default:     false,
+			Description: "If true, skip waiting for the warehouse to start after creation.",
+			DiffSuppressFunc: func(k, old, new string, d *schema.ResourceData) bool {
+				if old == "" && new == "false" {
+					return true
+				}
+				return old == new
+			},
+		}
+
 		return m
 	})
 	return common.Resource{
@@ -101,7 +116,17 @@ func ResourceSqlEndpoint() common.Resource {
 			if err != nil {
 				return fmt.Errorf("failed creating warehouse: %w", err)
 			}
-			resp, err := wait.Get()
+
+			d.SetId(wait.Id)
+
+			// Check if no_wait flag is set to true
+			noWait, ok := d.GetOk("no_wait")
+			if ok && noWait.(bool) {
+				return nil
+			}
+
+			// Wait for warehouse to start if no_wait is false or not set
+			_, err = wait.Get()
 			if err != nil {
 				// Rollback by deleting the warehouse
 				rollbackErr := w.Warehouses.DeleteById(ctx, wait.Id)
@@ -110,7 +135,6 @@ func ResourceSqlEndpoint() common.Resource {
 				}
 				return fmt.Errorf("failed waiting for warehouse to start: %w", err)
 			}
-			d.SetId(resp.Id)
 			return nil
 		},
 		Read: func(ctx context.Context, d *schema.ResourceData, c *common.DatabricksClient) error {

sql/resource_sql_endpoint_test.go

@@ -57,6 +57,7 @@ func TestResourceSQLEndpointCreate(t *testing.T) {
 		MockWorkspaceClientFunc: func(w *mocks.MockWorkspaceClient) {
 			api := w.GetMockWarehousesAPI()
 			api.EXPECT().Create(mock.Anything, createRequest).Return(&sql.WaitGetWarehouseRunning[sql.CreateWarehouseResponse]{
+				Id:   "abc", // Set the ID in the waiter
 				Poll: poll.Simple(getResponse),
 			}, nil)
 			api.EXPECT().GetById(mock.Anything, "abc").Return(&getResponse, nil)
@@ -125,6 +126,7 @@ func TestResourceSQLEndpointCreate_ForceSendFields(t *testing.T) {
 						SpotInstancePolicy:      "COST_OPTIMIZED",
 						ForceSendFields:         c.expectedForceSendFields,
 					}).Return(&sql.WaitGetWarehouseRunning[sql.CreateWarehouseResponse]{
+						Id:   "abc",
 						Poll: poll.Simple(response),
 					}, nil)
 					api.EXPECT().GetById(mock.Anything, "abc").Return(&response, nil)
@@ -158,6 +160,7 @@ func TestResourceSQLEndpointCreateNoAutoTermination(t *testing.T) {
 				SpotInstancePolicy: "COST_OPTIMIZED",
 				ForceSendFields:    []string{"AutoStopMins"},
 			}).Return(&sql.WaitGetWarehouseRunning[sql.CreateWarehouseResponse]{
+				Id:   "abc",
 				Poll: poll.Simple(getResponse),
 			}, nil)
 			e.GetById(mock.Anything, "abc").Return(&getResponse, nil)
@@ -288,7 +291,10 @@ func TestResourceSQLEndpointUpdate(t *testing.T) {
 				MaxNumClusters:     1,
 				EnablePhoton:       true,
 				SpotInstancePolicy: "COST_OPTIMIZED",
-			}).Return(&sql.WaitGetWarehouseRunning[struct{}]{Poll: poll.Simple(getResponse)}, nil)
+			}).Return(&sql.WaitGetWarehouseRunning[struct{}]{
+				Id:   "abc",
+				Poll: poll.Simple(getResponse),
+			}, nil)
 			api.EXPECT().GetById(mock.Anything, "abc").Return(&getResponse, nil)
 			addDataSourceListHttpFixture(mwc)
 		},
@@ -409,3 +415,43 @@ func TestResolveDataSourceIDNotFound(t *testing.T) {
 		require.Error(t, err)
 	})
 }
+
+func TestResourceSQLEndpointCreateNoWait(t *testing.T) {
+	// Create a specific response for the no_wait test that shows a starting state
+	getResponseStarting := sql.GetWarehouseResponse{
+		Name:           "foo",
+		ClusterSize:    "Small",
+		Id:             "abc",
+		State:          "STARTING", // Important: Warehouse is still starting
+		Tags:           &sql.EndpointTags{},
+		MaxNumClusters: 1,
+		NumClusters:    0, // No clusters running yet
+	}
+
+	qa.ResourceFixture{
+		MockWorkspaceClientFunc: func(w *mocks.MockWorkspaceClient) {
+			api := w.GetMockWarehousesAPI()
+			// The Create should return immediately without waiting due to no_wait=true
+			api.EXPECT().Create(mock.Anything, createRequest).Return(&sql.WaitGetWarehouseRunning[sql.CreateWarehouseResponse]{
+				Id:   "abc",                            // Set the ID directly in the waiter
+				Poll: poll.Simple(getResponseStarting), // Use starting state response
+			}, nil)
+
+			// Read operation will still be called after create to refresh state
+			api.EXPECT().GetById(mock.Anything, "abc").Return(&getResponseStarting, nil)
+			addDataSourceListHttpFixture(w)
+		},
+		Resource: ResourceSqlEndpoint(),
+		Create:   true,
+		HCL: `
+		name = "foo"
+		cluster_size = "Small"
+		no_wait = true
+		`,
+	}.ApplyAndExpectData(t, map[string]interface{}{
+		"id":             "abc",
+		"no_wait":        true,
+		"state":          "STARTING",
+		"data_source_id": "d7c9d05c-7496-4c69-b089-48823edad40c",
+	})
+}