Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use invoke_batch on UDFs as invoke is deprecated #652

Merged
merged 1 commit into from
Jan 30, 2025
Merged

fix: use invoke_batch on UDFs as invoke is deprecated #652

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 142 additions & 7 deletions pipeline/src/cid_string.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ use std::{any::Any, sync::Arc};
use cid::Cid;
use datafusion::{
arrow::{
array::{ArrayIter, ListBuilder, StringBuilder},
array::{ListBuilder, StringBuilder},
datatypes::DataType,
},
common::{
Expand All @@ -15,7 +15,10 @@ use datafusion::{
logical_expr::{ColumnarValue, ScalarUDFImpl, Signature, TypeSignature, Volatility},
};

/// ScalarUDF to convert a binary CID into a string for easier inspection. #[derive(Debug)]
// Length of a typical Ceramic CID as a UTF8 string in bytes.
const CID_STRING_BYTES: usize = 60;

/// ScalarUDF to convert a binary CID into a string for easier inspection.
#[derive(Debug)]
pub struct CidString {
signature: Signature,
Expand Down Expand Up @@ -52,10 +55,14 @@ impl ScalarUDFImpl for CidString {
fn return_type(&self, _args: &[DataType]) -> datafusion::common::Result<DataType> {
Ok(DataType::Utf8)
}
fn invoke(&self, args: &[ColumnarValue]) -> datafusion::common::Result<ColumnarValue> {
fn invoke_batch(
&self,
args: &[ColumnarValue],
number_rows: usize,
) -> datafusion::error::Result<ColumnarValue> {
let args = ColumnarValue::values_to_arrays(args)?;
let cids = as_binary_array(&args[0])?;
let mut strs = StringBuilder::new();
let mut strs = StringBuilder::with_capacity(number_rows, CID_STRING_BYTES * number_rows);
for cid in cids {
if let Some(cid) = cid {
strs.append_value(
Expand Down Expand Up @@ -108,11 +115,23 @@ impl ScalarUDFImpl for CidStringList {
fn return_type(&self, _args: &[DataType]) -> datafusion::common::Result<DataType> {
Ok(DataType::new_list(DataType::Utf8, true))
}
fn invoke(&self, args: &[ColumnarValue]) -> datafusion::common::Result<ColumnarValue> {
fn invoke_batch(
&self,
args: &[ColumnarValue],
number_rows: usize,
) -> datafusion::error::Result<ColumnarValue> {
let args = ColumnarValue::values_to_arrays(args)?;
let all_cids = as_list_array(&args[0])?;
let mut strs = ListBuilder::new(StringBuilder::new());
for cids in ArrayIter::new(all_cids) {
// Count the number of cids before allocating.
let cid_count = all_cids
.iter()
.map(|list| list.map(|l| l.len()).unwrap_or(0))
.sum();
let mut strs = ListBuilder::with_capacity(
StringBuilder::with_capacity(cid_count, CID_STRING_BYTES * cid_count),
number_rows,
);
for cids in all_cids.iter() {
if let Some(cids) = cids {
let cids = as_binary_array(&cids)?;
for cid in cids {
Expand All @@ -134,3 +153,119 @@ impl ScalarUDFImpl for CidStringList {
Ok(ColumnarValue::Array(Arc::new(strs.finish())))
}
}

#[cfg(test)]
mod tests {
use super::{CidString, CidStringList};

use std::{str::FromStr as _, sync::Arc};

use arrow::{
array::{ArrayRef, ListBuilder},
util::pretty::pretty_format_batches,
};
use cid::Cid;
use datafusion::{
arrow::array::{BinaryBuilder, StructArray},
logical_expr::{expr::ScalarFunction, ScalarUDF},
prelude::{col, Expr, SessionContext},
};
use expect_test::expect;
use test_log::test;

#[test(tokio::test)]
async fn cid_string() -> anyhow::Result<()> {
let mut cids = BinaryBuilder::new();
cids.append_value(
Cid::from_str("baeabeihqujx543mwoqik7lltjjtobjmdewsygp5s34mydy3web3dxhoide")?
.to_bytes(),
);
cids.append_value(
Cid::from_str("baeabeih6c7vkvijmvu22oqwwirsukfci46evfp6rrydq4bavmoxw5yrzaq")?
.to_bytes(),
);
cids.append_value(
Cid::from_str("baeabeiayakacgjkantxde2puuxqfrrq72cih4gykxov7gpdiypoz4d3oya")?
.to_bytes(),
);
cids.append_value(
Cid::from_str("baeabeiaclaqgmmybteclwcb6p6hth24pwezy3chaghryslttst34d2lrny")?
.to_bytes(),
);
cids.append_value(
Cid::from_str("baeabeibou6io3hgsapzk5kzdj6gxw5whbsa4oruhndgfonei35bugpqswm")?
.to_bytes(),
);

let batch = StructArray::try_from(vec![("cid", Arc::new(cids.finish()) as ArrayRef)])?;
let cid_string = Arc::new(ScalarUDF::from(CidString::new()));
let ctx = SessionContext::new();
let output = ctx
.read_batch(batch.into())?
.select(vec![Expr::ScalarFunction(ScalarFunction::new_udf(
cid_string,
vec![col("cid")],
))])?
.collect()
.await?;
let output = pretty_format_batches(&output)?;
expect![[r#"
+-------------------------------------------------------------+
| cid_string(?table?.cid) |
+-------------------------------------------------------------+
| baeabeihqujx543mwoqik7lltjjtobjmdewsygp5s34mydy3web3dxhoide |
| baeabeih6c7vkvijmvu22oqwwirsukfci46evfp6rrydq4bavmoxw5yrzaq |
| baeabeiayakacgjkantxde2puuxqfrrq72cih4gykxov7gpdiypoz4d3oya |
| baeabeiaclaqgmmybteclwcb6p6hth24pwezy3chaghryslttst34d2lrny |
| baeabeibou6io3hgsapzk5kzdj6gxw5whbsa4oruhndgfonei35bugpqswm |
+-------------------------------------------------------------+"#]]
.assert_eq(&output.to_string());
Ok(())
}
#[test(tokio::test)]
async fn cid_string_list() -> anyhow::Result<()> {
let mut cids = ListBuilder::new(BinaryBuilder::new());
cids.values().append_value(
Cid::from_str("baeabeihqujx543mwoqik7lltjjtobjmdewsygp5s34mydy3web3dxhoide")?
.to_bytes(),
);
cids.values().append_value(
Cid::from_str("baeabeih6c7vkvijmvu22oqwwirsukfci46evfp6rrydq4bavmoxw5yrzaq")?
.to_bytes(),
);
cids.values().append_value(
Cid::from_str("baeabeiayakacgjkantxde2puuxqfrrq72cih4gykxov7gpdiypoz4d3oya")?
.to_bytes(),
);
cids.append(true);
cids.values().append_value(
Cid::from_str("baeabeiaclaqgmmybteclwcb6p6hth24pwezy3chaghryslttst34d2lrny")?
.to_bytes(),
);
cids.values().append_value(
Cid::from_str("baeabeibou6io3hgsapzk5kzdj6gxw5whbsa4oruhndgfonei35bugpqswm")?
.to_bytes(),
);
cids.append(true);
let batch = StructArray::try_from(vec![("cids", Arc::new(cids.finish()) as ArrayRef)])?;
let cid_string_list = Arc::new(ScalarUDF::from(CidStringList::new()));
let ctx = SessionContext::new();
let output = ctx
.read_batch(batch.into())?
.select(vec![Expr::ScalarFunction(ScalarFunction::new_udf(
cid_string_list,
vec![col("cids")],
))])?
.collect()
.await?;
let output = pretty_format_batches(&output)?;
expect![[r#"
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| array_cid_string(?table?.cids) |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| [baeabeihqujx543mwoqik7lltjjtobjmdewsygp5s34mydy3web3dxhoide, baeabeih6c7vkvijmvu22oqwwirsukfci46evfp6rrydq4bavmoxw5yrzaq, baeabeiayakacgjkantxde2puuxqfrrq72cih4gykxov7gpdiypoz4d3oya] |
| [baeabeiaclaqgmmybteclwcb6p6hth24pwezy3chaghryslttst34d2lrny, baeabeibou6io3hgsapzk5kzdj6gxw5whbsa4oruhndgfonei35bugpqswm] |
+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+"#]].assert_eq(&output.to_string());
Ok(())
}
}