Skip to content

Commit fc1fff5

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

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
@@ -2475,7 +2475,7 @@ Name | Description
24752475
`contact_id` | The ID of the user who is the contact for the database. Settable; sent to the server by `databases.update`.
24762476
`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`. An empty string clears the description.
2478+
`description` | The description of the database. Settable; sent to the server by `databases.update` when it is not empty.
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.
@@ -2642,7 +2642,7 @@ databases.update(database_item)
26422642

26432643
Updates the description, certification, certification note, and contact of the specified database.
26442644

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.
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.
26462646

26472647
REST API: [Update Database](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#update_database){:target="_blank"}
26482648

@@ -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`. An empty string clears the description.
8580+
`description` | The description of the table. Settable; sent to the server by `tables.update` when it is not empty.
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.
@@ -8756,7 +8756,7 @@ tables.update(table_item)
87568756

87578757
Updates the description, certification, certification note, and contact of the specified table.
87588758

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.
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.
87608760

87618761
REST API: [Update Table](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_metadata.htm#update_table){:target="_blank"}
87628762

0 commit comments

Comments
 (0)