Fix databases and tables update, permission and tag behavior by jacalata · Pull Request #1901 · tableau/server-client-python

jacalata · 2026-11-10T00:41:07Z

Summary

databases.populate_tables raises NotImplementedError with a pointer to the Metadata API, instead of gating on a placeholder version.
databases.delete_table_default_permissions takes (item, rule) like the other permission methods. The old (rule, item) order still works and emits a DeprecationWarning.
databases.update and tables.update send only the fields that are set, so None leaves a value unchanged and an empty string clears description or certification_note. contentPermissions is sent when set, so a get-then-update round trip sends back the value the server returned.
update_tags on databases and tables raises a clear NotImplementedError pointing to add_tags and delete_tags. These items do not track their tags yet. Both methods keep their @api(version="3.9") gate, so on earlier REST API versions they raise EndpointUnavailableError instead.

Verification

Full test suite: 1063 passed, 1 skipped.
black --check and mypy tableauserverclient/ pass.
New unit tests cover the request payloads for set and unset fields, the argument-order warning, and the update_tags error.

populate_tables was gated with @api(version="99"), so it raised a misleading EndpointUnavailableError on every server. It called GET /databases/{id}/tables, which is not part of the REST API at any version. Raise NotImplementedError pointing to the Metadata API and tables.get_by_id instead, and make the DatabaseItem.tables error message accurate. Refs #735 Co-Authored-By: Claude Code <noreply@anthropic.com>

…missions Every other permissions method takes the item first and the rule second, but delete_table_default_permissions took (rule, item). Switch to (item, rule). Callers using the old order keep working: swapped argument types are detected, swapped back, and a DeprecationWarning pointing at the caller is emitted. Refs #735 Co-Authored-By: Claude Code <noreply@anthropic.com>

The update requests always sent isCertified, so an item whose certified value was never set sent isCertified="none". description and certificationNote were only sent when non-empty, so they could not be cleared. Send isCertified when certified is not None, and send description and certificationNote whenever they are not None so an empty string clears them. The Update Database REST method accepts contentPermissions and the docstring claims it can set permissions, but the value was never sent. Send it when set. Refs #735 Co-Authored-By: Claude Code <noreply@anthropic.com>

Neither DatabaseItem nor TableItem tracks tags, and the Query Database and Query Table responses do not include a tags element for tables, so update_tags cannot work as it does for workbooks and datasources. Both methods now share one explicit NotImplementedError that points to add_tags and delete_tags, and tables.update_tags carries the same @api(version="3.9") gate as the other tag methods. Refs #735 Co-Authored-By: Claude Code <noreply@anthropic.com>

Copilot

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

github-actions · 2026-11-10T00:41:58Z

Coverage Report

File	Stmts	Miss	Cover	Missing
tableauserverclient
__init__.py	5	0	100%
config.py	15	0	100%
datetime_helpers.py	25	1	1	96%
exponential_backoff.py	20	0	100%
filesys_helpers.py	31	0	100%
namespace.py	25	3	3	88%
tableauserverclient/bin
__init__.py	2	0	100%
_version.py	358	212	212	41%
tableauserverclient/helpers
__init__.py	1	0	100%
logging.py	2	0	100%
strings.py	31	1	1	97%
tableauserverclient/models
__init__.py	47	0	100%
auth_federation_item.py	87	9	9	90%
collection_item.py	41	7	7	83%
column_item.py	55	32	32	42%
connection_credentials.py	35	11	11	69%
connection_item.py	113	13	13	88%
custom_view_item.py	144	21	21	85%
data_acceleration_report_item.py	54	1	1	98%
data_alert_item.py	158	4	4	97%
data_freshness_policy_item.py	155	15	15	90%
database_item.py	205	34	34	83%
datasource_item.py	300	12	12	96%
dqw_item.py	104	5	5	95%
exceptions.py	4	0	100%
extensions_item.py	132	4	4	97%
extract_item.py	44	4	4	91%
favorites_item.py	69	8	8	88%
fileupload_item.py	19	0	100%
flow_item.py	149	10	10	93%
flow_run_item.py	71	0	100%
group_item.py	89	6	6	93%
groupset_item.py	49	7	7	86%
interval_item.py	182	32	32	82%
job_item.py	192	10	10	95%
linked_tasks_item.py	79	1	1	99%
location_item.py	29	2	2	93%
metric_item.py	129	13	13	90%
oidc_item.py	63	3	3	95%
pagination_item.py	34	1	1	97%
permissions_item.py	111	12	12	89%
project_item.py	207	31	31	85%
property_decorators.py	100	18	18	82%
reference_item.py	26	2	2	92%
revision_item.py	59	1	1	98%
schedule_item.py	209	6	6	97%
server_info_item.py	37	7	7	81%
site_item.py	636	13	13	98%
subscription_item.py	101	2	2	98%
table_item.py	119	18	18	85%
tableau_auth.py	61	25	25	59%
tableau_types.py	27	1	1	96%
tag_item.py	15	0	100%
target.py	6	0	100%
task_item.py	56	2	2	96%
user_item.py	338	17	17	95%
view_item.py	220	16	16	93%
virtual_connection_item.py	64	8	8	88%
webhook_item.py	69	1	1	99%
workbook_item.py	362	16	16	96%
tableauserverclient/server
__init__.py	9	0	100%
exceptions.py	4	0	100%
filter.py	29	1	1	97%
pager.py	33	1	1	97%
query.py	143	15	15	90%
request_factory.py	1370	192	192	86%
request_options.py	386	5	5	99%
server.py	250	25	25	90%
sort.py	6	0	100%
tableauserverclient/server/endpoint
__init__.py	36	0	100%
auth_endpoint.py	73	10	10	86%
auth_federation_endpoint.py	80	0	100%
custom_views_endpoint.py	152	12	12	92%
data_acceleration_report_endpoint.py	21	0	100%
data_alert_endpoint.py	94	23	23	76%
databases_endpoint.py	103	18	18	83%
datasources_endpoint.py	323	33	33	90%
default_permissions_endpoint.py	44	3	3	93%
dqw_endpoint.py	45	16	16	64%
endpoint.py	260	25	25	90%
exceptions.py	79	6	6	92%
extensions_endpoint.py	31	0	100%
favorites_endpoint.py	94	22	22	77%
fileuploads_endpoint.py	51	0	100%
flow_runs_endpoint.py	62	9	9	85%
flow_task_endpoint.py	21	2	2	90%
flows_endpoint.py	198	47	47	76%
groups_endpoint.py	126	9	9	93%
groupsets_endpoint.py	72	7	7	90%
jobs_endpoint.py	68	9	9	87%
linked_tasks_endpoint.py	37	0	100%
metadata_endpoint.py	88	14	14	84%
metrics_endpoint.py	55	6	6	89%
oidc_endpoint.py	42	1	1	98%
permissions_endpoint.py	44	3	3	93%
projects_endpoint.py	178	24	24	87%
resource_tagger.py	128	35	35	73%
schedules_endpoint.py	119	11	11	91%
server_info_endpoint.py	36	10	10	72%
sites_endpoint.py	130	27	27	79%
subscriptions_endpoint.py	56	14	14	75%
tables_endpoint.py	111	36	36	68%
tasks_endpoint.py	63	6	6	90%
users_endpoint.py	170	7	7	96%
views_endpoint.py	150	9	9	94%
virtual_connections_endpoint.py	113	10	10	91%
webhooks_endpoint.py	54	9	9	83%
workbooks_endpoint.py	338	22	22	93%
TOTAL	12345	1412	89%

Co-Authored-By: Claude Code <noreply@anthropic.com>

Copilot

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.

Revert the two passages that describe unmerged #1901 behavior: - databases.populate_tables is documented as not currently enabled (version 99 gate, EndpointUnavailableError), not as unsupported. - databases.delete_table_default_permissions is documented as (rule, item), not (item, rule), and the tables property row matches the populate_tables wording. Co-Authored-By: Claude Code <noreply@anthropic.com>

databases.update and tables.update send a value only when it is not empty on development, so the update docs say that empty strings do not clear description or certification_note. Revert the "only the values that are set" wording, which depends on unmerged #1901. Co-Authored-By: Claude Code <noreply@anthropic.com>

- DatabaseItem.content_permissions: drop the value list and the claim that databases.update sends it (not true on development; the write and the LockedToDatabase value come with #1901). - Drop the explore_databases_tables.py references (sample is in #1907). - Handle empty results in the databases.populate_tables example. Co-Authored-By: Claude Code <noreply@anthropic.com>

* Document the Databases and Tables endpoints The databases and tables endpoints, and the DatabaseItem, TableItem and ColumnItem classes, had no API reference entries. Add sections for every method, note that databases.populate_tables is not enabled and show the Metadata API alternative, and list the new explore_databases_tables sample. Closes #735 Co-Authored-By: Claude Code <noreply@anthropic.com> * Fix datasources.delete_dqw REST API link The link pointed at the delete_dqw_triggers anchor, which is not the method this call makes. Point it at delete_dqws, Delete Data Quality Warning by Content, and correct the link text. Co-Authored-By: Claude Code <noreply@anthropic.com> * Update Databases and Tables docs to match the fixed behavior populate_tables raises NotImplementedError rather than gating on a placeholder version. delete_table_default_permissions takes (item, rule), and the old order warns. Update requests send only the values that are set, so None leaves a property unchanged and an empty string clears it. Refs #735 Co-Authored-By: Claude Code <noreply@anthropic.com> * Correct databases and tables field and tag docs content_permissions and description are sent by update, and an empty description clears it. update_tags raises EndpointUnavailableError below REST API 3.9. Co-Authored-By: Claude Code <noreply@anthropic.com> * Match databases docs to the code on development Revert the two passages that describe unmerged #1901 behavior: - databases.populate_tables is documented as not currently enabled (version 99 gate, EndpointUnavailableError), not as unsupported. - databases.delete_table_default_permissions is documented as (rule, item), not (item, rule), and the tables property row matches the populate_tables wording. Co-Authored-By: Claude Code <noreply@anthropic.com> * Match database and table update docs to the code on development databases.update and tables.update send a value only when it is not empty on development, so the update docs say that empty strings do not clear description or certification_note. Revert the "only the values that are set" wording, which depends on unmerged #1901. Co-Authored-By: Claude Code <noreply@anthropic.com> * Remove docs that depend on other PRs; guard the metadata example - DatabaseItem.content_permissions: drop the value list and the claim that databases.update sends it (not true on development; the write and the LockedToDatabase value come with #1901). - Drop the explore_databases_tables.py references (sample is in #1907). - Handle empty results in the databases.populate_tables example. Co-Authored-By: Claude Code <noreply@anthropic.com> --------- Co-authored-by: Claude Code <noreply@anthropic.com>

Do not merge before both PRs land: - #1901 (databases and tables fixes): populate_tables raises NotImplementedError, delete_table_default_permissions takes (item, rule), update sends only the values that are set, content_permissions is sent and accepts LockedToDatabase. - #1907 (databases and tables sample): the explore_databases_tables.py references. Also guard the databases.populate_tables example against empty results, matching #1902. Co-Authored-By: Claude Code <noreply@anthropic.com>

jacalata and others added 4 commits November 9, 2026 14:00

Copilot AI balanced review requested due to automatic review settings November 10, 2026 00:41

Copilot AI reviewed Nov 10, 2026

jacalata mentioned this pull request Nov 10, 2026

Document the Databases and Tables endpoints #1902

Merged

Remove unused DatabaseItem._set_tables and share the update_tags message

09c2890

Co-Authored-By: Claude Code <noreply@anthropic.com>

Copilot AI balanced review requested due to automatic review settings November 12, 2026 20:59

Copilot AI reviewed Nov 12, 2026

Navigation Menu

Repository navigation

Fix databases and tables update, permission and tag behavior - #1901

Fix databases and tables update, permission and tag behavior#1901
jacalata wants to merge 5 commits into
developmentfrom
jac/fix-databases-tables-bugs

jacalata commented Nov 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

github-actions Bot commented Nov 10, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

jacalata commented Nov 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Verification

Related

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Nov 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

jacalata commented Nov 10, 2026 •

edited

Loading

github-actions Bot commented Nov 10, 2026 •

edited

Loading