Skip to content

Commit 47a17fd

Browse files
committed
[doc] clearer doc about why sql() is async
1 parent e0a670f commit 47a17fd

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

ballista/rust/client/src/context.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,8 @@ impl BallistaContext {
238238

239239
/// Create a DataFrame from a SQL statement.
240240
///
241-
/// Async because CreateExternalTable might require to resolve the schema
241+
/// This method is `async` because queries of type `CREATE EXTERNAL TABLE`
242+
/// might require the schema to be infered.
242243
pub async fn sql(&self, sql: &str) -> Result<Arc<dyn DataFrame>> {
243244
let mut ctx = {
244245
let state = self.state.lock().unwrap();

ballista/rust/core/proto/ballista.proto

-2
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,6 @@ syntax = "proto3";
2020

2121
package ballista.protobuf;
2222

23-
import "google/protobuf/timestamp.proto";
24-
2523
option java_multiple_files = true;
2624
option java_package = "org.ballistacompute.protobuf";
2725
option java_outer_classname = "BallistaProto";

datafusion/src/execution/context.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,8 @@ impl ExecutionContext {
182182

183183
/// Creates a dataframe that will execute a SQL query.
184184
///
185-
/// async because CreateExternalTable queries might need schema inference
185+
/// This method is `async` because queries of type `CREATE EXTERNAL TABLE`
186+
/// might require the schema to be infered.
186187
pub async fn sql(&mut self, sql: &str) -> Result<Arc<dyn DataFrame>> {
187188
let plan = self.create_logical_plan(sql)?;
188189
match plan {

0 commit comments

Comments
 (0)