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.

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

fix: compatible to write to local file systems that do not support hard link #1868

Merged
merged 5 commits into from
Mar 15, 2024

Conversation

RobinLin666
Copy link
Contributor

@RobinLin666 RobinLin666 commented Nov 16, 2023

compatible to write to local file systems that do not support hard link.

Description

When we write to the local file system, sometimes hard link is not supported, such as blobfuse, goofys, s3fs, so deal with it with compatibility.

It is important to note that:
There is another problem with blobfuse, that is, when it comes to rename, it will report errors. Because rename did not release the file handle before.
See here for details: #1765

Arrow-rs is required to cooperate with the modification, for example: https://github.com/GlareDB/arrow-rs/pull/2/files
Because object_store has been upgraded to 0.8, there are a lot of breaking change, so I haven't changed this one for the time being. Will fix it after upgrading to 0.8 #1858

Related Issue(s)

#1765

#1376

Documentation

@github-actions github-actions bot added binding/rust Issues for the Rust crate crate/core labels Nov 16, 2023
Copy link
Collaborator

@roeap roeap left a comment

Choose a reason for hiding this comment

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

Thanks for looking into this @RobinLin666.

AFAIK, regular rename will relace the original file if it already exists. As such it is not safe to use for delta commits.

For S3 lock stores we have an setting ALLOW_UNSAFE_REANME to allow writing to S3 without a lock client. I would be fine adding this if we also require that setting to be set, such that users are aware they themselves have to make sure there are no concurrent writers to the table.

@github-actions github-actions bot added binding/python Issues for the Python package documentation Improvements or additions to documentation labels Nov 16, 2023
@RobinLin666
Copy link
Contributor Author

Thanks for your suggestion, @roeap.

I've added a new option, FILE_ALLOW_UNSAFE_RENAME, to control whether to enable the rename operation. Additionally, I wanted to confirm that the rename operation is atomic and doesn't alter the file's inode. Could you provide more details on the specific scenarios where safety concerns might arise?

Looking forward to your insights.

@roeap
Copy link
Collaborator

roeap commented Nov 18, 2023

Certainly ... std::fs::rename will replace the file at the target location if it already exists. The concurrency mechanics in delta heavily rely on that not happening :).

The basic idea to make commits atomic is to write a temporary file, renaming it to the desired commit file, and relying on the file system to error if the file already exists. So in case of just using regular rename, concurrent writers might overwrite each others commits.

@RobinLin666
Copy link
Contributor Author

Yes, if the target already exists, it will replace it. But in this scenario, we require that the target file does not exist, if it does, it will report an error directly, and the next rename operation will not be performed, so I think it is still atomic.

@roeap
Copy link
Collaborator

roeap commented Nov 19, 2023

Well, we went over this several times, also with the core team and general consensus was that an a-priori check without any lock mechanism would not prevent any race conditions.

This is especially true if the fs has significant latencies, like for remote stores.

I think you might be able to validate this by adopting the s3 concurrency tests.

@RobinLin666
Copy link
Contributor Author

RobinLin666 commented Nov 19, 2023

Yes! You are right!
So, what do you think I add an option FILE_ALLOW_UNSAFE_RENAME to support to write to mounted path which do not support hard link.

@RobinLin666
Copy link
Contributor Author

Hi @roeap, do you have any other concerns? I can modify them at any time. Please feel free to review, thanks!

@ion-elgreco
Copy link
Collaborator

@RobinLin666 what's the impact if multiple people write at the same time to a mounted storage?

@RobinLin666
Copy link
Contributor Author

RobinLin666 commented Dec 1, 2023

@RobinLin666 what's the impact if multiple people write at the same time to a mounted storage?

Hi @ion-elgreco
Here is the doc of blobfuse,
image

writing to different directories only from different instances" will work if you set --use-attr-cache=false and --file-cache-timeout-in-seconds=0. But cannot write to a same blob/file at same time.

Here is some detail: Azure/azure-storage-fuse#366 .

@Lyndon1994
Copy link

kindly ping

@RobinLin666
Copy link
Contributor Author

Hi team, just wanted to kindly bump this PR for review. Thank you!

@djouallah
Copy link

it will be really nice to have this functionality as it is very useful in Fabric notebook please :)

@RobinLin666
Copy link
Contributor Author

Since delta-rs has been refactored, I have also rearranged the code here. Please review it again. Thank you!

Note: To completely fix this problem, you need to upgrade arrow-rs object_store to version 0.9. I wrote delta table to mounted path in my local test and it passed.

@RobinLin666
Copy link
Contributor Author

Hi @MrPowers, could you please help to review the PR, since you refined the code last week. Thanks

@RobinLin666
Copy link
Contributor Author

RobinLin666 commented Jan 15, 2024

Hi @roeap / @wjones127 / @rtyler / @fvaleye / @ion-elgreco / @MrPowers Could you please help to review the PR?

