This is an automated email from the ASF dual-hosted git repository.
emkornfield pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/parquet-java.git
The following commit(s) were added to refs/heads/master by this push:
new bc603e994 PARQUET-2483: Update references to parquet-mr in Readmes
bc603e994 is described below
commit bc603e9948a7783e8a5b1a1221b980dc97a4c4fe
Author: emkornfield <[email protected]>
AuthorDate: Wed Jun 12 08:34:06 2024 +0000
PARQUET-2483: Update references to parquet-mr in Readmes
Make sure you have checked _all_ steps below.
### Jira
- [x ] My PR addresses the following [Parquet
Jira](https://issues.apache.org/jira/browse/PARQUET/) issues and references
them in the PR title. For example, "PARQUET-1234: My Parquet PR"
- https://issues.apache.org/jira/browse/PARQUET-XXX
- In case you are adding a dependency, check if the license complies
with
the [ASF 3rd Party License
Policy](https://www.apache.org/legal/resolved.html#category-x).
### Tests
- [x ] My PR adds the following unit tests __OR__ does not need testing for
this extremely good reason:
### Commits
- [x ] My commits all reference Jira issues in their subject lines. In
addition, my commits follow the guidelines
from "[How to write a good git commit
message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue
reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Style
- [x ] My contribution adheres to the code style guidelines and Spotless
passes.
- To apply the necessary changes, run `mvn spotless:apply
-Pvector-plugins`
### Documentation
- [x ] In case of new functionality, my PR adds documentation that
describes how to use it.
- All the public functions and the classes in the PR contain Javadoc
that explain what it does
Author: emkornfield <[email protected]>
Author: Fokko Driesprong <[email protected]>
Closes #1358 from emkornfield/master and squashes the following commits:
ac0ce36e [Fokko Driesprong] Fix casing
1935b31f [emkornfield] Update Readme
58581828 [emkornfield] Update top level readme as well
d624144e [emkornfield] PARQUET-2483: Update references to parquet-mr in dev
script directory
---
README.md | 32 ++++++++++++++++----------------
dev/README.md | 14 +++++++-------
2 files changed, 23 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 2d834e469..c7a09c7cf 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@
~ under the License.
-->
-Parquet MR [](https://github.com/apache/parquet-mr/actions)
+Parquet Java (formerly Parquet MR) [](https://github.com/apache/parquet-java/actions)
======
This repository contains a Java implementation of [Apache
Parquet](https://parquet.apache.org/)
@@ -36,7 +36,7 @@ You can find additional details about the format and intended
use cases in our [
## Building
-Parquet-MR uses Maven to build and depends on the thrift compiler (protoc is
now managed by maven plugin).
+Parquet-Java uses Maven to build and depends on the thrift compiler (protoc is
now managed by maven plugin).
### Install Thrift
@@ -95,7 +95,7 @@ Parquet is a very active project, and new features are being
added quickly. Here
## Java Vector API support
`The feature is experimental and is currently not part of the parquet
distribution`.
-Parquet-MR has supported Java Vector API to speed up reading, to enable this
feature:
+Parquet-Java has supported Java Vector API to speed up reading, to enable this
feature:
* Java 17+, 64-bit
* Requiring the CPU to support instruction sets:
* avx512vbmi
@@ -109,30 +109,30 @@ Parquet-MR has supported Java Vector API to speed up
reading, to enable this fea
## Map/Reduce integration
-[Input](https://github.com/apache/parquet-mr/blob/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/ParquetInputFormat.java)
and
[Output](https://github.com/apache/parquet-mr/blob/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/ParquetOutputFormat.java)
formats.
+[Input](https://github.com/apache/parquet-java/blob/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/ParquetInputFormat.java)
and
[Output](https://github.com/apache/parquet-java/blob/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/ParquetOutputFormat.java)
formats.
Note that to use an Input or Output format, you need to implement a
WriteSupport or ReadSupport class, which will implement the conversion of your
object to and from a Parquet schema.
We've implemented this for 2 popular data formats to provide a clean migration
path as well:
### Thrift
-Thrift integration is provided by the
[parquet-thrift](https://github.com/apache/parquet-mr/tree/master/parquet-thrift)
sub-project.
+Thrift integration is provided by the
[parquet-thrift](https://github.com/apache/parquet-java/tree/master/parquet-thrift)
sub-project.
### Avro
-Avro conversion is implemented via the
[parquet-avro](https://github.com/apache/parquet-mr/tree/master/parquet-avro)
sub-project.
+Avro conversion is implemented via the
[parquet-avro](https://github.com/apache/parquet-java/tree/master/parquet-avro)
sub-project.
### Protobuf
-Protobuf conversion is implemented via the
[parquet-protobuf](https://github.com/apache/parquet-mr/tree/master/parquet-protobuf)
sub-project.
+Protobuf conversion is implemented via the
[parquet-protobuf](https://github.com/apache/parquet-java/tree/master/parquet-protobuf)
sub-project.
### Create your own objects
* The ParquetOutputFormat can be provided a WriteSupport to write your own
objects to an event based RecordConsumer.
* the ParquetInputFormat can be provided a ReadSupport to materialize your own
objects by implementing a RecordMaterializer
See the APIs:
-* [Record conversion
API](https://github.com/apache/parquet-mr/tree/master/parquet-column/src/main/java/org/apache/parquet/io/api)
-* [Hadoop
API](https://github.com/apache/parquet-mr/tree/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/api)
+* [Record conversion
API](https://github.com/apache/parquet-java/tree/master/parquet-column/src/main/java/org/apache/parquet/io/api)
+* [Hadoop
API](https://github.com/apache/parquet-java/tree/master/parquet-hadoop/src/main/java/org/apache/parquet/hadoop/api)
## Apache Pig integration
-A
[Loader](https://github.com/apache/parquet-mr/blob/master/parquet-pig/src/main/java/org/apache/parquet/pig/ParquetLoader.java)
and a
[Storer](https://github.com/apache/parquet-mr/blob/master/parquet-pig/src/main/java/org/apache/parquet/pig/ParquetStorer.java)
are provided to read and write Parquet files with Apache Pig
+A
[Loader](https://github.com/apache/parquet-java/blob/master/parquet-pig/src/main/java/org/apache/parquet/pig/ParquetLoader.java)
and a
[Storer](https://github.com/apache/parquet-java/blob/master/parquet-pig/src/main/java/org/apache/parquet/pig/ParquetStorer.java)
are provided to read and write Parquet files with Apache Pig
Storing data into Parquet in Pig is simple:
```
@@ -151,7 +151,7 @@ If the data was stored using Pig, things will "just work".
If the data was store
## Hive integration
-Hive integration is provided via the
[parquet-hive](https://github.com/apache/parquet-mr/tree/master/parquet-hive)
sub-project.
+Hive integration is provided via the
[parquet-hive](https://github.com/apache/parquet-java/tree/master/parquet-hive)
sub-project.
Hive integration is now deprecated within the Parquet project. It is now
maintained by Apache Hive.
@@ -161,8 +161,8 @@ To run the unit tests: `mvn test`
To build the jars: `mvn package`
-The build runs in [GitHub
Actions](https://github.com/apache/parquet-mr/actions):
-[](https://github.com/apache/parquet-mr/actions)
+The build runs in [GitHub
Actions](https://github.com/apache/parquet-java/actions):
+[](https://github.com/apache/parquet-java/actions)
## Add Parquet as a dependency in Maven
@@ -195,7 +195,7 @@ The current release is version `1.14.0`
### How To Contribute
-We prefer to receive contributions in the form of GitHub pull requests. Please
send pull requests against the
[parquet-mr](https://github.com/apache/parquet-mr) Git repository. If you've
previously forked Parquet from its old location, you will need to add a remote
or update your origin remote to https://github.com/apache/parquet-mr.git
+We prefer to receive contributions in the form of GitHub pull requests. Please
send pull requests against the
[parquet-java](https://github.com/apache/parquet-java) Git repository. If
you've previously forked Parquet from its old location, you will need to add a
remote or update your origin remote to
https://github.com/apache/parquet-java.git
If you are looking for some ideas on what to contribute, check out jira issues
for this project labeled
["pick-me-up"](https://issues.apache.org/jira/browse/PARQUET-5?jql=project%20%3D%20PARQUET%20and%20labels%20%3D%20pick-me-up%20and%20status%20%3D%20open).
Comment on the issue and/or contact
[[email protected]](http://mail-archives.apache.org/mod_mbox/parquet-dev/)
with your questions and ideas.
@@ -206,7 +206,7 @@ To contribute a patch:
1. Break your work into small, single-purpose patches if possible. It’s much
harder to merge in a large change with a lot of disjoint features.
2. Create a JIRA for your patch on the [Parquet Project
JIRA](https://issues.apache.org/jira/browse/PARQUET).
- 3. Submit the patch as a GitHub pull request against the master branch. For
a tutorial, see the GitHub guides on forking a repo and sending a pull request.
Prefix your pull request name with the JIRA name (ex:
https://github.com/apache/parquet-mr/pull/240).
+ 3. Submit the patch as a GitHub pull request against the master branch. For
a tutorial, see the GitHub guides on forking a repo and sending a pull request.
Prefix your pull request name with the JIRA name (ex:
https://github.com/apache/parquet-java/pull/240).
4. Make sure that your code passes the unit tests. You can run the tests
with `mvn test` in the root directory.
5. Add new unit tests for your code.
@@ -220,7 +220,7 @@ Thank you for getting involved!
## Authors and contributors
-* [Contributors](https://github.com/apache/parquet-mr/graphs/contributors)
+* [Contributors](https://github.com/apache/parquet-java/graphs/contributors)
* [Committers](dev/COMMITTERS.md)
## Code of Conduct
diff --git a/dev/README.md b/dev/README.md
index b984b117a..68fe99c56 100644
--- a/dev/README.md
+++ b/dev/README.md
@@ -26,8 +26,8 @@ Merging a pull request requires being a committer on the
project.
* How to merge a Pull request:
have an apache and apache-github remote setup
```
-git remote add apache-github https://github.com/apache/parquet-mr.git
-git remote add apache https://gitbox.apache.org/repos/asf?p=parquet-mr.git
+git remote add apache-github https://github.com/apache/parquet-java.git
+git remote add apache https://gitbox.apache.org/repos/asf?p=parquet-java.git
```
run the following command
```
@@ -35,26 +35,26 @@ dev/merge_parquet_pr.py
```
Note:
-* The parent directory of your parquet repository must be called parquet-mr
+* The parent directory of your parquet repository must be called parquet-java
* Without jira-python installed you'll have to close the JIRA manually
example output:
```
Which pull request would you like to merge? (e.g. 34):
```
-Type the pull request number (from https://github.com/apache/parquet-mr/pulls)
and hit enter.
+Type the pull request number (from
https://github.com/apache/parquet-java/pulls) and hit enter.
```
=== Pull Request #X ===
title Blah Blah Blah
source repo/branch
target master
-url https://api.github.com/repos/apache/parquet-mr/pulls/X
+url https://api.github.com/repos/apache/parquet-java/pulls/X
Proceed with merging pull request #3? (y/n):
```
If this looks good, type y and hit enter.
```
-From git-wip-us.apache.org:/repos/asf/parquet-mr.git
+From git-wip-us.apache.org:/repos/asf/parquet-java.git
* [new branch] master -> PR_TOOL_MERGE_PR_3_MASTER
Switched to branch 'PR_TOOL_MERGE_PR_3_MASTER'
@@ -68,7 +68,7 @@ Delta compression using up to 4 threads.
Compressing objects: 100% (26/26), done.
Writing objects: 100% (36/36), 5.32 KiB, done.
Total 36 (delta 17), reused 0 (delta 0)
-To git-wip-us.apache.org:/repos/asf/parquet-mr.git
+To git-wip-us.apache.org:/repos/asf/parquet-java.git
b767ac4..485658a PR_TOOL_MERGE_PR_X_MASTER -> master
Restoring head pointer to b767ac4e
Note: checking out 'b767ac4e'.
