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

Jump to bottom

Add a warning about duplicate files in SEMANTICS.md #755

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add a warning about duplicate files in SEMANTICS.md #755

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
3 changes: 3 additions & 0 deletions doc/SEMANTICS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ Not all S3 object keys correspond to valid file names, and these objects will no

then mounting your bucket with Mountpoint will show only the `blue` directory, containing the file `image.jpg`. The `blue` object will not be accessible. See the [detailed semantics](#mapping-s3-object-keys-to-files-and-directories) below for more information about invalid object keys.

> [!IMPORTANT]
> Please note, that there is a known [issue](https://github.com/awslabs/mountpoint-s3/issues/725) with `readdir` operation (used to list files in a directory), which results in duplicate files in the response. Duplicate files may occur for any type of a bucket if it contains keys which should be hidden according to the semantics described above. E.g. for bucket with keys `blue` and `blue/image.jpg` two files with the name `blue` may be shown, and none of those may be a directory file.
Copy link
Contributor

@sauraank sauraank Feb 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and none of those may be a directory file.

Actually, for express bucket, only directory was accessible.

Comment on lines +48 to +49
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and none of those may be a directory file.

Are we sure this is the case? I understand where we may see a directory and a file returned, but not two entries both for directories.


### Modifying directories

Mountpoint allows creating new directories with commands like `mkdir`. Creating a new directory is a local operation and no changes are made to your S3 bucket. A new directory will only be visible to other clients once a file has been written and uploaded inside it. If you restart Mountpoint or your instance before writing any files into the new directory, it will not be preserved.
Expand Down
Loading