it will be really nice to have this functionality as it is very useful in Fabric notebook and in Databricks Notebook (dbfs://) please :)

@RobinLin666
Copy link
Contributor Author

Hi guys, we are preparing a new Fabric Notebook which has a pure python environment, so we want to depend on this library to provide users with an enjoyable experience to operate Lakehouse Tables, whether through abfss path or local mounted path.
So, can you sign off this PR?

@jimdowling
Copy link

This would be a really useful PR for other file systems like HDFS.

@RobinLin666
Copy link
Contributor Author

RobinLin666 commented Jan 24, 2024

Excuse me, Hi @roeap / @wjones127 / @rtyler / @fvaleye / @ion-elgreco / @MrPowers Could you please help to review the PR? Thank you very much!
If there is anything that needs to be modified, I will make it promptly

@RobinLin666
Copy link
Contributor Author

Excuse me, Hi @roeap / @wjones127 / @rtyler / @fvaleye / @ion-elgreco / @MrPowers
Does this PR still have a chance to join?
If it has a chance, can you please help review, because I have resolved many conflicts, it can't go on like this, right?
If it doesn't have a chance, please tell me why, or is there any other plan? So I can do it in time. Because our new project is very dependent on this open-source project.
Thanks!

@RobinLin666
Copy link
Contributor Author

@RobinLin666 can you update the correct docs pages? The .rst file are the old docs

Nice to see your reply. I just updated it. Thank you!

@RobinLin666
Copy link
Contributor Author

Hi @ion-elgreco Have a good day!
Is there any problem/ question for now?

@roeap
Copy link
Collaborator

roeap commented Feb 22, 2024

HEy @RobinLin666 @ion-elgreco, sorry for being MIA for a while.

Since blob-fuse is a valid use case, I guess we have to do simething about it. generally I was hoping to get rind of all custom file system implementation in delta-rs, but it seems we will have to retain something after all.

One thing though - could we make the config handling analogus to how we handle configuration in object store and also our itnernal config - e.g. table/config.rs?

@RobinLin666
Copy link
Contributor Author

HEy @RobinLin666 @ion-elgreco, sorry for being MIA for a while.

Since blob-fuse is a valid use case, I guess we have to do simething about it. generally I was hoping to get rind of all custom file system implementation in delta-rs, but it seems we will have to retain something after all.

One thing though - could we make the config handling analogus to how we handle configuration in object store and also our itnernal config - e.g. table/config.rs?

Hi @roeap thank you for your suggestion, I wrote it with reference to the implementation of aws, supporting environment variables or passing parameters to pass the configuration.
I don't fully understand the effect you want, maybe I'm not very familiar with delta-rs code. I hope you can explain it in more detail. Thank you. If possible, I'd like to go in this time and reconstruct it later.

@RobinLin666
Copy link
Contributor Author

Hi @roeap ?

@RobinLin666
Copy link
Contributor Author

RobinLin666 commented Mar 6, 2024

Hello @roeap is there any concern ?

@RobinLin666
Copy link
Contributor Author

Hi @roeap , we greatly rely on this PR as many users strongly demand the ability to write data to the mount point, not only with blobfuse but also potentially with tools like s3fs, Databricks' dbfs, and others. If you believe that the code needs refactoring, could you provide more detailed guidance on how it should be refactored? Alternatively, it would be ideal if we could proceed with this PR first, and then I can prepare a refactoring PR. I prefer not to privately compile a delta-rs installation for our product, as it would be cumbersome to maintain and not practical. Thank you.

@ion-elgreco
Copy link
Collaborator

@RobinLin666 I think what Robert means it to make this akin to crates/azure/src/config.rs, in parsing and setting configuration. Does that help?

@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Mar 11, 2024
@RobinLin666
Copy link
Contributor Author

RobinLin666 commented Mar 11, 2024

Hi @roeap / @ion-elgreco , I have refined the code, please help to review, thanks!

@ion-elgreco
Copy link
Collaborator

ion-elgreco commented Mar 12, 2024

@RobinLin666 Looks good! Can you fix the CI failures?

@RobinLin666
Copy link
Contributor Author

Hi @roeap / @ion-elgreco can you help to review again?
Thank you very much!

@ion-elgreco
Copy link
Collaborator

ion-elgreco commented Mar 14, 2024

@RobinLin666 I don't see a test anymore in Python, could you add one? Once that's there we are good to go.

@RobinLin666
Copy link
Contributor Author

@RobinLin666 I don't see a test anymore in Python, could you add one? Once that's there we are good to go.

Thanks @ion-elgreco, done.

ion-elgreco
ion-elgreco previously approved these changes Mar 15, 2024
Copy link
Collaborator

@ion-elgreco ion-elgreco left a comment

Choose a reason for hiding this comment

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

@RobinLin666 thanks!

@RobinLin666
Copy link
Contributor Author

Hi @ion-elgreco thank you very much for your approval!!!
I just fixed a test case for dbfs, because it cannot create dir in /dbfs.
image

@ion-elgreco ion-elgreco enabled auto-merge (squash) March 15, 2024 08:20
@ion-elgreco ion-elgreco merged commit 9812bec into delta-io:main Mar 15, 2024
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
binding/python Issues for the Python package binding/rust Issues for the Rust crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants