### Rationale for this change
The documentation example for TupleRangeFromTable was missing the cast_options and ctx parameters, so it didn't match the actual function signature
### What changes are included in this PR?
Add them
### Are these changes tested?
No
### Are there any user-facing changes?
Better docs
* GitHub Issue: #17081
Authored-by: Nic Crane <thisisnic@gmail.com>
Signed-off-by: Antoine Pitrou <antoine@python.org>
### Rationale for this change
We decided to move Skyhook to its own repository here: https://lists.apache.org/thread/f5ndxf0o6v4wbzgoy6nsrj4xkn34f380
We've created https://github.com/apache/arrow-skyhook and extract Skyhook related commits to the repository.
### What changes are included in this PR?
Remove Skyhook from the main repository
### Are these changes tested?
CI is validated.
### Are there any user-facing changes?
Yes, Skyhook is removed from the main repository.
* GitHub Issue: #47225
Authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
### Rationale for this change
Encrypting columns with nested fields with a column key is not trivial since only leaf fields are allowed in the column key map. Documentation emphasizes this fact and provides examples.
### What changes are included in this PR?
This amends the documentation on encryption for C++ and Python.
### Are these changes tested?
Only documentation.
### Are there any user-facing changes?
Only documentation.
* GitHub Issue: #41246
Lead-authored-by: Enrico Minack <github@enrico.minack.dev>
Co-authored-by: Antoine Pitrou <pitrou@free.fr>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
### What changes are included in this PR?
This adds developer tooling to the repo for linting the docs by adding the sphinx-lint tool to archery and our pre-commit hooks. In both locations, only two rules are enabled at the moment (Discussed in https://github.com/apache/arrow/pull/40006): `trailing-whitespace` and `missing-final-newline`.
This PR also fixes the individual issues covered by the new tooling.
### Are these changes tested?
Yes, though manually. I tested this works by running `archery lint --docs` and `pre-commit` without and without changes that should get caught by the rules. It works as expected.
### Are there any user-facing changes?
Yes,
1. Developers that use pre-commit hooks will see a change in behavior when they modify docs
2. Developers using archery will see a new --docs option in `archery lint`
3. Developers working on the docs may see CI failures related to the new checks
* Closes: #39990
* GitHub Issue: #39990
Authored-by: Bryce Mecum <petridish@gmail.com>
Signed-off-by: Bryce Mecum <petridish@gmail.com>
### Rationale for this change
The work on the conversion from `Table`/`RecordBatch` to `Tensor` is progressing and we have to make sure to add information to the documentation.
### What changes are included in this PR?
I propose to add
- new page (`converting_recordbatch_to_tensor.rst`) in the `cpp/examples` section,
- added section (Conversion of RecordBatch do Tensor) in the `docs/source/python/data.rst`
the content above would be updated as the features are added in the future (row-major conversion, `Table::ToTensor`, DLPack support for `Tensor` class, etc.)
### Are these changes tested?
It will be tested with the crossbow preview-docs job.
### Are there any user-facing changes?
No, just documentation.
* GitHub Issue: #40841
Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
### Rationale for this change
### What changes are included in this PR?
Spelling fixes to docs/
### Are these changes tested?
### Are there any user-facing changes?
* Closes: #38950
Lead-authored-by: Josh Soref <2119212+jsoref@users.noreply.github.com>
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
### Rationale for this change
Noticed a typo on the web doc and proposing here a fix
### Are these changes tested?
No. But the PR is changing only text.
### Are there any user-facing changes?
Yes. But only documentation typo
Authored-by: Pierre Moulon <pmoulon@gmail.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
This PR adds corrections to the source docs to remove some of the warnings when building the documentation.
* Closes: #35438
Authored-by: Alenka Frim <frim.alenka@gmail.com>
Signed-off-by: Raúl Cumplido <raulcumplido@gmail.com>
This PR is meant to improve the ease of converting between Arrow tabular structure and row-based data. It adds an example of implementing and using the row converters to convert between vectors of `rapidjson::Document` and Arrow tables, highlighting some common patterns and important utilities provided by Arrow C++.
Authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
This is mostly based on the Python documentation. This also adds a new C++ example to accompany the documentation.
Closes#9810 from lidavidm/arrow-11677
Authored-by: David Li <li.davidm96@gmail.com>
Signed-off-by: David Li <li.davidm96@gmail.com>
Also use Ubuntu 20.04 by default, instead of 18.04.
Closes#9933 from pitrou/ARROW-12262-ubuntu-docs
Authored-by: Antoine Pitrou <antoine@python.org>
Signed-off-by: Antoine Pitrou <antoine@python.org>
This enables conversions between a `std::vector<std::tuple<…>>` like and `arrow::Table`.
tuple to Table:
```cpp
std::vector<std::tuple<double, std::string>> rows = ..
std::shared_ptr<Table> table;
if (!arrow::stl::TableFromTupleRange(
arrow::default_memory_pool(),
rows, names, &table).ok()
) {
// Error handling code should go here.
}
```
Table to tuple:
```cpp
// An important aspect here is that the table columns need to be in the
// same order as the columns will later appear in the tuple. As the tuple
// is unnamed, matching is done on positions.
std::shared_ptr<Table> table = ..
// The range needs to be pre-allocated to the respective amount of rows.
// This allows us to pass in an arbitrary range object, not only
// `std::vector`.
std::vector<std::tuple<double, std::string>> rows(2);
if (!arrow::stl::TupleRangeFromTable(*table, &rows).ok()) {
// Error handling code should go here.
}
```
Author: Korn, Uwe <Uwe.Korn@blue-yonder.com>
Author: Uwe L. Korn <uwelk@xhochy.com>
Closes#3404 from xhochy/stl-extension and squashes the following commits:
4856260a <Korn, Uwe> Cast to size_t to compare on equal signedness
aaeacfd1 <Uwe L. Korn> docker-compose run clang-format
386e5bc9 <Korn, Uwe> Check size of target
8b472da8 <Korn, Uwe> Update documentation
1a3743e0 <Korn, Uwe> Allow building shared libs without tests
9a08a3eb <Korn, Uwe> Use full path to checked_cast
e037507c <Korn, Uwe> Use ArrayFromJSON
1ab23f87 <Korn, Uwe> Move to type_singleton
30e66f9e <Korn, Uwe> Add additional STL conversions
Nic Crane