docs: fix three stale README claims - #55
Merged
Merged
Conversation
- Requirements named hotdata >=0.7,<0.9; pyproject pins >=0.9.0,<0.10
- "Table names must be declared when the database is created" is no
longer true: the loads endpoint creates an undeclared table
automatically ("declaring tables up front is optional" per the API
spec), and create_table calls it with no client-side check
- The existing-sources example passed "my_postgres" where a connection
id belongs: list_catalogs() returns connection ids (c["id"]), and
list_databases/list_tables filter by that id, so a display name
matches nothing
eddietejeda
requested review from
rohan-hotdata
and removed request for
a team
September 10, 2026 02:56
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
| ``` | ||
|
|
||
| Table names must be declared when the database is created — you cannot upload to a table name that was not listed in `tables=`. | ||
| Declaring table names in `tables=` is optional — loading into a table that was not declared creates it automatically as part of the load. |
There was a problem hiding this comment.
super nit: the section intro still states the old requirement. Line 88 says "Declare a database and its tables", and the code comment on line 93 says "Declare the database and all table names up front". A reader meets a requirement at the top of the section and an optional rule at the bottom. Consider rewording line 93 to "Declare the database; table names are optional." (not blocking)
…ared Same staleness the README fix corrects: the loads endpoint creates an undeclared table automatically, so 'declared managed table' overstates the precondition.
This was referenced Sep 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Found while auditing the hotdata.dev docs against their source repos (hotdata-dev/www#423).
hotdata ≥0.7,<0.9; pyproject pins>=0.9.0,<0.10create_tabledoes no client-side check. Second commit applies the same fix to thecreate_tabledocstring"my_postgres"where a connection id belongs:list_catalogs()returns connection ids and the discovery calls filter by id, so a display name matches nothingEverything else in the README verified against source.