Apache DataFusion SQL Query Engine
docs: Fix rendering of `get_record_batch_memory_size` buffer diagram (#24637)
Andrew Lamb6e66a853b664
diff --git a/datafusion/common/src/utils/memory.rs b/datafusion/common/src/utils/memory.rsindex fd405e06a2..c68640d0fa 100644--- a/datafusion/common/src/utils/memory.rs+++ b/datafusion/common/src/utils/memory.rs@@ -131,19 +131,21 @@ pub fn estimate_memory_size<T>(num_elements: usize, fixed_size: usize) -> Result/// For a `RecordBatch` with two columns: `col1` and `col2`, two columns are pointing/// to a sub-region of the same buffer.///+/// ```text/// {xxxxxxxxxxxxxxxxxxx} <--- buffer/// ^ ^ ^ ^/// | | | |/// col1->{ } | |/// col2--------->{ }+/// ```////// In the above case, `get_record_batch_memory_size` will return the size of/// the buffer, instead of the sum of `col1` and `col2`'s actual memory size.///-/// Note: Current `RecordBatch`.get_array_memory_size()` will double count the-/// buffer memory size if multiple arrays within the batch are sharing the same-/// `Buffer`. This method provides temporary fix until the issue is resolved:-/// <https://github.com/apache/arrow-rs/issues/6439>+/// Note: The current [`RecordBatch::get_array_memory_size`] will double count+/// the buffer memory size if multiple arrays within the batch are sharing the+/// same `Buffer`. This method provides a temporary fix until the issue is+/// resolved: <https://github.com/apache/arrow-rs/issues/6439>pub fn get_record_batch_memory_size(batch: &RecordBatch) -> usize {RecordBatchMemoryCounter::new().count_batch(batch)}