-
Notifications
You must be signed in to change notification settings - Fork 2.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[extension/storage/filestorage] Document how to read files created by the file_storage
extension
#32180
[extension/storage/filestorage] Document how to read files created by the file_storage
extension
#32180
Conversation
I'm not sure about this. Are you trying to achieve a particular functionality or achieve a use case such as troubleshooting? |
OK, I have read the associated issue. Would you mind framing this as a troubleshooting solution? |
|
||
## Troubleshooting | ||
|
||
When troubleshooting components that use file storage, it is sometimes helpful to read the raw contents of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we add a note that this strategy is subject to change.
The context here is that the underlying storage mechanism, aside from being a file, is not part of an API which we have ever guaranteed. Some suggestions have been made in the past to evaluate other key/value stores which may be more performant than the bbolt one we currently use. If we ever change, we would of course have to ensure migration is possible for some time, but ultimately we should be careful not to appear locked into the implementation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added in 4a32823b11.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good from a documentation perspective.
4a32823
to
ef71235
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One small change to eliminate redundancy. Otherwise, LGTM.
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
Description:
This PR adds documentation explaining how to read the contents of files created by the
file_storage
extension.Link to tracking Issue: