incubator-xtable icon indicating copy to clipboard operation
incubator-xtable copied to clipboard

[Module] Optimize the module structure of the xtable

Open daragu opened this issue 1 month ago • 1 comments

Important Read

Fixed #435.

What is the purpose of the pull request

  1. For mvn projects, add same prefix to sub modules is friendly for developers.
  • Development best practices: it is impossible to deploy two modules having the same name. To avoid this kind of conflict, we recommend to prefix all modules of a project by a common key referring to the project (example : "xtable-aaa, xtable-bbb").
  • After this modification, developers can quickly determine which folders in this project are submodules and which folders are regular folders by using the prefix of the folder e.g
    • https://github.com/apache/flink
    • https://github.com/apache/hudi
    • https://github.com/apache/paimon
    • https://github.com/spring-projects/spring-framework

  1. For Xtable project users

From the official docs, user will use utilities/target/utilities-0.1.0-SNAPSHOT-bundled.jar to convert data lake formats

java -jar utilities/target/utilities-0.1.0-SNAPSHOT-bundled.jar --datasetConfig my_config.yaml

The name utilities-0.1.0-SNAPSHOT-bundled.jar does not have recognizability. The new name xtable-utilities-0.1.0-SNAPSHOT-bundled.jar is more recognizable.

Brief change log

Optimize the module structure of the xtable

  • add same prefix to sub modules
  • let the folder name of the module to match the artifactId

Changes

  • api -> xtable-api
  • core -> xtable-core
  • hudi-support -> xtable-hudi-support
  • utilities -> xtable-utilities

图片

Verify this pull request

Local build and test.

daragu avatar May 15 '24 01:05 daragu