[ISSUE] Issue with databricks_share update detection

[marekbrysa]

Configuration

Adding a new object to a databricks_share resource e.g.

databricks_share my_share {
  name = "my_share"
  object {
    data_object_type = "TABLE"
    name = "main.foo.table_A"
  }
  object {
    data_object_type = "TABLE"
    name = "main.foo.table_C"
  }
}

->

databricks_share my_share {
  name = "my_share"
  object {
    data_object_type = "TABLE"
    name = "main.foo.table_A"
  }
  object {
    data_object_type = "TABLE"
    name = "main.foo.table_B"
  }
  object {
    data_object_type = "TABLE"
    name = "main.foo.table_C"
  }
}

Expected Behavior

Object for main.foo.table_B is added to the share

Actual Behavior

Apply fails with cannot update share: Shared Table 'foo.table_C' already exists

When explicitly providing shared_as both before and after adding new object, it works.

Most likely

terraform-provider-databricks/catalog/resource_share.go

Line 152 in 0693e4c

if !reflect.DeepEqual(beforeSdo, afterSdo) {

does not work as expected.

Steps to Reproduce

Terraform and provider versions

1.10.0

Debug Output

Important Factoids

[marekbrysa]

The workaround is to explicitly specify shared_as = "foo.table_X" for all objects in the share, i.e. explicitly set the default value for shared_as.

[junwei-db]

Re-opening because we observe the issue still persists after the fix in #2197.

Here's another example of the current behavior:

Deleting table A from databricks_share resource,

from:

databricks_share my_share {
  name = "my_share"
  object {
    name = "main.foo.table_A"
    shared_as = "foo.table_A"
  }
  object {
    name = "main.foo.table_B"
    shared_as = "foo.table_B"
  }
}

to:

databricks_share my_share {
  name = "my_share"
  object {
    name = "main.foo.table_B"
    shared_as = "foo.table_B"
  }
}

Expected terraform plan:

table_A is deleted.

Actual terraform plan:

Change table A to table B and delete table B.

databricks_share my_share {
  name = "my_share"
  ~ object {
    ~ name = "main.foo.table_A"  ->  "main.foo.table_B"
    ~ shared_as = "foo.table_A"   ->  "foo.table_B"
  ~ }
  - object {
    - name = "main.foo.table_B"
    - shared_as = "foo.table_B"
  - }
}

This plan will result in failure because changing shared_as is not supported.

The root cause is that terraform is not able to identify the same object, which leads to object mismatch and incorrect plan.

[junwei-db]

@nkvuong Could you take another look of this issue and see if it's possible to fix? We (system table team) are using delta sharing through terraform extensively, and this issue makes it hard to deploy any share changes. Thanks.

[junwei-db]

@nfx When is the expected release date for #2307?