[databricks-lakebase] DABs now support Lakebase synced tables via postgres_synced_table — skill still says DAB support "not yet available"

Open Beginner friendly
#255 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
terraform
Domain
documentation

Research direction

Read databricks-lakebase/SKILL.md and databricks-lakebase/references/synced-tables.md, then compare their guidance with the linked DAB resources documentation. Update both files to distinguish deprecated synced_database_tables from the postgres_synced_table resource, correct the singular name, and document the CLI version and alternatives; an optional YAML example is suggested.

Written by the indexing model from the issue text.

Description

Summary

The databricks-lakebase skill tells users that Databricks Asset Bundles (DABs) cannot create Lakebase synced tables and to use the databricks postgres create-synced-table CLI instead. This guidance is now stale: DABs support a dedicated postgres_synced_table bundle resource, documented at dev-tools/bundles/resources.

Where the stale guidance lives

databricks-lakebase/SKILL.md

  • Troubleshooting table (last row):

    | DABs synced_database_tables | Deprecated — maps to a legacy API and fails on current Lakebase. Use databricks postgres create-synced-table CLI instead. DAB support via postgres_synced_tables is not yet available. |

  • Provisioned→Autoscaling callout near the top:

    For the legacy DAB synced_database_tables resource, use the databricks postgres create-synced-table CLI flow instead (see the Common Issues row and references/synced-tables.md).

databricks-lakebase/references/synced-tables.md

DABs: The bundle schema includes synced_database_tables, but it maps to a deprecated Terraform resource (databricks_database_synced_database_table) that fails on current Lakebase. Do not use synced_database_tables in DABs. DAB support via postgres_synced_tables is blocked on Terraform provider work and not yet available — use the CLI commands above instead.

What's actually true now

The DABs resources docs document a first-class resource for this:

  • Resource key: postgres_synced_table (singular) — "Postgres synced table object"
  • Supported fields include database_instance_name, logical_database_name, source_table_full_name, and spec
  • Added in Databricks CLI v1.0.0; type_overrides added in v1.5.0 and extra_columns in v1.10.0 — so it has been present and actively extended across several releases

Two naming points worth fixing while here:

  1. The skill refers to postgres_synced_tables (plural). The actual resource key is postgres_synced_table (singular).
  2. This is a different resource from the genuinely-deprecated synced_database_tables / synced_database_table. The skill is right that the old key is deprecated, but wrong that there is no bundle-native replacement — postgres_synced_table is that replacement.

Suggested fix

  • Update the troubleshooting row and references/synced-tables.md to state that DABs support Lakebase synced tables via the postgres_synced_table resource (CLI ≥ v1.0.0), rather than "not yet available."
  • Keep the note that the legacy synced_database_tables key is deprecated, but point users to postgres_synced_table as the bundle-native path, alongside the databricks postgres create-synced-table CLI as the imperative alternative.
  • Correct the plural postgres_synced_tables → singular postgres_synced_table.
  • Consider a short example YAML in references/synced-tables.md.

References

Dominant language
Python
Stars
323
Forks
82
Avg merge
50m
Merged PRs (30d)
8

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from databricks/databricks-agent-skills

All issues in databricks/databricks-agent-skills

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.