postgres: embed spec on Catalog remote type

Apply the same hoist that #5273 does for Branch/Endpoint/Project. Define
PostgresCatalogRemote that embeds CatalogCatalogSpec and exposes the
identifier and output-only fields at the top level. DoRead returns the
new shape so state-side and remote-side paths line up, which is a
prerequisite for drift detection on spec fields once the backend
echoes spec on GET. Today the embedded fields are auto-classified
spec:input_only from the API field behaviors in resources.generated.yml,
so drift is correctly suppressed.

Prompted by #5265 (comment).
Should land after #5273.

Co-authored-by: Isaac

Author: pietern

acceptance/bundle/refschema/out.fields.txt

@@ -2733,20 +2733,16 @@ resources.postgres_branches.*.ttl	*duration.Duration	INPUT	STATE
 resources.postgres_branches.*.uid	string	REMOTE
 resources.postgres_branches.*.update_time	*time.Time	REMOTE
 resources.postgres_branches.*.url	string	INPUT
-resources.postgres_catalogs.*.branch	string	INPUT	STATE
-resources.postgres_catalogs.*.catalog_id	string	INPUT	STATE
-resources.postgres_catalogs.*.create_database_if_missing	bool	INPUT	STATE
+resources.postgres_catalogs.*.branch	string	ALL
+resources.postgres_catalogs.*.catalog_id	string	ALL
+resources.postgres_catalogs.*.create_database_if_missing	bool	ALL
 resources.postgres_catalogs.*.create_time	*time.Time	REMOTE
 resources.postgres_catalogs.*.id	string	INPUT
 resources.postgres_catalogs.*.lifecycle	resources.Lifecycle	INPUT
 resources.postgres_catalogs.*.lifecycle.prevent_destroy	bool	INPUT
 resources.postgres_catalogs.*.modified_status	string	INPUT
 resources.postgres_catalogs.*.name	string	REMOTE
-resources.postgres_catalogs.*.postgres_database	string	INPUT	STATE
-resources.postgres_catalogs.*.spec	*postgres.CatalogCatalogSpec	REMOTE
-resources.postgres_catalogs.*.spec.branch	string	REMOTE
-resources.postgres_catalogs.*.spec.create_database_if_missing	bool	REMOTE
-resources.postgres_catalogs.*.spec.postgres_database	string	REMOTE
+resources.postgres_catalogs.*.postgres_database	string	ALL
 resources.postgres_catalogs.*.status	*postgres.CatalogCatalogStatus	REMOTE
 resources.postgres_catalogs.*.status.branch	string	REMOTE
 resources.postgres_catalogs.*.status.catalog_id	string	REMOTE

bundle/direct/dresources/postgres_catalog.go

@@ -5,9 +5,36 @@ import (
 
 	"github.com/databricks/cli/bundle/config/resources"
 	"github.com/databricks/databricks-sdk-go"
+	sdktime "github.com/databricks/databricks-sdk-go/common/types/time"
+	"github.com/databricks/databricks-sdk-go/marshal"
 	"github.com/databricks/databricks-sdk-go/service/postgres"
 )
 
+// PostgresCatalogRemote is the return type for DoRead. It embeds CatalogCatalogSpec so
+// that all paths in StateType are valid paths in RemoteType, enabling drift detection
+// for spec fields once the backend echoes spec on GET.
+type PostgresCatalogRemote struct {
+	postgres.CatalogCatalogSpec
+
+	CatalogId string `json:"catalog_id,omitempty"`
+
+	Name       string                         `json:"name,omitempty"`
+	Status     *postgres.CatalogCatalogStatus `json:"status,omitempty"`
+	Uid        string                         `json:"uid,omitempty"`
+	CreateTime *sdktime.Time                  `json:"create_time,omitempty"`
+	UpdateTime *sdktime.Time                  `json:"update_time,omitempty"`
+}
+
+// Custom marshaler needed because embedded CatalogCatalogSpec has its own MarshalJSON
+// which would otherwise take over and ignore the additional fields.
+func (s *PostgresCatalogRemote) UnmarshalJSON(b []byte) error {
+	return marshal.Unmarshal(b, s)
+}
+
+func (s PostgresCatalogRemote) MarshalJSON() ([]byte, error) {
+	return marshal.Marshal(s)
+}
+
 type ResourcePostgresCatalog struct {
 	client *databricks.WorkspaceClient
 }
@@ -25,35 +52,50 @@ func (*ResourcePostgresCatalog) PrepareState(input *resources.PostgresCatalog) *
 	}
 }
 
