alamb commented on code in PR #7327:
URL: https://github.com/apache/arrow-datafusion/pull/7327#discussion_r1298392507
##########
datafusion/core/src/execution/context.rs:
##########
@@ -342,16 +371,69 @@ impl SessionContext {
self.state.read().config.clone()
}
- /// Creates a [`DataFrame`] that will execute a SQL query.
+ /// Creates a [`DataFrame`] from SQL query text.
///
/// Note: This API implements DDL statements such as `CREATE TABLE` and
/// `CREATE VIEW` and DML statements such as `INSERT INTO` with in-memory
/// default implementations.
///
- /// If this is not desirable, consider using
[`SessionState::create_logical_plan()`] which
- /// does not mutate the state based on such statements.
+ /// For read only SQL, use [`SessionState::create_logical_plan()`] to
create a
Review Comment:
Here is the core explanation
##########
datafusion/core/src/execution/context.rs:
##########
@@ -163,35 +163,64 @@ where
/// * Register a custom data source that can be referenced from a SQL query.
/// * Execution a SQL query
///
+/// # Example: DataFrame API
+///
/// The following example demonstrates how to use the context to execute a
query against a CSV
/// data source using the DataFrame API:
///
/// ```
/// use datafusion::prelude::*;
-/// # use datafusion::error::Result;
+/// # use datafusion::{error::Result, assert_batches_eq};
/// # #[tokio::main]
/// # async fn main() -> Result<()> {
/// let ctx = SessionContext::new();
/// let df = ctx.read_csv("tests/data/example.csv",
CsvReadOptions::new()).await?;
/// let df = df.filter(col("a").lt_eq(col("b")))?
/// .aggregate(vec![col("a")], vec![min(col("b"))])?
/// .limit(0, Some(100))?;
-/// let results = df.collect();
Review Comment:
since the results were not used it turns out the example was missing an
`await`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
