-
Notifications
You must be signed in to change notification settings - Fork 155
Integrate datafusion-distributed with Python #1611
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.
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
Draft
gabotechs
wants to merge
1
commit into
main
Choose a base branch
from
gabotechs/datafusion-distributed-integration
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,10 +43,11 @@ use datafusion::execution::memory_pool::{FairSpillPool, GreedyMemoryPool, Unboun | |
| use datafusion::execution::options::{ArrowReadOptions, ReadOptions}; | ||
| use datafusion::execution::runtime_env::RuntimeEnvBuilder; | ||
| use datafusion::execution::session_state::SessionStateBuilder; | ||
| use datafusion::execution::{FunctionRegistry, TaskContextProvider}; | ||
| use datafusion::execution::{FunctionRegistry, SessionState, TaskContextProvider}; | ||
| use datafusion::prelude::{ | ||
| AvroReadOptions, CsvReadOptions, DataFrame, JsonReadOptions, ParquetReadOptions, | ||
| }; | ||
| use datafusion_distributed::{DistributedConfig, DistributedExt, SessionStateBuilderExt}; | ||
| use datafusion_ffi::catalog_provider::FFI_CatalogProvider; | ||
| use datafusion_ffi::catalog_provider_list::FFI_CatalogProviderList; | ||
| use datafusion_ffi::config::extension_options::FFI_ExtensionOptions; | ||
|
|
@@ -78,6 +79,7 @@ use crate::common::data_type::PyScalarValue; | |
| use crate::common::df_schema::PyDFSchema; | ||
| use crate::dataframe::PyDataFrame; | ||
| use crate::dataset::Dataset; | ||
| use crate::distributed_worker_resolver::PyWorkerResolver; | ||
| use crate::errors::{ | ||
| PyDataFusionError, PyDataFusionResult, from_datafusion_error, py_datafusion_err, | ||
| }; | ||
|
|
@@ -219,6 +221,15 @@ impl PySessionConfig { | |
|
|
||
| Ok(Self::from(config)) | ||
| } | ||
|
|
||
| #[pyo3(signature = (worker_resolver))] | ||
| fn with_distributed(&self, worker_resolver: PyWorkerResolver) -> Self { | ||
| let config = self | ||
| .config | ||
| .clone() | ||
| .with_distributed_worker_resolver(worker_resolver); | ||
| Self::from(config) | ||
| } | ||
| } | ||
|
|
||
| /// Runtime options for a SessionContext | ||
|
|
@@ -392,13 +403,20 @@ impl PySessionContext { | |
| } else { | ||
| RuntimeEnvBuilder::default() | ||
| }; | ||
| let distributed = DistributedConfig::from_config_options(config.options()).is_ok(); | ||
|
|
||
| let runtime = Arc::new(runtime_env_builder.build()?); | ||
| let session_state = SessionStateBuilder::new() | ||
| let mut builder = SessionStateBuilder::new() | ||
| .with_config(config) | ||
| .with_runtime_env(runtime) | ||
| .with_default_features() | ||
| .with_analyzer_rule(Arc::new(crate::analyzer::ResolveLambdaVariables::new())) | ||
| .build(); | ||
| .with_analyzer_rule(Arc::new(crate::analyzer::ResolveLambdaVariables::new())); | ||
|
|
||
| if distributed { | ||
| builder = builder.with_distributed_planner(); | ||
| } | ||
|
Comment on lines
+413
to
+417
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Rather than letting external system inject their own |
||
|
|
||
| let session_state = builder.build(); | ||
| let ctx = Arc::new(SessionContext::new_with_state(session_state)); | ||
| Ok(PySessionContext { | ||
| ctx, | ||
|
|
@@ -1430,6 +1448,14 @@ impl PySessionContext { | |
| } | ||
|
|
||
| impl PySessionContext { | ||
| pub(crate) fn from_session_state(session_state: SessionState) -> Self { | ||
| Self { | ||
| ctx: Arc::new(SessionContext::new_with_state(session_state)), | ||
| logical_codec: Arc::new(PythonLogicalCodec::default()), | ||
| physical_codec: Arc::new(PythonPhysicalCodec::default()), | ||
| } | ||
| } | ||
|
|
||
| async fn _table(&self, name: &str) -> datafusion::common::Result<DataFrame> { | ||
| self.ctx.table(name).await | ||
| } | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| use std::collections::HashMap; | ||
| use std::net::SocketAddr; | ||
|
|
||
| use async_trait::async_trait; | ||
| use datafusion::common::{DataFusionError, Result as DataFusionResult}; | ||
| use datafusion::execution::{SessionState, SessionStateBuilder}; | ||
| use datafusion_distributed::{Worker, WorkerQueryContext, WorkerSessionBuilder}; | ||
| use datafusion_python_util::wait_for_future; | ||
| use pyo3::Borrowed; | ||
| use pyo3::exceptions::{PyRuntimeError, PyTypeError}; | ||
| use pyo3::prelude::*; | ||
| use tonic::transport::Server; | ||
|
|
||
| use crate::context::PySessionContext; | ||
| use crate::errors::{PyDataFusionError, PyDataFusionResult}; | ||
|
|
||
| #[pyclass( | ||
| from_py_object, | ||
| frozen, | ||
| name = "Worker", | ||
| module = "datafusion", | ||
| subclass | ||
| )] | ||
| #[derive(Clone)] | ||
| pub struct PyWorker { | ||
| worker: Worker, | ||
| } | ||
|
|
||
| #[pymethods] | ||
| impl PyWorker { | ||
| #[new] | ||
| fn new() -> Self { | ||
| Self { | ||
| worker: Worker::default(), | ||
| } | ||
| } | ||
|
|
||
| #[staticmethod] | ||
| fn from_session_builder(session_builder: PyWorkerSessionBuilder) -> Self { | ||
| Self { | ||
| worker: Worker::from_session_builder(session_builder), | ||
| } | ||
| } | ||
|
|
||
| fn with_version(&self, version: String) -> Self { | ||
| Self { | ||
| worker: self.worker.clone().with_version(version), | ||
| } | ||
| } | ||
|
|
||
| fn with_max_message_size(&self, size: usize) -> Self { | ||
| Self { | ||
| worker: self.worker.clone().with_max_message_size(size), | ||
| } | ||
| } | ||
|
|
||
| #[pyo3(signature = (host = "127.0.0.1", port = 50051))] | ||
| fn serve(&self, py: Python<'_>, host: &str, port: u16) -> PyDataFusionResult<()> { | ||
| let addr = parse_socket_addr(host, port)?; | ||
| let worker = self.worker.clone(); | ||
| wait_for_future(py, serve_worker(worker, addr))?.map_err(PyDataFusionError::from) | ||
| } | ||
|
|
||
| #[pyo3(signature = (host = "127.0.0.1", port = 50051))] | ||
| fn serve_async<'py>( | ||
| &self, | ||
| py: Python<'py>, | ||
| host: &str, | ||
| port: u16, | ||
| ) -> PyResult<Bound<'py, PyAny>> { | ||
| let addr = parse_socket_addr(host, port)?; | ||
| let worker = self.worker.clone(); | ||
| pyo3_async_runtimes::tokio::future_into_py(py, async move { | ||
| serve_worker(worker, addr) | ||
| .await | ||
| .map_err(PyDataFusionError::from)?; | ||
| Ok(()) | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| #[pyclass(name = "WorkerQueryContext", module = "datafusion", subclass)] | ||
| pub struct PyWorkerQueryContext { | ||
| builder: Option<SessionStateBuilder>, | ||
| headers: HashMap<String, String>, | ||
| } | ||
|
|
||
| impl PyWorkerQueryContext { | ||
| fn new(ctx: WorkerQueryContext) -> Self { | ||
| let headers = ctx | ||
| .headers | ||
| .iter() | ||
| .map(|(name, value)| { | ||
| ( | ||
| name.as_str().to_owned(), | ||
| value.to_str().unwrap_or_default().to_owned(), | ||
| ) | ||
| }) | ||
| .collect(); | ||
|
|
||
| Self { | ||
| builder: Some(ctx.builder), | ||
| headers, | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #[pymethods] | ||
| impl PyWorkerQueryContext { | ||
| fn session_context(mut slf: PyRefMut<'_, Self>) -> PyResult<PySessionContext> { | ||
| let builder = slf.builder.take().ok_or_else(|| { | ||
| PyRuntimeError::new_err("WorkerQueryContext.session_context() can only be called once") | ||
| })?; | ||
| Ok(PySessionContext::from_session_state(builder.build())) | ||
| } | ||
|
|
||
| #[getter] | ||
| fn headers(&self) -> HashMap<String, String> { | ||
| self.headers.clone() | ||
| } | ||
| } | ||
|
|
||
| pub(crate) struct PyWorkerSessionBuilder { | ||
| callback: Py<PyAny>, | ||
| } | ||
|
|
||
| impl FromPyObject<'_, '_> for PyWorkerSessionBuilder { | ||
| type Error = PyErr; | ||
|
|
||
| fn extract(obj: Borrowed<'_, '_, PyAny>) -> Result<Self, Self::Error> { | ||
| if !obj.is_callable() { | ||
| return Err(PyTypeError::new_err( | ||
| "Expected worker session builder to be callable", | ||
| )); | ||
| } | ||
|
|
||
| Ok(Self { | ||
| callback: obj.to_owned().unbind(), | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| #[async_trait] | ||
| impl WorkerSessionBuilder for PyWorkerSessionBuilder { | ||
| async fn build_session_state( | ||
| &self, | ||
| ctx: WorkerQueryContext, | ||
| ) -> Result<SessionState, DataFusionError> { | ||
| Python::attach(|py| -> PyResult<SessionState> { | ||
| let ctx = Py::new(py, PyWorkerQueryContext::new(ctx))?; | ||
| let result = self.callback.call1(py, (ctx,))?; | ||
| let session_context = extract_session_context(result.bind(py))?; | ||
| Ok(session_context.ctx.state()) | ||
| }) | ||
| .map_err(|error| DataFusionError::External(Box::new(error))) | ||
| } | ||
| } | ||
|
|
||
| fn extract_session_context(obj: &Bound<'_, PyAny>) -> PyResult<PySessionContext> { | ||
| if let Ok(session_context) = obj.extract::<PySessionContext>() { | ||
| return Ok(session_context); | ||
| } | ||
|
|
||
| if let Ok(ctx_attr) = obj.getattr("ctx") | ||
| && let Ok(session_context) = ctx_attr.extract::<PySessionContext>() | ||
| { | ||
| return Ok(session_context); | ||
| } | ||
|
|
||
| Err(PyTypeError::new_err( | ||
| "WorkerSessionBuilder.build_session_state() must return a datafusion.SessionContext", | ||
| )) | ||
| } | ||
|
|
||
| fn parse_socket_addr(host: &str, port: u16) -> PyDataFusionResult<SocketAddr> { | ||
| format!("{host}:{port}").parse().map_err(|error| { | ||
| PyDataFusionError::Common(format!( | ||
| "invalid worker bind address {host}:{port}: {error}" | ||
| )) | ||
| }) | ||
| } | ||
|
|
||
| async fn serve_worker(worker: Worker, addr: SocketAddr) -> DataFusionResult<()> { | ||
| Server::builder() | ||
| .add_service(worker.into_worker_server()) | ||
| .serve(addr) | ||
| .await | ||
| .map_err(|error| DataFusionError::External(Box::new(error))) | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| use datafusion::common::DataFusionError; | ||
| use datafusion_distributed::WorkerResolver; | ||
| use pyo3::Borrowed; | ||
| use pyo3::exceptions::{PyTypeError, PyValueError}; | ||
| use pyo3::prelude::*; | ||
| use pyo3::types::PyString; | ||
| use url::Url; | ||
|
|
||
| pub(crate) struct PyWorkerResolver { | ||
| get_urls: Py<PyAny>, | ||
| } | ||
|
|
||
| impl FromPyObject<'_, '_> for PyWorkerResolver { | ||
| type Error = PyErr; | ||
|
|
||
| fn extract(obj: Borrowed<'_, '_, PyAny>) -> Result<Self, Self::Error> { | ||
| let get_urls = obj.getattr("get_urls")?; | ||
| if !get_urls.is_callable() { | ||
| return Err(PyTypeError::new_err( | ||
| "Expected worker_resolver.get_urls to be callable", | ||
| )); | ||
| } | ||
|
|
||
| Ok(Self { | ||
| get_urls: get_urls.unbind(), | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| struct WorkerUrls(Vec<Url>); | ||
|
|
||
| impl FromPyObject<'_, '_> for WorkerUrls { | ||
| type Error = PyErr; | ||
|
|
||
| fn extract(obj: Borrowed<'_, '_, PyAny>) -> Result<Self, Self::Error> { | ||
| if obj.is_instance_of::<PyString>() { | ||
| return Err(PyTypeError::new_err( | ||
| "WorkerResolver.get_urls() must return an iterable of URL strings, not a string", | ||
| )); | ||
| } | ||
|
|
||
| let mut parsed_urls = Vec::new(); | ||
| for url in obj.try_iter()? { | ||
| let url = url?; | ||
| let url = url.extract::<String>()?; | ||
| let parsed_url = Url::parse(&url).map_err(|error| { | ||
| PyValueError::new_err(format!( | ||
| "WorkerResolver.get_urls() returned invalid URL {url:?}: {error}" | ||
| )) | ||
| })?; | ||
| parsed_urls.push(parsed_url); | ||
| } | ||
|
|
||
| Ok(Self(parsed_urls)) | ||
| } | ||
| } | ||
|
|
||
| impl WorkerResolver for PyWorkerResolver { | ||
| fn get_urls(&self) -> Result<Vec<Url>, DataFusionError> { | ||
| Python::attach(|py| -> PyResult<Vec<Url>> { | ||
| let urls = self.get_urls.call0(py)?; | ||
| let urls = urls.extract::<WorkerUrls>(py)?; | ||
| Ok(urls.0) | ||
| }) | ||
| .map_err(|error| DataFusionError::External(Box::new(error))) | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the kind of thing that could be easily hidden behind a flag.