-func (*ResourcePostgresCatalog) RemapState(remote *postgres.Catalog) *PostgresCatalogState {
-	// Status.CatalogId is the short identifier and matches the user-supplied
-	// config. Prefer it over parsing remote.Name — semantic contract from the
-	// API rather than string manipulation on the hierarchical path.
-	//
-	// GET does not return the spec today (only status). Return an empty spec
-	// and rely on the spec:input_only classifications generated from the
-	// OpenAPI schema to suppress phantom drift until the backend starts
-	// echoing spec values on GET.
+func (*ResourcePostgresCatalog) RemapState(remote *PostgresCatalogRemote) *PostgresCatalogState {
+	return &PostgresCatalogState{
+		CatalogId:          remote.CatalogId,
+		CatalogCatalogSpec: remote.CatalogCatalogSpec,
+	}
+}
+
+// makePostgresCatalogRemote converts the SDK Catalog into the embedded remote shape.
+// GET does not echo spec today (only status is returned); the embedded spec fields
+// stay at their zero values, and resources.yml suppresses phantom drift via
+// ignore_remote_changes with reason spec:input_only.
+//
+// Status.CatalogId is the short identifier and matches the user-supplied config.
+// Prefer it over parsing remote.Name — semantic contract from the API rather than
+// string manipulation on the hierarchical path.
+func makePostgresCatalogRemote(catalog *postgres.Catalog) *PostgresCatalogRemote {
+	var spec postgres.CatalogCatalogSpec
+	if catalog.Spec != nil {
+		spec = *catalog.Spec
+	}
 	var catalogId string
-	if remote.Status != nil {
-		catalogId = remote.Status.CatalogId
+	if catalog.Status != nil {
+		catalogId = catalog.Status.CatalogId
 	}
-	return &PostgresCatalogState{
-		CatalogId: catalogId,
-		CatalogCatalogSpec: postgres.CatalogCatalogSpec{
-			Branch:                  "",
-			CreateDatabaseIfMissing: false,
-			PostgresDatabase:        "",
-			ForceSendFields:         nil,
-		},
+	return &PostgresCatalogRemote{
+		CatalogCatalogSpec: spec,
+		CatalogId:          catalogId,
+		Name:               catalog.Name,
+		Status:             catalog.Status,
+		Uid:                catalog.Uid,
+		CreateTime:         catalog.CreateTime,
+		UpdateTime:         catalog.UpdateTime,
 	}
 }
 
-func (r *ResourcePostgresCatalog) DoRead(ctx context.Context, id string) (*postgres.Catalog, error) {
-	return r.client.Postgres.GetCatalog(ctx, postgres.GetCatalogRequest{Name: id})
+func (r *ResourcePostgresCatalog) DoRead(ctx context.Context, id string) (*PostgresCatalogRemote, error) {
+	catalog, err := r.client.Postgres.GetCatalog(ctx, postgres.GetCatalogRequest{Name: id})
+	if err != nil {
+		return nil, err
+	}
+	return makePostgresCatalogRemote(catalog), nil
 }
 
-func (r *ResourcePostgresCatalog) DoCreate(ctx context.Context, config *PostgresCatalogState) (string, *postgres.Catalog, error) {
+func (r *ResourcePostgresCatalog) DoCreate(ctx context.Context, config *PostgresCatalogState) (string, *PostgresCatalogRemote, error) {
 	waiter, err := r.client.Postgres.CreateCatalog(ctx, postgres.CreateCatalogRequest{
 		CatalogId: config.CatalogId,
 		Catalog: postgres.Catalog{
@@ -76,7 +118,8 @@ func (r *ResourcePostgresCatalog) DoCreate(ctx context.Context, config *Postgres
 	if err != nil {
 		return "", nil, err
 	}
-	return result.Name, result, nil
+	remote := makePostgresCatalogRemote(result)
+	return remote.Name, remote, nil
 }
 
 func (r *ResourcePostgresCatalog) DoDelete(ctx context.Context, id string) error {

bundle/direct/dresources/type_test.go

@@ -75,12 +75,6 @@ var knownMissingInRemoteType = map[string][]string{
 		"pg_version",
 		"project_id",
 	},
-	"postgres_catalogs": {
-		"branch",
-		"catalog_id",
-		"create_database_if_missing",
-		"postgres_database",
-	},
 	"vector_search_endpoints": {
 		"target_qps",
 		"usage_policy_id",