alamb commented on code in PR #14723:
URL: https://github.com/apache/datafusion/pull/14723#discussion_r1961532221
##########
datafusion/substrait/src/serializer.rs:
##########
@@ -26,28 +26,39 @@ use substrait::proto::Plan;
use std::fs::OpenOptions;
use std::io::{Read, Write};
+use std::path::Path;
-#[allow(clippy::suspicious_open_options)]
-pub async fn serialize(sql: &str, ctx: &SessionContext, path: &str) ->
Result<()> {
+/// Plans a sql and serializes the generated logical plan to bytes.
+/// The bytes are then written into a file at `path`.
+///
+/// Returns an error if the file already exists.
+pub async fn serialize(
+ sql: &str,
+ ctx: &SessionContext,
+ path: impl AsRef<Path>,
+) -> Result<()> {
let protobuf_out = serialize_bytes(sql, ctx).await;
- let mut file = OpenOptions::new().create(true).write(true).open(path)?;
+
+ let mut file = OpenOptions::new().write(true).create_new(true).open(path)?;
file.write_all(&protobuf_out?)?;
Ok(())
}
+/// Plans a sql and serializes the generated logical plan to bytes.
pub async fn serialize_bytes(sql: &str, ctx: &SessionContext) ->
Result<Vec<u8>> {
Review Comment:
I think we should leave this one as a `str` in this PR and we can
potentially add a `DataFrame` specific one as a follow on
However, given there is already an API to serialize `LogicalPlans` directly
I am not sure how much more value a DataFrame one would add
https://docs.rs/datafusion-substrait/latest/datafusion_substrait/#example-serializing-logicalplans
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
