Skip to content
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.

Sign up for GitHub

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

document 'throw' config of disks in filesystem.md #1

Merged
merged 1 commit into from
Aug 14, 2023
Merged

document 'throw' config of disks in filesystem.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions filesystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [Driver Prerequisites](#driver-prerequisites)
- [Scoped & Read-Only Filesystems](#scoped-and-read-only-filesystems)
- [Amazon S3 Compatible Filesystems](#amazon-s3-compatible-filesystems)
- [Error handling](#error-handling)
- [Obtaining Disk Instances](#obtaining-disk-instances)
- [On-Demand Disks](#on-demand-disks)
- [Retrieving Files](#retrieving-files)
Expand Down Expand Up @@ -205,6 +206,11 @@ AWS_URL=http://localhost:9000/local
> **Warning**
> Generating temporary storage URLs via the `temporaryUrl` method is not supported when using MinIO.

<a name="error-handling"></a>
### Error handling

By default the various "disks" are configured to return a `false` value when an operation fails. However, it is possible to have the filesystem API throw the underlying exception by setting the corresponding disk's `throw` configuration to `true`. This can be particularly useful when troubleshooting filesystem-related problems.

<a name="obtaining-disk-instances"></a>
## Obtaining Disk Instances

Expand Down