Repository navigation
README: list what the plugin runs, sends, and fetches - #6
Merged
Merged
Conversation
The directory asks whether a plugin sends data to other services and expects the answer in the README.
| `~/.hotdata/api-key` when the environment has none, and sends it nowhere else. | ||
| - **SessionStart hook.** It runs `hotdata auth status` once per machine, prints the | ||
| cached orientation, and refreshes that cache in the background: CLI calls read the | ||
| project's tables and a sample of rows, and the saved-query API reads its definitions. The cache lives in |
There was a problem hiding this comment.
nit: Add the project's recent query history and date ranges to this list. (not blocking)
The refresh does more than this sentence says. orient.recent_results calls hotdata.query_runs and writes up to six past SQL statements, with their result ids, into the local cache. hotdata.ranges also reads the min and max of date columns. A reader who checks what lands on disk will find SQL text that this section does not mention.
Suggested wording: "CLI calls read the project's tables, a sample of rows, date ranges, and recent query history, and the saved-query API reads its definitions."
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
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.
The directory asks whether a plugin sends data to other services and
expects the answer in the README.