Skip to content

Conversation

@alamb
Copy link
Contributor

@alamb alamb commented Feb 13, 2025

Which issue does this PR close?

Rationale for this change

I am trying to improve the docs (inspired by recent PRs)

Let's try and consolidate as much of the documentation into the same set of docs so it isn't spread all over

What changes are included in this PR?

  1. Move information about crate configuration to the user docs:

Are these changes tested?

I tested them manually
Screenshot 2025-02-13 at 4 30 16 PM

Are there any user-facing changes?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 13, 2025
- `compression`: reading files compressed with `xz2`, `bzip2`, `flate2`, and `zstd`
- `crypto_expressions`: cryptographic functions such as `md5` and `sha256`
- `datetime_expressions`: date and time functions such as `to_timestamp`
- `encoding_expressions`: `encode` and `decode` functions
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There were also a few missing items here

@alamb alamb requested a review from andygrove February 15, 2025 11:20
- `crypto_expressions`: cryptographic functions such as `md5` and `sha256`
- `datetime_expressions`: date and time functions such as `to_timestamp`
- `encoding_expressions`: `encode` and `decode` functions
- `math_expressions`: `sqrt` and other math functions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't appear to be in the defaults list here:

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was an excellent call. I fixed it in df190ad

However, I think since the subcrates already have their own default features, it is likely not possible to remove these various functon packages 🤔 maybe we should fix that in a following issue

- `parquet`: support for reading the [Apache Parquet] format
- `regex_expressions`: regular expression functions, such as `regexp_match`
- `unicode_expressions`: Include unicode aware functions such as `character_length`
- `unparser`: enables support to reverse LogicalPlans back into SQL
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't appear to be in the defaults list here:


### Default features:

- `nested_expressions`: functions for working with nested type function such as `array_to_string`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be better in alphabetical order?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea -- done in 6654168

@github-actions github-actions bot added the core Core DataFusion crate label Feb 22, 2025
Copy link
Contributor Author

@alamb alamb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @dhegberg for the review

- `crypto_expressions`: cryptographic functions such as `md5` and `sha256`
- `datetime_expressions`: date and time functions such as `to_timestamp`
- `encoding_expressions`: `encode` and `decode` functions
- `math_expressions`: `sqrt` and other math functions
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was an excellent call. I fixed it in df190ad

However, I think since the subcrates already have their own default features, it is likely not possible to remove these various functon packages 🤔 maybe we should fix that in a following issue


### Default features:

- `nested_expressions`: functions for working with nested type function such as `array_to_string`
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea -- done in 6654168

@github-actions
Copy link

Thank you for your contribution. Unfortunately, this pull request is stale because it has been open 60 days with no activity. Please remove the stale label or comment or this will be closed in 7 days.

@github-actions github-actions bot added the Stale PR has not had any activity for some time label Apr 24, 2025
@Omega359
Copy link
Contributor

This is a good ticket and shouldn't be autoclosed.

@github-actions github-actions bot removed the Stale PR has not had any activity for some time label May 2, 2025
@alamb
Copy link
Contributor Author

alamb commented May 5, 2025

Yeah it just needs a committer to review I think

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core Core DataFusion crate documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants