Add docs for local file system support #25001
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| # Local file system support | ||
|
|
||
| Trino includes support to access a local file system with a catalog using the | ||
| Delta Lake, Hive, Hudi, or Iceberg connectors. The local file system must be a | ||
| local mount point for a shared file system available on all cluster nodes. | ||
|
|
||
| Support for local file system is not enabled by default, but can be activated by | ||
| setting the `fs.local.enabled` property to `true` in your catalog configuration | ||
| file. | ||
|
|
||
| ## General configuration | ||
|
|
||
| Use the following properties to configure general aspects of local file system | ||
| support: | ||
|
|
||
| :::{list-table} | ||
| :widths: 40, 60 | ||
| :header-rows: 1 | ||
|
|
||
| * - Property | ||
| - Description | ||
| * - `fs.native-local.enabled` | ||
| - Activate the support for local file system access. Defaults to `false`. Set | ||
| to `true` to use local file system and enable all other properties. | ||
| * - `local.location` | ||
|
Member
Author
There was a problem hiding this comment. if I dont read things in the code wrong .. the prefix is local or file .. and the property is location.. but there is no config class so I am entirely unsure |
||
| - Local path on all nodes to the root of the shared file system using the prefix | ||
| `local://` with the path to the mount point. | ||
|
|
||
| ::: | ||
|
|
||
| The following example displays the related section from a | ||
| `etc/catalog/example.properties` catalog configuration using the Hive connector. | ||
| The coordinator and all workers nodes have an external storage mounted at | ||
| `/storage/datalake`, resulting in the location `local:///storage/datalake`. | ||
|
|
||
| ```properties | ||
| connector.name=hive | ||
| ... | ||
| fs.native-local.enabled=true | ||
| local.location=local:///storage/datalake | ||
| ``` | ||
|
|
||
| Creating a schema named `default` results in the path | ||
| `/storage/datalake/default`. Tables within that schema result in separated | ||
| directories such as `/storage/datalake/default/table1`. | ||
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.
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.
Probably would be good to detail what sort of file systems can be used here .. and how does that work with concurrent access from multiple workers .. will all that just work fine?