Deprecate RuntimeConfig, update code to use new builder style#13635
Merged
comphead merged 2 commits intoapache:mainfrom Dec 4, 2024
Merged
Deprecate RuntimeConfig, update code to use new builder style#13635comphead merged 2 commits intoapache:mainfrom
RuntimeConfig, update code to use new builder style#13635comphead merged 2 commits intoapache:mainfrom
Conversation
alamb
commented
Dec 4, 2024
| .with_memory_pool(Arc::new(FairSpillPool::new(mem_limit as usize))) | ||
| .build_arc()?; | ||
| let ctx = SessionContext::new_with_config_rt(config, runtime_config); | ||
| let state = SessionStateBuilder::new() |
Contributor
Author
There was a problem hiding this comment.
this follows the new builder style model more fully
| } | ||
| } else { | ||
| rt_config | ||
| let mut rt_builder = RuntimeEnvBuilder::new(); |
Contributor
Author
There was a problem hiding this comment.
I think this code is now clearer -- previously the rt_config was actually a builder and used as such, but that was someone confusing given the code style
| async fn query_compress_data( | ||
| file_compression_type: FileCompressionType, | ||
| ) -> Result<()> { | ||
| let runtime = Arc::new(RuntimeEnvBuilder::new().build()?); |
Contributor
Author
There was a problem hiding this comment.
This simply creates a default RuntimeEnv which the SessionStateBuilder already does, so there is no need to do it again
| let path = path.join("tests/tpch-csv"); | ||
| let url = format!("file://{}", path.display()); | ||
|
|
||
| let runtime = RuntimeEnvBuilder::new().build_arc()?; |
Contributor
Author
There was a problem hiding this comment.
likewise here, this is the default runtime env, it isn't needed
| /// * [`CacheManager`]: Manage temporary cache data during the session lifetime | ||
| /// * [`ObjectStoreRegistry`]: Manage mapping URLs to object store instances | ||
| /// | ||
| /// # Example: Create default `RuntimeEnv` |
| #[deprecated(since = "44.0.0", note = "please use `RuntimeEnvBuilder` instead")] | ||
| #[allow(deprecated)] | ||
| pub fn try_new(config: RuntimeConfig) -> Result<Self> { | ||
| let RuntimeConfig { |
Contributor
Author
There was a problem hiding this comment.
this code is literally the same as RuntimeConfig::build so just call that directly
| let runtime = RuntimeEnvBuilder::new() | ||
| .build_arc() | ||
| .expect("default runtime created successfully"); | ||
| let runtime = Arc::new(RuntimeEnv::default()); |
Contributor
Author
There was a problem hiding this comment.
this does the same thing, just makes the intent clearer
32113c9 to
d043f63
Compare
comphead
reviewed
Dec 4, 2024
comphead
approved these changes
Dec 4, 2024
Contributor
Author
|
Thanks again for the review @comphead |
zhuliquan
pushed a commit
to zhuliquan/datafusion
that referenced
this pull request
Dec 6, 2024
…he#13635) * Deprecate `RuntimeConfig`, update code to use new builder style * Update datafusion/execution/src/runtime_env.rs --------- Co-authored-by: Oleks V <comphead@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Follow on to
RuntimeEnvBuilderrather thanRuntimeConfig#12156Rationale for this change
I hit this while working on #13424 and was a bit confused
@devanbenz added a nice builder style API to the
RuntimeEnvas well as some backwards compatibility APIs which is greatHowever all the examples and code still use the old pattern, which means we aren't getting the benefit of the new API
What changes are included in this PR?
Changes:
Are these changes tested?
By existing tests and new doc tests
Are there any user-facing changes?
Some APIs are now deprecated, but no APIs are removed