search

public-transport / gtfs-via-postgres

Process GTFS Static/Schedule by importing it into a PostgreSQL database.
https://github.com/derhuerst/gtfs-via-postgres#gtfs-via-postgres
Other
93 stars 18 forks source link

readme: note that wildcards might not work in every shell #49

Closed mnai01 closed 7 months ago

mnai01 commented 1 year ago

Update readme to specify nodejs requirements. I ran into an error when using v16.15.0 but it wasnt clear why 

nvm\v16.15.0\node_modules\gtfs-via-postgres\cli.js:10
} = parseArgs({
    ^

TypeError: parseArgs is not a function
mnai01 commented 1 year ago

might also be good to note postgres version requirements and how the usage of wildcards (like *.txt) in file paths might vary depending on your operating system and terminal. For example, your CLI examples wont work on my PC machine

mnai01 commented 1 year ago

Also might be good to specify that adding view tags to cli command might increase query import time by hours. I could add these items to docs if agreed

derhuerst commented 1 year ago

Update readme to specify nodejs requirements. I ran into an error when using v16.15.0 but it wasnt clear why

In package.json's engines.node field, it is declared that gtfs-via-postgres@4 requires at least Node.js v16.17 (this is where util.parseArgs() has been added). npm should warn you when installing it with an incompatible Node version, not sure about other package managers.

Also, the readme has a badge indicating the minimal Node version to humans.

derhuerst commented 1 year ago

might also be good to note postgres version requirements

This is also already the case. The readme notes that PostgreSQL >=14 is required.

derhuerst commented 1 year ago

Also might be good to specify that adding view tags to cli command might increase query import time by hours.

Do you mean materialized views? The CLI help mentions (somewhat implicitly though, true) that their generation is slow.

If generating non-materialized (a.k.a. "regular") views, generating them shouldn't take more than a few seconds. Please report this as a bug in a new Issue! Edit: I just saw that you did this in https://github.com/public-transport/gtfs-via-postgres/issues/50, thanks.

derhuerst commented 1 year ago

might also be good to note […] how the usage of wildcards (like *.txt) in file paths might vary depending on your operating system and terminal. For example, your CLI examples wont work on my PC machine

Which examples specifically? Can you post a link?

Do the examples given in the CLI help?

derhuerst commented 7 months ago

I'm closing this for now. If you want to contribute some docs improvements, we can re-open this PR or you can submit a new one.