Skip to content

Commit 15bc6bd

Browse files
authored
feat: make DefaultLogicalExtensionCodec support serialisation of buil… (#20638)
## Which issue does this PR close? <!-- We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123. --> - Closes #16944. ## Rationale for this change Currently, the `LogicalExtensionCodec` implementation for `DefaultLogicalExtensionCodec` leaves `try_decode_file_format` / `try_encode_file_format` unimplemented (returning "not implemented" errors). However, the actual serialization logic for built-in file formats — arrow, parquet, csv, and json— already exists in their respective codec implementations. All we need to do is tag which format is being used, and delegate to the corresponding format-specific codec to handle the data. <!-- Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed. Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes. --> ## What changes are included in this PR? Added a `FileFormatKind` enum and a `FileFormatProto` message to `datafusion.proto` to identify the file format type during transmission. Implemented `try_decode_file_format` and `try_encode_file_format` for `DefaultLogicalExtensionCodec`, which dispatch serialization/deserialization to the corresponding format-specific codec based on the format kind. Note that Avro is not covered because the upstream repository has not yet implemented the corresponding Avro codec, so Avro support is not functional at this time. ## Are these changes tested? Yes. Roundtrip tests are included for csv, json, parquet, and arrow. <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 2. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. -->
1 parent 37b9a46 commit 15bc6bd

5 files changed

Lines changed: 552 additions & 4 deletions

File tree

datafusion/proto/proto/datafusion.proto

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,25 @@ message CopyToNode {
270270
repeated string partition_by = 7;
271271
}
272272

273+
// Identifies a built-in file format supported by DataFusion.
274+
// Used by DefaultLogicalExtensionCodec to serialize/deserialize
275+
// FileFormatFactory instances (e.g. in CopyTo plans).
276+
enum FileFormatKind {
277+
FILE_FORMAT_KIND_UNSPECIFIED = 0;
278+
FILE_FORMAT_KIND_CSV = 1;
279+
FILE_FORMAT_KIND_JSON = 2;
280+
FILE_FORMAT_KIND_PARQUET = 3;
281+
FILE_FORMAT_KIND_ARROW = 4;
282+
FILE_FORMAT_KIND_AVRO = 5;
283+
}
284+
285+
// Wraps a serialized FileFormatFactory with its format kind tag,
286+
// so the decoder can dispatch to the correct format-specific codec.
287+
message FileFormatProto {
288+
FileFormatKind kind = 1;
289+
bytes encoded_file_format = 2;
290+
}
291+
273292
message DmlNode{
274293
enum Type {
275294
UPDATE = 0;

datafusion/proto/src/generated/pbjson.rs

Lines changed: 198 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

datafusion/proto/src/generated/prost.rs

Lines changed: 50 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)