Skip to content

Commit f30deee

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

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎docs/api-ref.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2473,9 +2473,9 @@ Name | Description
24732473
`connection_type` | The connection type of the database, for example `sqlserver` or `hyper`. Read-only.
24742474
`connector_url` | The connector URL of the database. Read-only.
24752475
`contact_id` | The ID of the user who is the contact for the database. Settable; sent to the server by `databases.update`.
2476-
`content_permissions` | The permission mode of the database, as returned by the server. Must be one of `DatabaseItem.ContentPermissions.LockedToProject` (value `"LockedToDatabase"`) or `DatabaseItem.ContentPermissions.ManagedByOwner` (value `"ManagedByOwner"`). Can be set on the object, but `databases.update` does not send it to the server.
2476+
`content_permissions` | The permission mode of the database, as returned by the server. Must be one of `DatabaseItem.ContentPermissions.LockedToProject` (value `"LockedToDatabase"`) or `DatabaseItem.ContentPermissions.ManagedByOwner` (value `"ManagedByOwner"`). Can be set on the object, and `databases.update` sends it to the server.
24772477
`default_table_permissions` | The default permissions for tables in the database, as a list of `PermissionsRule` objects. You must first call `databases.populate_table_default_permissions` to access this data.
2478-
`description` | The description of the database. Settable; sent to the server by `databases.update` when it is not empty.
2478+
`description` | The description of the database. Settable; sent to the server by `databases.update`. An empty string clears the description.
24792479
`dqws` | The list of data quality warnings (`DQWItem`) for the database. You must first call `databases.populate_dqw` to access this data.
24802480
`embedded` | `True` if the database is embedded in Tableau content. Read-only.
24812481
`file_extension` | The file extension, for file-based databases. Read-only.
@@ -3173,7 +3173,7 @@ server.databases.delete_tags(database, 'quarterly')
31733173
databases.update_tags(item)
31743174
```
31753175

3176-
Not supported for databases. `DatabaseItem` does not track a tag set, so this method always raises `NotImplementedError`. Use `databases.add_tags` and `databases.delete_tags` instead.
3176+
Not supported for databases. `DatabaseItem` does not track a tag set. On REST API 3.8 and earlier, this method raises `EndpointUnavailableError`. On later versions, it raises `NotImplementedError`. Use `databases.add_tags` and `databases.delete_tags` instead.
31773177

31783178
**Version**
31793179

@@ -8577,7 +8577,7 @@ Name | Description
85778577
`certified` | `True` if the table is certified. Settable (must be a boolean); sent to the server by `tables.update`.
85788578
`columns` | The columns in the table, as an iterable of `ColumnItem` objects that fetches every page of columns from the server. You must first call `tables.populate_columns` to access this data.
85798579
`contact_id` | The ID of the user who is the contact for the table. Settable; sent to the server by `tables.update`.
8580-
`description` | The description of the table. Settable; sent to the server by `tables.update` when it is not empty.
8580+
`description` | The description of the table. Settable; sent to the server by `tables.update`. An empty string clears the description.
85818581
`dqws` | The list of data quality warnings (`DQWItem`) for the table. You must first call `tables.populate_dqw` to access this data.
85828582
`id` | The identifier (LUID) of the table. Read-only.
85838583
`name` | The name of the table. Must not be empty. `tables.update` does not send the name to the server.

0 commit comments

Comments
 (0)