add SXSS writing #1075
add SXSS writing #1075
Conversation
| WorkBookType.XLSX -> XSSFWorkbook(file.inputStream()) | ||
| // Write to an existing file with `keepFile` flag | ||
| if (keepFile && file.exists() && file.length() > 0L) { | ||
| file.inputStream().use { fis -> |
There was a problem hiding this comment.
Please check if it's ok to use use here, it will close input stream right after workbook is created
There was a problem hiding this comment.
AFAIU Apache POI loads data from the InputStream into memory when the Workbook is created. I tested it with keepFile=true and it works as expected.
There was a problem hiding this comment.
btw looks like using fis increases memory:
Opening a XSSFWorkbook from a file has a lower memory footprint than opening from an InputStream
May be use file directly?
There was a problem hiding this comment.
It doesn't work 🤣 🤣 🤣 . Known APOI problem.
|
Worth to mention that keepFile = true will lead to increased memory usage due to XSSFWorkbook compared to false (default) |
|
Added KDocs for |
| * @param sheetName The name of the sheet in the Excel file. If null, the default name will be used. | ||
| * @param writeHeader A flag indicating whether to write the header row in the Excel file. Defaults to true. | ||
| * @param workBookType The [type of workbook][WorkBookType] to create (e.g., XLS or XLSX). Defaults to XLSX. | ||
| * @param keepFile If `true` and the file already exists, a new sheet will be appended instead of overwriting the file. |
There was a problem hiding this comment.
if sheetName already exists in the workbook, will it be overwritten? maybe comment needs to be adjusted
There was a problem hiding this comment.
Throws:
IllegalArgumentException – if the name is null or invalid or workbook already contains a sheet with this name
There was a problem hiding this comment.
What's the best thing to write in our doc?
Fixes #1016.
Tested with profiler on big datasets - works great :).
Looks like
SXSSFWorkbookrestrictions don't affect on DF writing into Excel (except for the case for writing into existing file - in this case it can't just be used andXSSFWorkbookis used).