You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 36498b8
Browse filesBrowse the repository at this point in the historyBrowse files
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>
Copy file name to clipboardExpand all lines: docs/api-ref.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2490,7 +2490,7 @@ Name | Description
2490
2490
`port` | The port of the database server, as an integer. Read-only.
2491
2491
`provider` | The provider of the database. Read-only.
2492
2492
`request_url` | The request URL of the database. Read-only.
2493
-
`tables` | The tables in the database. Reserved for `databases.populate_tables`, which is not currently enabled (see [databases.populate_tables](#databasespopulate_tables)). Accessing it raises `UnpopulatedPropertyError`.
2493
+
`tables` | The tables in the database. The tables are not available through `databases.populate_tables`, which is not supported (see [databases.populate_tables](#databasespopulate_tables)). Accessing this property raises `UnpopulatedPropertyError`.
Updates the description, certification, certification note, and contact of the specified database.
2644
2644
2645
-
The request always includes the `certified` value, so set `database_item.certified` to `True` or `False` before you call this method. The `description`and`certification_note`values are sent only when they are not empty, so this method cannot clear them. The `name`and `content_permissions` values are not sent.
2645
+
Only the values that are set on `database_item` are sent. A value of `None` leaves the matching property unchanged on the server, and an empty string for `description`or`certification_note`clears it. The `certified`, `description`, `certification_note`, `content_permissions`, and `contact_id` values can be updated. The `name`value is not sent.
This method is not currently enabled. It is gated on a placeholder minimum version (`99`), so calling it raises `EndpointUnavailableError` on every Tableau Server and Tableau Cloud version. The REST API reference does not document an endpoint that lists the tables in a database.
2688
+
This method is not supported. Calling it always raises `NotImplementedError`, because the REST API does not have an endpoint that lists the tables in a database.
2689
2689
2690
2690
To find the tables in a database, query the Metadata API with [metadata.query](#metadataquery) and read the matching tables with `tables.get_by_id`. The `explore_databases_tables.py` sample shows this approach.
Removes a default table permission rule from the specified database. Every capability in `rule.capabilities` is removed for `rule.grantee` with a separate request. Note that this method takes the rule first and the database second, which is the reverse of the other permission methods.
2911
+
Removes a default table permission rule from the specified database. Every capability in `rule.capabilities` is removed for `rule.grantee` with a separate request. Passing the arguments in the order `(rule, item)` still works but emits a `DeprecationWarning`.
Updates the description, certification, certification note, and contact of the specified table.
8758
8758
8759
-
The request always includes the `certified` value, so set `table_item.certified` to `True` or `False` before you call this method. The `description`and`certification_note`values are sent only when they are not empty, so this method cannot clear them. The `name` value is not sent.
8759
+
Only the values that are set on `table_item` are sent. A value of `None` leaves the matching property unchanged on the server, and an empty string for `description`or`certification_note`clears it. The `certified`, `description`, `certification_note`, and `contact_id` values can be updated. The `name` value is not sent.
0 commit comments