Importers return the WriteSummary of the file they write

Open
  • Is something wrong?
#728 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
72/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
java
Domain
data

Research direction

Read VortexWriter.finish() and the listed importer methods in ParquetImporter, CsvImporter, and JdbcImporter to trace how each writes its output. Start with the Parquet importer and the vortex-jni cross-check described in the issue, then add coverage for the other importers. Done means each importer returns its WriteSummary, and the Parquet summary matches the file's size, row count, and per-column statistics.

Written by the indexing model from the issue text.

Description

enhancement good first issue

Follow-up to #664. VortexWriter.finish() returns a WriteSummary (file size, row count, per-column compressed size and statistics), but every importer drops it and returns void:

  • ParquetImporter.importParquet(Path|URI, Path[, ImportOptions])
  • CsvImporter.importCsv(Path|URI, Path[, ImportOptions])
  • JdbcImporter.importTable(...) / importQuery(...)

So a caller that wants the size or statistics of what it just imported has to open the file again. The CLI's vortex import and scripts/RaincloudCompare.java both reopen files for exactly this.

Proposal: each importer returns the WriteSummary from finish(). Going from void to a return value is source-compatible for callers. A URI import that reads the source remotely still writes a local file, so it returns the summary the same way.

What it enables:

  • RaincloudCompare can report per-column Java vs Rust sizes without reopening files (vortex-jni's writer already returns VortexWriteSummary). That per-column breakdown is what traced #722, #723 and #724.
  • vortex import can print each column's compressed size.

Test: a vortex-jni cross-check that a Parquet import's returned summary matches what vortex-jni reads back from the file (fileSize, row count, per-column statistics), plus unit tests per importer.

Dominant language
Java
Stars
3
Forks
2
Avg merge
9h 19m
Merged PRs (30d)
154

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dfa1/vortex-java

All issues in dfa1/vortex-java

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.