You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2024/01/10 18:28:42 UTC
[I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
alamb opened a new issue, #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820
### Is your feature request related to a problem or challenge?
The documentation for the datafusion-substrait crate is pretty much non existent which makes it hard for users to know what it does and how to use it
https://docs.rs/datafusion-substrait/latest/datafusion_substrait/#
### Describe the solution you'd like
_No response_
### Describe alternatives you've considered
_No response_
### Additional context
_No response_
--
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: github-unsubscribe@arrow.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1895562016
Hello, I found some bad links but I'm not sure how to fix them properly, one is https://crates.io/crates/datafusion-proto and one is https://github.com/apache/arrow -datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1925744891
> > @alamb Hello, excuse me. I need to move the test sample here, I don’t remember it clearly, I’m very sorry. https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs
>
> I don't think any movement is needed.
>
> Edit I was confused
>
> Basically the goal of this ticket is to make these two pages better:
>
> 1. https://docs.rs/datafusion-substrait/latest/datafusion_substrait/#
>
> 2. https://crates.io/crates/datafusion-substrait
>
>
> Following the model of
>
> 1. https://crates.io/crates/datafusion-proto
>
> 2. https://docs.rs/datafusion-proto/latest/datafusion_proto/
>
>
> Now that I review those pages, however, it seems like they could be improved substantially. I may try to take a shot at this myself
Thank you for your patient reply, then I will start working on this issue, thank you
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1925788060
Looks like it'll take some time for me
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "andygrove (via GitHub)" <gi...@apache.org>.
andygrove closed issue #8820: Add documentation to datafusion-substrait crate about what it does
URL: https://github.com/apache/arrow-datafusion/issues/8820
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1925722460
For an example, you can probably adapt one of the existing tests in datafusion-proto -- perhaps
https://github.com/apache/arrow-datafusion/blob/9d1502bce08172a3501524fb3ef4754af3cf98b6/datafusion/proto/tests/cases/roundtrip_logical_plan.rs#L275-L282
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1893607539
Thanks @caicancai that would be most appreciated
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1926864511
Thanks for trying and being so communicative @caicancai - I'll put it on my own list
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1898509493
@alamb Hello, excuse me. I would like to ask where lib.rs is located
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1925722073
> @alamb Hello, excuse me. I need to move the test sample here, I don’t remember it clearly, I’m very sorry. https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs
I don't think any movement is needed.
Basically the goal of this ticket is to make https://docs.rs/datafusion-proto/latest/datafusion_proto/ better explain what the crate is for and provide an example of encoding/decoding `LogicalPlan` and `ExecutionPlan`
The content of https://docs.rs/datafusion-proto/latest/datafusion_proto/ can be previewed locally using
```
cargo doc -p datafusion-proto --open
```
Does that make sense @caicancai ?
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1885402638
I think this is a good first issue as there is an example of how to make it in datafusion-proto
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1896646446
>  @alamb Hello, I found some bad links but I'm not sure how to fix them properly, one is https://crates.io/crates/datafusion-proto and one is https://github.c
om/apache/arrow-datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs
🤔 https://crates.io/crates/datafusion-proto works for me
And when I click on the examples link I see
https://github.com/apache/arrow-datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs
Maybe we need to move the examples into `lib.rs` so it shows up in rustdoc 🤔
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1925656196
@alamb Hello, excuse me. Do I need to move the test samples here?
https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1925723237
> @alamb Hello, excuse me. I need to move the test sample here, I don’t remember it clearly, I’m very sorry. https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs
I don't think any movement is needed.
Edit I was confused
Basically the goal of this ticket is to make these two pages better:
1. https://docs.rs/datafusion-substrait/latest/datafusion_substrait/#
2. https://crates.io/crates/datafusion-substrait
Following the model of
1. https://crates.io/crates/datafusion-proto
2. https://docs.rs/datafusion-proto/latest/datafusion_proto/
Now that I review those pages, however, it seems like they could be improved substantially. I may try to take a shot at this myself
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1895563478
https://crates.io/crates/datafusion-proto/examples
There is no such link
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1892955932
I want to try it but it might take me a little time because I don't know the use of datafusion-substrait either
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1898553657
> > @alamb Hello, excuse me. I would like to ask where lib.rs is located
>
> I am referring to https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs
>
> The documentation on crates.io https://crates.io/crates/datafusion-proto can be generated locally with a command like
>
> ```shell
> cargo doc -p datafusion-proto --open
> ```
let me try it
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "caicancai (via GitHub)" <gi...@apache.org>.
caicancai commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1897643484
>
> 🤔 https://crates.io/crates/datafusion-proto works for me
>
> And when I click on the examples link I see
>
> https://github.com/apache/arrow-datafusion/blob/HEAD/datafusion/proto/examples/expr_serde.rs
>
> Maybe we need to move the examples into `lib.rs` so it shows up in rustdoc 🤔
Can you let me try him?
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] Add documentation to datafusion-substrait crate about what it does [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on issue #8820:
URL: https://github.com/apache/arrow-datafusion/issues/8820#issuecomment-1898540449
> @alamb Hello, excuse me. I would like to ask where lib.rs is located
I am referring to https://github.com/apache/arrow-datafusion/blob/main/datafusion/proto/src/lib.rs
The documentation on crates.io https://crates.io/crates/datafusion-proto can be generated locally with a command like
```shell
cargo doc -p datafusion-proto --open
```
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org