Skip to content

Commit 4bfd97a

Browse files
Drop misleading field-ID rationale from docs
1 parent c46eca0 commit 4bfd97a

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
@@ -201,7 +201,7 @@ new_schema = Schema(
201201
catalog.replace_table(identifier="docs_example.bids", schema=new_schema)
202202
```
203203

204-
Field IDs from columns whose names appear in the previous schema are reused, so existing data files remain readable when the new schema is a compatible superset. New columns get fresh IDs above `last-column-id`.
204+
Field IDs are reused by name from the previous schema; new columns get fresh IDs above `last-column-id`.
205205

206206
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.
207207

0 commit comments

Comments
 (0)