GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889

Merged
wjones127 merged 5 commits into
apache:mainfrom
wgtmac:kvmeta
Apr 13, 2023
Merged

GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom
wgtmac:kvmeta

Conversation

@wgtmac

@wgtmacwgtmac commented Apr 4, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Rationale for this change

Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.

What changes are included in this PR?

Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.

Are these changes tested?

Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.

Are there any user-facing changes?

Yes, user can add custom key-value metadata whenever writer is not closed.

@wgtmac
wgtmac requested a review from wjones127 as a code ownerApril 4, 2023 15:47
@github-actions

github-actionsBot commented Apr 4, 2023

Copy link
Copy Markdown

@github-actions

github-actionsBot commented Apr 4, 2023

Copy link
Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.

@wgtmac
wgtmacforce-pushed the kvmeta branch 2 times, most recently from 1748c1f to c5b322dCompareApril 6, 2023 15:51
@wgtmac

wgtmac commented Apr 7, 2023

Copy link
Copy Markdown
MemberAuthor

@wjones127@westonpace Please take a look when you have time. Thanks!

wjones127
wjones127 reviewed Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc Outdated

@wjones127wjones127Apr 7, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think we can remove this?

@wgtmacwgtmacApr 10, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Fixed

@github-actionsgithub-actionsBot added awaiting changes Awaiting changes and removed awaiting review Awaiting review labels Apr 7, 2023
wjones127
wjones127 reviewed Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h Outdated
mapleFU
mapleFU reviewed Apr 8, 2023
View reviewed changes

@mapleFUmapleFU left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Rest LGTM

Comment threadcpp/src/parquet/file_writer.cc Outdated
Comment threadcpp/src/parquet/file_writer.h Outdated
Comment threadcpp/src/parquet/file_writer.cc Outdated
Comment threadcpp/src/parquet/metadata.h Outdated
@github-actionsgithub-actionsBot added awaiting change review Awaiting change review and removed awaiting changes Awaiting changes labels Apr 9, 2023
@wgtmac
wgtmac requested a review from wjones127April 10, 2023 01:42
wjones127
wjones127 requested changes Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h Outdated
Comment threadcpp/src/parquet/metadata.h Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting change review Awaiting change review and removed awaiting change review Awaiting change review awaiting changes Awaiting changes labels Apr 10, 2023
@wgtmac

wgtmac commented Apr 10, 2023

Copy link
Copy Markdown
MemberAuthor

Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127

@wgtmac

wgtmac commented Apr 11, 2023

Copy link
Copy Markdown
MemberAuthor

https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:

+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac requested a review from wjones127April 11, 2023 06:05
wjones127
wjones127 approved these changes Apr 11, 2023
View reviewed changes

@wjones127wjones127 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!

Comment threadcpp/src/parquet/file_writer.cc Outdated
@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac commented Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")

@wgtmacwgtmacApr 12, 2023

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Suggested change
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")

Should I change this since it may not be included in the 12.0.0 release? @wjones127

@wjones127
wjones127 merged commit 3bd57e3 into apache:mainApr 13, 2023
@wjones127

wjones127 commented Apr 13, 2023

Copy link
Copy Markdown
Member

I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).

@raulcd

raulcd commented Apr 13, 2023

Copy link
Copy Markdown
Member

@raulcd would it be possible to add this to the release branch?

I will add it to 12.0.0

@ursabot

ursabot commented Apr 15, 2023

