Skip to content

Commit

Permalink
Improve SessionStateBuilder::new documentation (apache#14980)
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb authored Mar 3, 2025
1 parent ea1ca27 commit 2fcab2e
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions datafusion/core/src/execution/session_state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1012,7 +1012,10 @@ pub struct SessionStateBuilder {
}

impl SessionStateBuilder {
/// Returns a new [`SessionStateBuilder`] with no options set.
/// Returns a new empty [`SessionStateBuilder`].
///
/// See [`Self::with_default_features`] to install the default set of functions,
/// catalogs, etc.
pub fn new() -> Self {
Self {
session_id: None,
Expand Down Expand Up @@ -1042,9 +1045,10 @@ impl SessionStateBuilder {
}
}

/// Returns a new [SessionStateBuilder] based on an existing [SessionState]
/// Returns a new [SessionStateBuilder] based on an existing [SessionState].
///
/// The session id for the new builder will be unset; all other fields will
/// be cloned from what is set in the provided session state. If the default
/// be cloned from `existing`. If the default
/// catalog exists in existing session state, the new session state will not
/// create default catalog and schema.
pub fn new_from_existing(existing: SessionState) -> Self {
Expand Down

0 comments on commit 2fcab2e

Please sign in to comment.