Skip to content

Commit 8d6413b

Browse files
authored
Update Readme and asf.yaml (#3)
* Update MD * Update asf.yaml * Cleaner name * keep protected branch * Remove protected branches for now * Put `protected_branches` back * Remove all protected branches * Remove website + publish
1 parent 9e36ec4 commit 8d6413b

File tree

2 files changed

+5
-224
lines changed

2 files changed

+5
-224
lines changed

.asf.yaml

Lines changed: 1 addition & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -27,104 +27,16 @@ notifications:
2727
discussions: github@datafusion.apache.org
2828
jira_options: link label worklog
2929
github:
30-
description: "Apache DataFusion SQL Query Engine"
31-
homepage: https://datafusion.apache.org/
32-
labels:
33-
- arrow
34-
- big-data
35-
- dataframe
36-
- datafusion
37-
- olap
38-
- python
39-
- query-engine
40-
- rust
41-
- sql
30+
description: "DataFusion Test Sandbox"
4231
enabled_merge_buttons:
4332
squash: true
4433
merge: false
4534
rebase: false
4635
features:
4736
issues: true
4837
discussions: true
49-
protected_branches:
50-
main:
51-
required_pull_request_reviews:
52-
required_approving_review_count: 1
53-
# needs to be updated as part of the release process
54-
# .asf.yaml doesn't support wildcard branch protection rules, only exact branch names
55-
# https://github.com/apache/infrastructure-asfyaml?tab=readme-ov-file#branch-protection
56-
# Keeping set of protected branches for future releases
57-
# Meanwhile creating a prerelease script that will update the branch protection names
58-
# automatically. Keep track on it https://github.com/apache/datafusion/issues/17134
59-
branch-50:
60-
required_pull_request_reviews:
61-
required_approving_review_count: 1
62-
branch-51:
63-
required_pull_request_reviews:
64-
required_approving_review_count: 1
65-
branch-52:
66-
required_pull_request_reviews:
67-
required_approving_review_count: 1
68-
branch-53:
69-
required_pull_request_reviews:
70-
required_approving_review_count: 1
71-
branch-54:
72-
required_pull_request_reviews:
73-
required_approving_review_count: 1
74-
branch-55:
75-
required_pull_request_reviews:
76-
required_approving_review_count: 1
77-
branch-56:
78-
required_pull_request_reviews:
79-
required_approving_review_count: 1
80-
branch-57:
81-
required_pull_request_reviews:
82-
required_approving_review_count: 1
83-
branch-58:
84-
required_pull_request_reviews:
85-
required_approving_review_count: 1
86-
branch-59:
87-
required_pull_request_reviews:
88-
required_approving_review_count: 1
89-
branch-60:
90-
required_pull_request_reviews:
91-
required_approving_review_count: 1
92-
branch-61:
93-
required_pull_request_reviews:
94-
required_approving_review_count: 1
95-
branch-62:
96-
required_pull_request_reviews:
97-
required_approving_review_count: 1
98-
branch-63:
99-
required_pull_request_reviews:
100-
required_approving_review_count: 1
101-
branch-64:
102-
required_pull_request_reviews:
103-
required_approving_review_count: 1
104-
branch-65:
105-
required_pull_request_reviews:
106-
required_approving_review_count: 1
107-
branch-66:
108-
required_pull_request_reviews:
109-
required_approving_review_count: 1
110-
branch-67:
111-
required_pull_request_reviews:
112-
required_approving_review_count: 1
113-
branch-68:
114-
required_pull_request_reviews:
115-
required_approving_review_count: 1
116-
branch-69:
117-
required_pull_request_reviews:
118-
required_approving_review_count: 1
119-
branch-70:
120-
required_pull_request_reviews:
121-
required_approving_review_count: 1
12238
pull_requests:
12339
# enable updating head branches of pull requests
12440
allow_update_branch: true
12541
allow_auto_merge: true
12642

127-
# publishes the content of the `asf-site` branch to
128-
# https://datafusion.apache.org/
129-
publish:
130-
whoami: asf-site

README.md

Lines changed: 4 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -17,140 +17,9 @@
1717
under the License.
1818
-->
1919

20-
# Apache DataFusion
20+
> [!WARNING]
21+
> This is NOT [DataFusion](https://github.com/apache/datafusion/).
2122
22-
[![Crates.io][crates-badge]][crates-url]
23-
[![Apache licensed][license-badge]][license-url]
24-
[![Build Status][actions-badge]][actions-url]
25-
![Commit Activity][commit-activity-badge]
26-
[![Open Issues][open-issues-badge]][open-issues-url]
27-
[![Discord chat][discord-badge]][discord-url]
28-
[![Linkedin][linkedin-badge]][linkedin-url]
29-
![Crates.io MSRV][msrv-badge]
23+
# DataFusion Sandbox
3024

31-
[crates-badge]: https://img.shields.io/crates/v/datafusion.svg
32-
[crates-url]: https://crates.io/crates/datafusion
33-
[license-badge]: https://img.shields.io/badge/license-Apache%20v2-blue.svg
34-
[license-url]: https://github.com/apache/datafusion/blob/main/LICENSE.txt
35-
[actions-badge]: https://github.com/apache/datafusion/actions/workflows/rust.yml/badge.svg
36-
[actions-url]: https://github.com/apache/datafusion/actions?query=branch%3Amain
37-
[discord-badge]: https://img.shields.io/badge/Chat-Discord-purple
38-
[discord-url]: https://discord.com/invite/Qw5gKqHxUM
39-
[commit-activity-badge]: https://img.shields.io/github/commit-activity/m/apache/datafusion
40-
[open-issues-badge]: https://img.shields.io/github/issues-raw/apache/datafusion
41-
[open-issues-url]: https://github.com/apache/datafusion/issues
42-
[linkedin-badge]: https://img.shields.io/badge/Follow-Linkedin-blue
43-
[linkedin-url]: https://www.linkedin.com/company/apache-datafusion/
44-
[msrv-badge]: https://img.shields.io/crates/msrv/datafusion?label=Min%20Rust%20Version
45-
46-
[Website](https://datafusion.apache.org/) |
47-
[API Docs](https://docs.rs/datafusion/latest/datafusion/) |
48-
[Chat](https://discord.com/channels/885562378132000778/885562378132000781)
49-
50-
<a href="https://datafusion.apache.org/">
51-
<img src="https://github.com/apache/datafusion/raw/HEAD/docs/source/_static/images/2x_bgwhite_original.png" width="512" alt="logo"/>
52-
</a>
53-
54-
DataFusion is an extensible query engine written in [Rust] that
55-
uses [Apache Arrow] as its in-memory format.
56-
57-
This crate provides libraries and binaries for developers building fast and
58-
feature rich database and analytic systems, customized to particular workloads.
59-
See [use cases] for examples. The following related subprojects target end users:
60-
61-
- [DataFusion Python](https://github.com/apache/datafusion-python/) offers a Python interface for SQL and DataFrame
62-
queries.
63-
- [DataFusion Comet](https://github.com/apache/datafusion-comet/) is an accelerator for Apache Spark based on
64-
DataFusion.
65-
66-
"Out of the box,"
67-
DataFusion offers [SQL] and [`Dataframe`] APIs, excellent [performance],
68-
built-in support for CSV, Parquet, JSON, and Avro, extensive customization, and
69-
a great community.
70-
71-
DataFusion features a full query planner, a columnar, streaming, multi-threaded,
72-
vectorized execution engine, and partitioned data sources. You can
73-
customize DataFusion at almost all points including additional data sources,
74-
query languages, functions, custom operators and more.
75-
See the [Architecture] section for more details.
76-
77-
[rust]: http://rustlang.org
78-
[apache arrow]: https://arrow.apache.org
79-
[use cases]: https://datafusion.apache.org/user-guide/introduction.html#use-cases
80-
[python bindings]: https://github.com/apache/datafusion-python
81-
[performance]: https://benchmark.clickhouse.com/
82-
[architecture]: https://datafusion.apache.org/contributor-guide/architecture.html
83-
84-
Here are links to some important information
85-
86-
- [Project Site](https://datafusion.apache.org/)
87-
- [Installation](https://datafusion.apache.org/user-guide/cli/installation.html)
88-
- [Rust Getting Started](https://datafusion.apache.org/user-guide/example-usage.html)
89-
- [Rust DataFrame API](https://datafusion.apache.org/user-guide/dataframe.html)
90-
- [Rust API docs](https://docs.rs/datafusion/latest/datafusion)
91-
- [Rust Examples](https://github.com/apache/datafusion/tree/main/datafusion-examples)
92-
- [Python DataFrame API](https://arrow.apache.org/datafusion-python/)
93-
- [Architecture](https://docs.rs/datafusion/latest/datafusion/index.html#architecture)
94-
95-
## What can you do with this crate?
96-
97-
DataFusion is great for building projects such as domain specific query engines, new database platforms and data pipelines, query languages and more.
98-
It lets you start quickly from a fully working engine, and then customize those features specific to your use. [Click Here](https://datafusion.apache.org/user-guide/introduction.html#known-users) to see a list known users.
99-
100-
## Contributing to DataFusion
101-
102-
Please see the [contributor guide] and [communication] pages for more information.
103-
104-
[contributor guide]: https://datafusion.apache.org/contributor-guide
105-
[communication]: https://datafusion.apache.org/contributor-guide/communication.html
106-
107-
## Crate features
108-
109-
This crate has several [features] which can be specified in your `Cargo.toml`.
110-
111-
[features]: https://doc.rust-lang.org/cargo/reference/features.html
112-
113-
Default features:
114-
115-
- `nested_expressions`: functions for working with nested type function such as `array_to_string`
116-
- `compression`: reading files compressed with `xz2`, `bzip2`, `flate2`, and `zstd`
117-
- `crypto_expressions`: cryptographic functions such as `md5` and `sha256`
118-
- `datetime_expressions`: date and time functions such as `to_timestamp`
119-
- `encoding_expressions`: `encode` and `decode` functions
120-
- `parquet`: support for reading the [Apache Parquet] format
121-
- `sql`: Support for sql parsing / planning
122-
- `regex_expressions`: regular expression functions, such as `regexp_match`
123-
- `unicode_expressions`: Include unicode aware functions such as `character_length`
124-
- `unparser`: enables support to reverse LogicalPlans back into SQL
125-
- `recursive_protection`: uses [recursive](https://docs.rs/recursive/latest/recursive/) for stack overflow protection.
126-
127-
Optional features:
128-
129-
- `avro`: support for reading the [Apache Avro] format
130-
- `backtrace`: include backtrace information in error messages
131-
- `parquet_encryption`: support for using [Parquet Modular Encryption]
132-
- `pyarrow`: conversions between PyArrow and DataFusion types
133-
- `serde`: enable arrow-schema's `serde` feature
134-
135-
[apache avro]: https://avro.apache.org/
136-
[apache parquet]: https://parquet.apache.org/
137-
[parquet modular encryption]: https://parquet.apache.org/docs/file-format/data-pages/encryption/
138-
139-
## DataFusion API Evolution and Deprecation Guidelines
140-
141-
Public methods in Apache DataFusion evolve over time: while we try to maintain a
142-
stable API, we also improve the API over time. As a result, we typically
143-
deprecate methods before removing them, according to the [deprecation guidelines].
144-
145-
[deprecation guidelines]: https://datafusion.apache.org/contributor-guide/api-health.html
146-
147-
## Dependencies and `Cargo.lock`
148-
149-
Following the [guidance] on committing `Cargo.lock` files, this project commits
150-
its `Cargo.lock` file.
151-
152-
CI uses the committed `Cargo.lock` file, and dependencies are updated regularly
153-
using [Dependabot] PRs.
154-
155-
[guidance]: https://blog.rust-lang.org/2023/08/29/committing-lockfiles.html
156-
[dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot
25+
This repo is a sandbox for experimenting with DataFusion CI. **Do not use this repo for anything else.**

0 commit comments

Comments
 (0)