Copy link
Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Failed] test-mac-arm
[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x
[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2
[Failed] 3bd57e35 test-mac-arm
[Finished] 3bd57e35 ursa-i9-9960x
[Finished] 3bd57e35 ursa-thinkcentre-m75q
[Finished] 49631057 ec2-t3-xlarge-us-east-2
[Failed] 49631057 test-mac-arm
[Finished] 49631057 ursa-i9-9960x
[Finished] 49631057 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

@ursabot

ursabot commented Apr 15, 2023

Copy link
Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x

raulcd pushed a commit that referenced this pull request Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit to LoongArch-Python/arrow that referenced this pull request May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit to Bit-Quill/arrow that referenced this pull request May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU mentioned this pull request May 24, 2024
Merged
mapleFU added a commit that referenced this pull request Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees

No one assigned

Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened

5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889
Merged
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Apr 13, 2023
Merged
GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Conversation
@wgtmac
@wgtmacwgtmac
commented
Apr 4, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
What changes are included in this PR?
Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.
Are these changes tested?
Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.
Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
@wgtmac
wgtmac
requested a review
from wjones127
as a code ownerApril 4, 2023 15:47
@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.
@wgtmac
wgtmacforce-pushed
the
kvmeta
branch
2 times, most recently
from
1748c1f to
c5b322dCompareApril 6, 2023 15:51
@wgtmac
wgtmac
commented
Apr 7, 2023

Copy link


Copy Markdown

MemberAuthor
@wjones127@westonpace Please take a look when you have time. Thanks!
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc
Outdated

@wjones127wjones127Apr 7, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I think we can remove this?
@wgtmacwgtmacApr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Fixed
@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Apr 7, 2023
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

mapleFU
mapleFU
reviewed
Apr 8, 2023
View reviewed changes
@mapleFUmapleFU
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Rest LGTM
Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/file_writer.h
Outdated

Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Apr 9, 2023
@wgtmac
wgtmac
requested a review
from wjones127April 10, 2023 01:42
wjones127
wjones127
requested changes
Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
awaiting change review
Awaiting change review
and removed

awaiting change review
Awaiting change review
awaiting changes
Awaiting changes
labels
Apr 10, 2023
@wgtmac
wgtmac
commented
Apr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127
@wgtmac
wgtmac
commented
Apr 11, 2023

Copy link


Copy Markdown

MemberAuthor
https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:
+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac
requested a review
from wjones127April 11, 2023 06:05
wjones127
wjones127
approved these changes
Apr 11, 2023
View reviewed changes
@wjones127wjones127
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!
Comment threadcpp/src/parquet/file_writer.cc
Outdated

@github-actionsgithub-actionsBot
added

awaiting merge
Awaiting merge
and removed

awaiting change review
Awaiting change review
labels
Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac
commented
Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
 public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
@wgtmacwgtmacApr 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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


Suggested change

ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")
Should I change this since it may not be included in the 12.0.0 release? @wjones127
@wjones127
wjones127
merged commit 3bd57e3
into
apache:mainApr 13, 2023
@wjones127
wjones127
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).
@raulcd
raulcd
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
@raulcd would it be possible to add this to the release branch?
I will add it to 12.0.0
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.

Conbench compare runs links:

[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2

[Failed] test-mac-arm

[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x

[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q

Buildkite builds:

[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2

[Failed] 3bd57e35 test-mac-arm

[Finished] 3bd57e35 ursa-i9-9960x

[Finished] 3bd57e35 ursa-thinkcentre-m75q

[Finished] 49631057 ec2-t3-xlarge-us-east-2

[Failed] 49631057 test-mac-arm

[Finished] 49631057 ursa-i9-9960x

[Finished] 49631057 ursa-thinkcentre-m75q

Supported benchmarks:

ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True

test-mac-arm: Supported benchmark langs: C++, Python, R

ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript

ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x
raulcd pushed a commit
that referenced
this pull request
Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit
to LoongArch-Python/arrow
that referenced
this pull request
May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit
to Bit-Quill/arrow
that referenced
this pull request
May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU
mentioned this pull request
May 24, 2024
 Merged

mapleFU added a commit
that referenced
this pull request
Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened


5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889
Merged
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Apr 13, 2023
Merged
GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Conversation
@wgtmac
@wgtmacwgtmac
commented
Apr 4, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
What changes are included in this PR?
Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.
Are these changes tested?
Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.
Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
@wgtmac
wgtmac
requested a review
from wjones127
as a code ownerApril 4, 2023 15:47
@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.
@wgtmac
wgtmacforce-pushed
the
kvmeta
branch
2 times, most recently
from
1748c1f to
c5b322dCompareApril 6, 2023 15:51
@wgtmac
wgtmac
commented
Apr 7, 2023

Copy link


Copy Markdown

MemberAuthor
@wjones127@westonpace Please take a look when you have time. Thanks!
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc
Outdated

@wjones127wjones127Apr 7, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I think we can remove this?
@wgtmacwgtmacApr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Fixed
@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Apr 7, 2023
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

mapleFU
mapleFU
reviewed
Apr 8, 2023
View reviewed changes
@mapleFUmapleFU
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Rest LGTM
Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/file_writer.h
Outdated

Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Apr 9, 2023
@wgtmac
wgtmac
requested a review
from wjones127April 10, 2023 01:42
wjones127
wjones127
requested changes
Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
awaiting change review
Awaiting change review
and removed

awaiting change review
Awaiting change review
awaiting changes
Awaiting changes
labels
Apr 10, 2023
@wgtmac
wgtmac
commented
Apr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127
@wgtmac
wgtmac
commented
Apr 11, 2023

Copy link


Copy Markdown

MemberAuthor
https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:
+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac
requested a review
from wjones127April 11, 2023 06:05
wjones127
wjones127
approved these changes
Apr 11, 2023
View reviewed changes
@wjones127wjones127
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!
Comment threadcpp/src/parquet/file_writer.cc
Outdated

@github-actionsgithub-actionsBot
added

awaiting merge
Awaiting merge
and removed

awaiting change review
Awaiting change review
labels
Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac
commented
Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
 public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
@wgtmacwgtmacApr 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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


Suggested change

ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")
Should I change this since it may not be included in the 12.0.0 release? @wjones127
@wjones127
wjones127
merged commit 3bd57e3
into
apache:mainApr 13, 2023
@wjones127
wjones127
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).
@raulcd
raulcd
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
@raulcd would it be possible to add this to the release branch?
I will add it to 12.0.0
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.

Conbench compare runs links:

[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2

[Failed] test-mac-arm

[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x

[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q

Buildkite builds:

[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2

[Failed] 3bd57e35 test-mac-arm

[Finished] 3bd57e35 ursa-i9-9960x

[Finished] 3bd57e35 ursa-thinkcentre-m75q

[Finished] 49631057 ec2-t3-xlarge-us-east-2

[Failed] 49631057 test-mac-arm

[Finished] 49631057 ursa-i9-9960x

[Finished] 49631057 ursa-thinkcentre-m75q

Supported benchmarks:

ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True

test-mac-arm: Supported benchmark langs: C++, Python, R

ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript

ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x
raulcd pushed a commit
that referenced
this pull request
Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit
to LoongArch-Python/arrow
that referenced
this pull request
May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit
to Bit-Quill/arrow
that referenced
this pull request
May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU
mentioned this pull request
May 24, 2024
 Merged

mapleFU added a commit
that referenced
this pull request
Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened


5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889
Merged
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Apr 13, 2023
Merged
GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Conversation
@wgtmac
@wgtmacwgtmac
commented
Apr 4, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
What changes are included in this PR?
Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.
Are these changes tested?
Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.
Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
@wgtmac
wgtmac
requested a review
from wjones127
as a code ownerApril 4, 2023 15:47
@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.
@wgtmac
wgtmacforce-pushed
the
kvmeta
branch
2 times, most recently
from
1748c1f to
c5b322dCompareApril 6, 2023 15:51
@wgtmac
wgtmac
commented
Apr 7, 2023

Copy link


Copy Markdown

MemberAuthor
@wjones127@westonpace Please take a look when you have time. Thanks!
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc
Outdated

@wjones127wjones127Apr 7, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I think we can remove this?
@wgtmacwgtmacApr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Fixed
@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Apr 7, 2023
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

mapleFU
mapleFU
reviewed
Apr 8, 2023
View reviewed changes
@mapleFUmapleFU
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Rest LGTM
Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/file_writer.h
Outdated

Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Apr 9, 2023
@wgtmac
wgtmac
requested a review
from wjones127April 10, 2023 01:42
wjones127
wjones127
requested changes
Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
awaiting change review
Awaiting change review
and removed

awaiting change review
Awaiting change review
awaiting changes
Awaiting changes
labels
Apr 10, 2023
@wgtmac
wgtmac
commented
Apr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127
@wgtmac
wgtmac
commented
Apr 11, 2023

Copy link


Copy Markdown

MemberAuthor
https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:
+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac
requested a review
from wjones127April 11, 2023 06:05
wjones127
wjones127
approved these changes
Apr 11, 2023
View reviewed changes
@wjones127wjones127
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!
Comment threadcpp/src/parquet/file_writer.cc
Outdated

@github-actionsgithub-actionsBot
added

awaiting merge
Awaiting merge
and removed

awaiting change review
Awaiting change review
labels
Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac
commented
Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
 public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
@wgtmacwgtmacApr 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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


Suggested change

ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")
Should I change this since it may not be included in the 12.0.0 release? @wjones127
@wjones127
wjones127
merged commit 3bd57e3
into
apache:mainApr 13, 2023
@wjones127
wjones127
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).
@raulcd
raulcd
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
@raulcd would it be possible to add this to the release branch?
I will add it to 12.0.0
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.

Conbench compare runs links:

[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2

[Failed] test-mac-arm

[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x

[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q

Buildkite builds:

[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2

[Failed] 3bd57e35 test-mac-arm

[Finished] 3bd57e35 ursa-i9-9960x

[Finished] 3bd57e35 ursa-thinkcentre-m75q

[Finished] 49631057 ec2-t3-xlarge-us-east-2

[Failed] 49631057 test-mac-arm

[Finished] 49631057 ursa-i9-9960x

[Finished] 49631057 ursa-thinkcentre-m75q

Supported benchmarks:

ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True

test-mac-arm: Supported benchmark langs: C++, Python, R

ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript

ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x
raulcd pushed a commit
that referenced
this pull request
Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit
to LoongArch-Python/arrow
that referenced
this pull request
May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit
to Bit-Quill/arrow
that referenced
this pull request
May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU
mentioned this pull request
May 24, 2024
 Merged

mapleFU added a commit
that referenced
this pull request
Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened


5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889
Merged
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Apr 13, 2023
Merged
GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Conversation
@wgtmac
@wgtmacwgtmac
commented
Apr 4, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
What changes are included in this PR?
Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.
Are these changes tested?
Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.
Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
@wgtmac
wgtmac
requested a review
from wjones127
as a code ownerApril 4, 2023 15:47
@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.
@wgtmac
wgtmacforce-pushed
the
kvmeta
branch
2 times, most recently
from
1748c1f to
c5b322dCompareApril 6, 2023 15:51
@wgtmac
wgtmac
commented
Apr 7, 2023

Copy link


Copy Markdown

MemberAuthor
@wjones127@westonpace Please take a look when you have time. Thanks!
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc
Outdated

@wjones127wjones127Apr 7, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I think we can remove this?
@wgtmacwgtmacApr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Fixed
@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Apr 7, 2023
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

mapleFU
mapleFU
reviewed
Apr 8, 2023
View reviewed changes
@mapleFUmapleFU
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Rest LGTM
Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/file_writer.h
Outdated

Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Apr 9, 2023
@wgtmac
wgtmac
requested a review
from wjones127April 10, 2023 01:42
wjones127
wjones127
requested changes
Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
awaiting change review
Awaiting change review
and removed

awaiting change review
Awaiting change review
awaiting changes
Awaiting changes
labels
Apr 10, 2023
@wgtmac
wgtmac
commented
Apr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127
@wgtmac
wgtmac
commented
Apr 11, 2023

Copy link


Copy Markdown

MemberAuthor
https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:
+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac
requested a review
from wjones127April 11, 2023 06:05
wjones127
wjones127
approved these changes
Apr 11, 2023
View reviewed changes
@wjones127wjones127
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!
Comment threadcpp/src/parquet/file_writer.cc
Outdated

@github-actionsgithub-actionsBot
added

awaiting merge
Awaiting merge
and removed

awaiting change review
Awaiting change review
labels
Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac
commented
Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
 public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
@wgtmacwgtmacApr 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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


Suggested change

ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")
Should I change this since it may not be included in the 12.0.0 release? @wjones127
@wjones127
wjones127
merged commit 3bd57e3
into
apache:mainApr 13, 2023
@wjones127
wjones127
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).
@raulcd
raulcd
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
@raulcd would it be possible to add this to the release branch?
I will add it to 12.0.0
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.

Conbench compare runs links:

[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2

[Failed] test-mac-arm

[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x

[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q

Buildkite builds:

[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2

[Failed] 3bd57e35 test-mac-arm

[Finished] 3bd57e35 ursa-i9-9960x

[Finished] 3bd57e35 ursa-thinkcentre-m75q

[Finished] 49631057 ec2-t3-xlarge-us-east-2

[Failed] 49631057 test-mac-arm

[Finished] 49631057 ursa-i9-9960x

[Finished] 49631057 ursa-thinkcentre-m75q

Supported benchmarks:

ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True

test-mac-arm: Supported benchmark langs: C++, Python, R

ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript

ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x
raulcd pushed a commit
that referenced
this pull request
Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit
to LoongArch-Python/arrow
that referenced
this pull request
May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit
to Bit-Quill/arrow
that referenced
this pull request
May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU
mentioned this pull request
May 24, 2024
 Merged

mapleFU added a commit
that referenced
this pull request
Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened


5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889
Merged
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Apr 13, 2023
Merged
GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Conversation
@wgtmac
@wgtmacwgtmac
commented
Apr 4, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
What changes are included in this PR?
Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.
Are these changes tested?
Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.
Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
@wgtmac
wgtmac
requested a review
from wjones127
as a code ownerApril 4, 2023 15:47
@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.
@wgtmac
wgtmacforce-pushed
the
kvmeta
branch
2 times, most recently
from
1748c1f to
c5b322dCompareApril 6, 2023 15:51
@wgtmac
wgtmac
commented
Apr 7, 2023

Copy link


Copy Markdown

MemberAuthor
@wjones127@westonpace Please take a look when you have time. Thanks!
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc
Outdated

@wjones127wjones127Apr 7, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I think we can remove this?
@wgtmacwgtmacApr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Fixed
@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Apr 7, 2023
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

mapleFU
mapleFU
reviewed
Apr 8, 2023
View reviewed changes
@mapleFUmapleFU
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Rest LGTM
Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/file_writer.h
Outdated

Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Apr 9, 2023
@wgtmac
wgtmac
requested a review
from wjones127April 10, 2023 01:42
wjones127
wjones127
requested changes
Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
awaiting change review
Awaiting change review
and removed

awaiting change review
Awaiting change review
awaiting changes
Awaiting changes
labels
Apr 10, 2023
@wgtmac
wgtmac
commented
Apr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127
@wgtmac
wgtmac
commented
Apr 11, 2023

Copy link


Copy Markdown

MemberAuthor
https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:
+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac
requested a review
from wjones127April 11, 2023 06:05
wjones127
wjones127
approved these changes
Apr 11, 2023
View reviewed changes
@wjones127wjones127
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!
Comment threadcpp/src/parquet/file_writer.cc
Outdated

@github-actionsgithub-actionsBot
added

awaiting merge
Awaiting merge
and removed

awaiting change review
Awaiting change review
labels
Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac
commented
Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
 public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
@wgtmacwgtmacApr 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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


Suggested change

ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")
Should I change this since it may not be included in the 12.0.0 release? @wjones127
@wjones127
wjones127
merged commit 3bd57e3
into
apache:mainApr 13, 2023
@wjones127
wjones127
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).
@raulcd
raulcd
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
@raulcd would it be possible to add this to the release branch?
I will add it to 12.0.0
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.

Conbench compare runs links:

[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2

[Failed] test-mac-arm

[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x

[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q

Buildkite builds:

[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2

[Failed] 3bd57e35 test-mac-arm

[Finished] 3bd57e35 ursa-i9-9960x

[Finished] 3bd57e35 ursa-thinkcentre-m75q

[Finished] 49631057 ec2-t3-xlarge-us-east-2

[Failed] 49631057 test-mac-arm

[Finished] 49631057 ursa-i9-9960x

[Finished] 49631057 ursa-thinkcentre-m75q

Supported benchmarks:

ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True

test-mac-arm: Supported benchmark langs: C++, Python, R

ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript

ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x
raulcd pushed a commit
that referenced
this pull request
Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit
to LoongArch-Python/arrow
that referenced
this pull request
May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit
to Bit-Quill/arrow
that referenced
this pull request
May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU
mentioned this pull request
May 24, 2024
 Merged

mapleFU added a commit
that referenced
this pull request
Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened


5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889
Merged
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Apr 13, 2023
Merged
GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Conversation
@wgtmac
@wgtmacwgtmac
commented
Apr 4, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
What changes are included in this PR?
Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.
Are these changes tested?
Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.
Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
@wgtmac
wgtmac
requested a review
from wjones127
as a code ownerApril 4, 2023 15:47
@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.
@wgtmac
wgtmacforce-pushed
the
kvmeta
branch
2 times, most recently
from
1748c1f to
c5b322dCompareApril 6, 2023 15:51
@wgtmac
wgtmac
commented
Apr 7, 2023

Copy link


Copy Markdown

MemberAuthor
@wjones127@westonpace Please take a look when you have time. Thanks!
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc
Outdated

@wjones127wjones127Apr 7, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I think we can remove this?
@wgtmacwgtmacApr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Fixed
@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Apr 7, 2023
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

mapleFU
mapleFU
reviewed
Apr 8, 2023
View reviewed changes
@mapleFUmapleFU
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Rest LGTM
Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/file_writer.h
Outdated

Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Apr 9, 2023
@wgtmac
wgtmac
requested a review
from wjones127April 10, 2023 01:42
wjones127
wjones127
requested changes
Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
awaiting change review
Awaiting change review
and removed

awaiting change review
Awaiting change review
awaiting changes
Awaiting changes
labels
Apr 10, 2023
@wgtmac
wgtmac
commented
Apr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127
@wgtmac
wgtmac
commented
Apr 11, 2023

Copy link


Copy Markdown

MemberAuthor
https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:
+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac
requested a review
from wjones127April 11, 2023 06:05
wjones127
wjones127
approved these changes
Apr 11, 2023
View reviewed changes
@wjones127wjones127
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!
Comment threadcpp/src/parquet/file_writer.cc
Outdated

@github-actionsgithub-actionsBot
added

awaiting merge
Awaiting merge
and removed

awaiting change review
Awaiting change review
labels
Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac
commented
Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
 public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
@wgtmacwgtmacApr 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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


Suggested change

ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")
Should I change this since it may not be included in the 12.0.0 release? @wjones127
@wjones127
wjones127
merged commit 3bd57e3
into
apache:mainApr 13, 2023
@wjones127
wjones127
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).
@raulcd
raulcd
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
@raulcd would it be possible to add this to the release branch?
I will add it to 12.0.0
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.

Conbench compare runs links:

[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2

[Failed] test-mac-arm

[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x

[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q

Buildkite builds:

[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2

[Failed] 3bd57e35 test-mac-arm

[Finished] 3bd57e35 ursa-i9-9960x

[Finished] 3bd57e35 ursa-thinkcentre-m75q

[Finished] 49631057 ec2-t3-xlarge-us-east-2

[Failed] 49631057 test-mac-arm

[Finished] 49631057 ursa-i9-9960x

[Finished] 49631057 ursa-thinkcentre-m75q

Supported benchmarks:

ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True

test-mac-arm: Supported benchmark langs: C++, Python, R

ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript

ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x
raulcd pushed a commit
that referenced
this pull request
Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit
to LoongArch-Python/arrow
that referenced
this pull request
May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit
to Bit-Quill/arrow
that referenced
this pull request
May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU
mentioned this pull request
May 24, 2024
 Merged

mapleFU added a commit
that referenced
this pull request
Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened


5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
GH-34888: [C++][Parquet] Writer supports adding extra kv meta - #34889
Merged
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Apr 13, 2023
Merged
GH-34888: [C++][Parquet] Writer supports adding extra kv meta#34889
wjones127 merged 5 commits into
apache:mainfrom 
wgtmac:kvmeta
Conversation
@wgtmac
@wgtmacwgtmac
commented
Apr 4, 2023•

edited by github-actions
Bot
Loading

Copy link


Copy Markdown

Member
Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
What changes are included in this PR?
Add a new interface void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata) to the ParquetFileWriter class. User can now add more key-value metadata to the file if not closed.
Are these changes tested?
Added a new Metadata.TestAddKeyValueMetadata test to verify key-value metadata added before closing the writer are well preserved.
Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
@wgtmac
wgtmac
requested a review
from wjones127
as a code ownerApril 4, 2023 15:47
@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

@github-actions
github-actionsBot
commented
Apr 4, 2023

Copy link


Copy Markdown

⚠️ GitHub issue #34888has been automatically assigned in GitHub to PR creator.
@wgtmac
wgtmacforce-pushed
the
kvmeta
branch
2 times, most recently
from
1748c1f to
c5b322dCompareApril 6, 2023 15:51
@wgtmac
wgtmac
commented
Apr 7, 2023

Copy link


Copy Markdown

MemberAuthor
@wjones127@westonpace Please take a look when you have time. Thanks!
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.cc
Outdated

@wjones127wjones127Apr 7, 2023

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I think we can remove this?
@wgtmacwgtmacApr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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

Fixed
@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
and removed

awaiting review
Awaiting review
labels
Apr 7, 2023
wjones127
wjones127
reviewed
Apr 7, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

mapleFU
mapleFU
reviewed
Apr 8, 2023
View reviewed changes
@mapleFUmapleFU
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Rest LGTM
Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/file_writer.h
Outdated

Comment threadcpp/src/parquet/file_writer.cc
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting change review
Awaiting change review
and removed

awaiting changes
Awaiting changes
labels
Apr 9, 2023
@wgtmac
wgtmac
requested a review
from wjones127April 10, 2023 01:42
wjones127
wjones127
requested changes
Apr 10, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
Outdated

Comment threadcpp/src/parquet/metadata.h
Outdated

@github-actionsgithub-actionsBot
added

awaiting changes
Awaiting changes
awaiting change review
Awaiting change review
and removed

awaiting change review
Awaiting change review
awaiting changes
Awaiting changes
labels
Apr 10, 2023
@wgtmac
wgtmac
commented
Apr 10, 2023

Copy link


Copy Markdown

MemberAuthor
Fixed it to be backward compatible. Please take a look again. Thanks! @wjones127
@wgtmac
wgtmac
commented
Apr 11, 2023

Copy link


Copy Markdown

MemberAuthor
https://github.com/apache/arrow/actions/runs/4662936307/jobs/8253813543?pr=34889 is failing:
+ doxygen
/arrow/cpp/apidoc /
warning: Tag 'OUTPUT_TEXT_DIRECTION' at line 119 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'COLS_IN_ALPHA_INDEX' at line 1118 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'FORMULA_TRANSPARENT' at line 1557 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'LATEX_SOURCE_CODE' at line 1865 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'RTF_SOURCE_CODE' at line 1955 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOCBOOK_PROGRAMLISTING' at line 2060 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'CLASS_DIAGRAMS' at line 2257 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTNAME' at line 2299 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_FONTSIZE' at line 2306 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
warning: Tag 'DOT_TRANSPARENT' at line 2530 of file 'Doxyfile' has become obsolete.
To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
/arrow/cpp/src/parquet/metadata.h:531: error: Found ';' while parsing initializer list! (doxygen could be confused by a macro call without semicolon) (warning treated as error, aborting now)
1
Error: `docker-compose --file /home/runner/work/arrow/arrow/docker-compose.yml run --rm conda-python-docs` exited with a non-zero exit code 1, see the process log above.

@wgtmac
wgtmac
requested a review
from wjones127April 11, 2023 06:05
wjones127
wjones127
approved these changes
Apr 11, 2023
View reviewed changes
@wjones127wjones127
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

Just one minor comment, otherwise looks good!
Comment threadcpp/src/parquet/file_writer.cc
Outdated

@github-actionsgithub-actionsBot
added

awaiting merge
Awaiting merge
and removed

awaiting change review
Awaiting change review
labels
Apr 11, 2023
@wgtmac@wjones127
Update cpp/src/parquet/file_writer.cc
5e5a39c
Co-authored-by: Will Jones <willjones127@gmail.com>
wgtmac
wgtmac
commented
Apr 12, 2023
View reviewed changes
Comment threadcpp/src/parquet/metadata.h
class PARQUET_EXPORT FileMetaDataBuilder {
 public:
// API convenience to get a MetaData reader
ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
@wgtmacwgtmacApr 12, 2023

Copy link


Copy Markdown

MemberAuthor
Choose a reason for hiding this comment

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


Suggested change

ARROW_DEPRECATED("Deprecated in 12.0.0. Use overload without KeyValueMetadata instead.")
ARROW_DEPRECATED("Deprecated in 13.0.0. Use overload without KeyValueMetadata instead.")
Should I change this since it may not be included in the 12.0.0 release? @wjones127
@wjones127
wjones127
merged commit 3bd57e3
into
apache:mainApr 13, 2023
@wjones127
wjones127
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
I merged this and then realized I have just missed the window for 12.0.0. @raulcd would it be possible to add this to the release branch? Otherwise I'll put up a PR to adjust the text of the deprecation warning added in this PR (which says a method was deprecated in 12.0.0).
@raulcd
raulcd
commented
Apr 13, 2023

Copy link


Copy Markdown

Member
@raulcd would it be possible to add this to the release branch?
I will add it to 12.0.0
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

Benchmark runs are scheduled for baseline = 4963105 and contender = 3bd57e3. 3bd57e3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.

Conbench compare runs links:

[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2

[Failed] test-mac-arm

[Finished ⬇️20.92% ⬆️1.53%] ursa-i9-9960x

[Finished ⬇️1.11% ⬆️0.12%] ursa-thinkcentre-m75q

Buildkite builds:

[Finished] 3bd57e35 ec2-t3-xlarge-us-east-2

[Failed] 3bd57e35 test-mac-arm

[Finished] 3bd57e35 ursa-i9-9960x

[Finished] 3bd57e35 ursa-thinkcentre-m75q

[Finished] 49631057 ec2-t3-xlarge-us-east-2

[Failed] 49631057 test-mac-arm

[Finished] 49631057 ursa-i9-9960x

[Finished] 49631057 ursa-thinkcentre-m75q

Supported benchmarks:

ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True

test-mac-arm: Supported benchmark langs: C++, Python, R

ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript

ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
@ursabot
ursabot
commented
Apr 15, 2023

Copy link


Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x
raulcd pushed a commit
that referenced
this pull request
Apr 17, 2023
@wgtmac@wjones127@raulcd
GH-34888: [C++][Parquet] Writer supports adding extra kv meta (#34889)
6dd95ee
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: #34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
liujiacheng777 pushed a commit
to LoongArch-Python/arrow
that referenced
this pull request
May 11, 2023
@wgtmac@wjones127@liujiacheng777
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
0ed52bb
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
ArgusLi pushed a commit
to Bit-Quill/arrow
that referenced
this pull request
May 15, 2023
@wgtmac@wjones127@ArgusLi
apacheGH-34888: [C++][Parquet] Writer supports adding extra kv meta (a…
f6f887f
…pache#34889)
### Rationale for this change
Parquet specs support storing key-value metadata provided by the user. However, the parquet-cpp writer can only set it via ParquetFileWriter::Open(). Sometimes user may want to add extra information to it while writing. So it is good to support adding extra key-value metadata any time before closing the file writer.
### What changes are included in this PR?
Add a new interface `void AddKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata)` to the `ParquetFileWriter` class. User can now add more key-value metadata to the file if not closed.
### Are these changes tested?
Added a new `Metadata.TestAddKeyValueMetadata` test to verify key-value metadata added before closing the writer are well preserved.
### Are there any user-facing changes?
Yes, user can add custom key-value metadata whenever writer is not closed.
* Closes: apache#34888
Lead-authored-by: Gang Wu <ustcwg@gmail.com>
Co-authored-by: Will Jones <willjones127@gmail.com>
Signed-off-by: Will Jones <willjones127@gmail.com>
@mapleFUmapleFU
mentioned this pull request
May 24, 2024
 Merged

mapleFU added a commit
that referenced
this pull request
Jun 4, 2024
@mapleFU
GH-41608: [C++][Python] Extends the add_key_value to parquet::arrow a…
d02a91b
…nd PyArrow (#41633)
### Rationale for this change
The previous pr ( #34889 ) add a `AddKeyValueMetadata` to FileWriter. And now we should export it to Parquet Arrow and Python API.
### What changes are included in this PR?
1. Add `AddKeyValueMetadata` in parquet::arrow
2. Add `add_key_value_metadata` in pyarrow
3. testing
### Are these changes tested?
Yes
### Are there any user-facing changes?
New api allowing add key-value metadata to Parquet file
* GitHub Issue: #41608
Authored-by: mwish <maplewish117@gmail.com>
Signed-off-by: mwish <maplewish117@gmail.com>
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@mapleFUmapleFUmapleFU left review comments
@wjones127wjones127wjones127 approved these changes

Assignees


No one assigned


Labels

awaiting mergeAwaiting mergeComponent: C++Component: Parquet

Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

[C++][Parquet] Writer cannot add extra key-value metadata once opened


5 participants

@wgtmac@wjones127@raulcd@ursabot@mapleFU