Custom fileio docs #1238
Open
Custom fileio docs #1238
Conversation
This file contains 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
…n to Table behaviour options table
kevinjqliu
reviewed
Oct 19, 2024
There was a problem hiding this comment.
thanks for working on this! I added a few comments.
Generally I think we can keep the section light and just mention that the option exists.
i lean toward making it similar to https://py.iceberg.apache.org/configuration/#custom-catalog-implementations
wdyt?
Comment on lines
+58
to
+59
| | `schema.name-mapping.default` | Name mapping strategy | N/A | Default name mapping for schema evolution. | | ||
| | `format-version` | `{1, 2}` | 2 | The version of the Iceberg table format to use. | |
There was a problem hiding this comment.
these changes are from the other PR.
Can you rebase this PR with main so that only changes for this PR will show?
| @@ -151,6 +161,62 @@ For the FileIO there are several configuration options available: | |||
|
|
|||
| <!-- markdown-link-check-enable--> | |||
|
|
|||
| ### Custom FileIO Implementations | |||
|
|
|||
| <!-- markdown-link-check-disable --> | |||
There was a problem hiding this comment.
nit: this is not necessary unless there are links here that would not work
|
|
||
| <!-- markdown-link-check-disable --> | ||
|
|
||
| The `pyIceberg` library allows you to use custom FileIO implementations, enabling flexible file handling tailored to your specific needs. This feature is particularly useful when working with different storage backends or file formats. |
Comment on lines
+178
to
+210
| #### Implementation Details | ||
|
|
||
| The following functions are key to inferring and loading custom FileIO implementations: | ||
|
|
||
| ##### `_infer_file_io_from_scheme` | ||
|
|
||
| ```python | ||
| def _infer_file_io_from_scheme(path: str, properties: Properties) -> Optional[FileIO]: | ||
| ``` | ||
|
|
||
| - **Purpose**: Infers the appropriate FileIO implementation based on the scheme of the provided file path. | ||
| - **Parameters**: | ||
| - `path` (str): The file path from which to infer the scheme. | ||
| - `properties` (Properties): Configuration properties to assist with loading. | ||
| - **Returns**: An instance of `FileIO` if a suitable implementation is found; otherwise, `None`. | ||
|
|
||
| ##### Usage Example | ||
|
|
||
| ```python | ||
| file_io = _infer_file_io_from_scheme("s3://my-bucket/my-file.txt", properties) | ||
| ``` | ||
|
|
||
| ##### `load_file_io` | ||
|
|
||
| ```python | ||
| def load_file_io(properties: Properties = EMPTY_DICT, location: Optional[str] = None) -> FileIO: | ||
| ``` | ||
|
|
||
| - **Purpose**: Loads the custom FileIO implementation specified in the `properties`. | ||
| - **Parameters**: | ||
| - `properties` (Properties): A dictionary of configuration properties, which may include `PY_IO_IMPL`. | ||
| - `location` (Optional[str]): An optional location to specify the file path. | ||
| - **Returns**: An instance of `FileIO`. |
There was a problem hiding this comment.
these are not necessary as part of docs
|
|
||
| The `pyIceberg` library allows you to use custom FileIO implementations, enabling flexible file handling tailored to your specific needs. This feature is particularly useful when working with different storage backends or file formats. | ||
|
|
||
| #### Bringing Your Own FileIO with `PY_IO_IMPL` |
There was a problem hiding this comment.
nit: merge with above section
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR addresses #1233.
Do let me know if any changes are to be made.