Skip to content

Commit 8d6bc1c

Browse files
Sharpen properties-merge note in replace docs
1 parent 4bfd97a commit 8d6bc1c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

mkdocs/docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ catalog.replace_table(identifier="docs_example.bids", schema=new_schema)
203203

204204
Field IDs are reused by name from the previous schema; new columns get fresh IDs above `last-column-id`.
205205

206-
Properties passed to `replace_table` are **merged** with the existing table properties (your values override; existing keys you don't pass are preserved). To remove a property as part of the replace, use `replace_table_transaction` and remove it explicitly within the transaction.
206+
Unlike the other fields, table properties are *merged* on replace: properties you don't pass are preserved on the table. To remove a property as part of the replace, use `replace_table_transaction` and drop it explicitly within the transaction.
207207

208208
Use `replace_table_transaction` to stage additional changes (writes, property updates, schema evolution) before committing — for example, swap the schema and write new data atomically:
209209

0 commit comments

Comments
 (0)