Skip to content

Commit 5aba38f

Browse files
jacalataclaude
andcommitted
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>
1 parent f30deee commit 5aba38f

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

‎docs/api-ref.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2490,7 +2490,7 @@ Name | Description
24902490
`port` | The port of the database server, as an integer. Read-only.
24912491
`provider` | The provider of the database. Read-only.
24922492
`request_url` | The request URL of the database. Read-only.
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`.
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`.
24942494

24952495
**Example**
24962496

@@ -2685,7 +2685,7 @@ database = server.databases.update(database)
26852685
databases.populate_tables(database_item)
26862686
```
26872687

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.
2688+
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.
26892689

26902690
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.
26912691

@@ -2905,10 +2905,10 @@ server.databases.update_table_default_permissions(database, [rule])
29052905
#### databases.delete_table_default_permissions
29062906

29072907
```py
2908-
databases.delete_table_default_permissions(item, rule)
2908+
databases.delete_table_default_permissions(rule, item)
29092909
```
29102910

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`.
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. Note that this method takes the rule first and the database second, which is the reverse of the other permission methods.
29122912

29132913
REST API: [Delete Default Database Permissions](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#delete_database_perms_default){:target="_blank"}
29142914

@@ -2920,8 +2920,8 @@ This endpoint is available with REST API version 3.5 and up.
29202920

29212921
Name | Description
29222922
:--- | :---
2923-
`item` | The `DatabaseItem` to remove the default table permission from.
29242923
`rule` | A single `PermissionsRule` to remove.
2924+
`item` | The `DatabaseItem` to remove the default table permission from.
29252925

29262926
**Returns**
29272927

@@ -2932,7 +2932,7 @@ None.
29322932
```py
29332933
server.databases.populate_table_default_permissions(database)
29342934
rule = database.default_table_permissions[0]
2935-
server.databases.delete_table_default_permissions(database, rule)
2935+
server.databases.delete_table_default_permissions(rule, database)
29362936
```
29372937

29382938
<br>

0 commit comments

Comments
 (0)