Skip to content

Minor: Update documentations for memory pool #14278

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

Merged
jayzhan211 merged 2 commits into from
Jan 25, 2025
Merged

Minor: Update documentations for memory pool #14278

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8a9ab9
chore: udpate documentations for memory pool
appletreeisyellow Jan 24, 2025
eb5a50d
chore: clippy
appletreeisyellow Jan 24, 2025
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
9 changes: 6 additions & 3 deletions datafusion/execution/src/memory_pool/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
// specific language governing permissions and limitations
// under the License.

//! [`MemoryPool`] for memory management during query execution, [`proxy]` for
//! [`MemoryPool`] for memory management during query execution, [`proxy`] for
//! help with allocation accounting.

use datafusion_common::{internal_err, Result};
Expand Down Expand Up @@ -108,6 +108,9 @@ pub use pool::*;
///
/// * [`FairSpillPool`]: Limits memory usage to a fixed size, allocating memory
/// to all spilling operators fairly
///
/// * [`TrackConsumersPool`]: Wraps another [`MemoryPool`] and tracks consumers,
/// providing better error messages on the largest memory users.
pub trait MemoryPool: Send + Sync + std::fmt::Debug {
/// Registers a new [`MemoryConsumer`]
///
Expand Down Expand Up @@ -140,9 +143,9 @@ pub trait MemoryPool: Send + Sync + std::fmt::Debug {
/// [`MemoryReservation`] in a [`MemoryPool`]. All allocations are registered to
/// a particular `MemoryConsumer`;
///
/// For help with allocation accounting, see the [proxy] module.
/// For help with allocation accounting, see the [`proxy`] module.
///
/// [proxy]: crate::memory_pool::proxy
/// [proxy]: datafusion_common::utils::proxy
Comment on lines -145 to +148
Copy link
Contributor Author

@appletreeisyellow appletreeisyellow Jan 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

proxy was moved to datafusion commen in #10561 / b36f5e2

#[derive(Debug, PartialEq, Eq, Hash, Clone)]
pub struct MemoryConsumer {
name: String,
Expand Down
Loading