Skip to content

Commit 587277f

Browse files
authored
Update features / status documentation page (#14645)
* Update features / status documentation page * Fix doctest include
1 parent 0e52274 commit 587277f

File tree

4 files changed

+38
-27
lines changed

4 files changed

+38
-27
lines changed

datafusion/core/src/lib.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -920,6 +920,12 @@ doc_comment::doctest!(
920920
user_guide_cli_usage
921921
);
922922

923+
#[cfg(doctest)]
924+
doc_comment::doctest!(
925+
"../../../docs/source/user-guide/features.md",
926+
user_guide_features
927+
);
928+
923929
#[cfg(doctest)]
924930
doc_comment::doctest!(
925931
"../../../docs/source/user-guide/sql/aggregate_functions.md",
@@ -986,12 +992,6 @@ doc_comment::doctest!(
986992
user_guide_sql_special_functions
987993
);
988994

989-
#[cfg(doctest)]
990-
doc_comment::doctest!(
991-
"../../../docs/source/user-guide/sql/sql_status.md",
992-
user_guide_sql_status
993-
);
994-
995995
#[cfg(doctest)]
996996
doc_comment::doctest!(
997997
"../../../docs/source/user-guide/sql/subqueries.md",

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ To get started, see
103103

104104
user-guide/introduction
105105
user-guide/example-usage
106+
user-guide/features
106107
user-guide/concepts-readings-events
107108
user-guide/crate-configuration
108109
user-guide/cli/index

docs/source/user-guide/sql/sql_status.md renamed to docs/source/user-guide/features.md

Lines changed: 31 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,23 +17,28 @@
1717
under the License.
1818
-->
1919

20-
# Status
20+
# Features
2121

2222
## General
2323

2424
- [x] SQL Parser
2525
- [x] SQL Query Planner
26+
- [x] DataFrame API
27+
- [x] Parallel query execution
28+
- [x] Streaming Execution
29+
30+
## Optimizations
31+
2632
- [x] Query Optimizer
2733
- [x] Constant folding
2834
- [x] Join Reordering
2935
- [x] Limit Pushdown
3036
- [x] Projection push down
3137
- [x] Predicate push down
32-
- [x] Type coercion
33-
- [x] Parallel query execution
3438

3539
## SQL Support
3640

41+
- [x] Type coercion
3742
- [x] Projection (`SELECT`)
3843
- [x] Filter (`WHERE`)
3944
- [x] Filter post-aggregate (`HAVING`)
@@ -42,23 +47,23 @@
4247
- [x] Aggregate (`GROUP BY`)
4348
- [x] cast /try_cast
4449
- [x] [`VALUES` lists](https://www.postgresql.org/docs/current/queries-values.html)
45-
- [x] [String Functions](./scalar_functions.md#string-functions)
46-
- [x] [Conditional Functions](./scalar_functions.md#conditional-functions)
47-
- [x] [Time and Date Functions](./scalar_functions.md#time-and-date-functions)
48-
- [x] [Math Functions](./scalar_functions.md#math-functions)
49-
- [x] [Aggregate Functions](./aggregate_functions.md) (`SUM`, `MEDIAN`, and many more)
50+
- [x] [String Functions](./sql/scalar_functions.md#string-functions)
51+
- [x] [Conditional Functions](./sql/scalar_functions.md#conditional-functions)
52+
- [x] [Time and Date Functions](./sql/scalar_functions.md#time-and-date-functions)
53+
- [x] [Math Functions](./sql/scalar_functions.md#math-functions)
54+
- [x] [Aggregate Functions](./sql/aggregate_functions.md) (`SUM`, `MEDIAN`, and many more)
5055
- [x] Schema Queries
5156
- [x] `SHOW TABLES`
5257
- [x] `SHOW COLUMNS FROM <table/view>`
5358
- [x] `SHOW CREATE TABLE <view>`
54-
- [x] Basic SQL [Information Schema](./information_schema.md) (`TABLES`, `VIEWS`, `COLUMNS`)
55-
- [ ] Full SQL [Information Schema](./information_schema.md) support
56-
- [ ] Support for nested types (`ARRAY`/`LIST` and `STRUCT`. See [#2326](https://github.com/apache/datafusion/issues/2326) for details)
59+
- [x] Basic SQL [Information Schema](./sql/information_schema.md) (`TABLES`, `VIEWS`, `COLUMNS`)
60+
- [ ] Full SQL [Information Schema](./sql/information_schema.md) support
61+
- [x] Support for nested types (`ARRAY`/`LIST` and `STRUCT`.
5762
- [x] Read support
5863
- [x] Write support
5964
- [x] Field access (`col['field']` and [`col[1]`])
60-
- [x] [Array Functions](./scalar_functions.md#array-functions)
61-
- [ ] [Struct Functions](./scalar_functions.md#struct-functions)
65+
- [x] [Array Functions](./sql/scalar_functions.md#array-functions)
66+
- [x] [Struct Functions](./sql/scalar_functions.md#struct-functions)
6267
- [x] `struct`
6368
- [ ] [Postgres JSON operators](https://github.com/apache/datafusion/issues/6631) (`->`, `->>`, etc.)
6469
- [x] Subqueries
@@ -73,12 +78,12 @@
7378
- [x] Catalogs
7479
- [x] Schemas (`CREATE / DROP SCHEMA`)
7580
- [x] Tables (`CREATE / DROP TABLE`, `CREATE TABLE AS SELECT`)
76-
- [ ] Data Insert
81+
- [x] Data Insert
7782
- [x] `INSERT INTO`
78-
- [ ] `COPY .. INTO ..`
83+
- [x] `COPY .. INTO ..`
7984
- [x] CSV
80-
- [ ] JSON
81-
- [ ] Parquet
85+
- [x] JSON
86+
- [x] Parquet
8287
- [ ] Avro
8388

8489
## Runtime
@@ -87,16 +92,22 @@
8792
- [x] Streaming Window Evaluation
8893
- [x] Memory limits enforced
8994
- [x] Spilling (to disk) Sort
90-
- [ ] Spilling (to disk) Grouping
95+
- [x] Spilling (to disk) Grouping
9196
- [ ] Spilling (to disk) Joins
9297

9398
## Data Sources
9499

95-
In addition to allowing arbitrary datasources via the `TableProvider`
100+
In addition to allowing arbitrary datasources via the [`TableProvider`]
96101
trait, DataFusion includes built in support for the following formats:
97102

98103
- [x] CSV
99-
- [x] Parquet (for all primitive and nested types)
104+
- [x] Parquet
105+
- [x] Primitive and Nested Types
106+
- [x] Row Group and Data Page pruning on min/max statistics
107+
- [x] Row Group pruning on Bloom Filters
108+
- [x] Predicate push down (late materialization) [not by default](https://github.com/apache/datafusion/issues/3463)
100109
- [x] JSON
101110
- [x] Avro
102111
- [x] Arrow
112+
113+
[`tableprovider`]: https://docs.rs/datafusion/latest/datafusion/catalog/trait.TableProvider.html

docs/source/user-guide/sql/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,5 @@ SQL Reference
3333
window_functions
3434
scalar_functions
3535
special_functions
36-
sql_status
3736
write_options
3837
prepared_statements

0 commit comments

Comments
 (0)