Skip to content

Restructure the directory and package name for persistence modules #1724

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 2, 2025
Merged

Restructure the directory and package name for persistence modules #1724

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2801c7
Refactor two persistence modules
May 29, 2025
4ede386
Remove the extension prefix for two persistence modules
May 29, 2025
8f71e59
md link check directory change
May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/check-md-link.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ jobs:
with:
use-quiet-mode: 'yes'
config-file: '.github/workflows/check-md-link-config.json'
folder-path: 'regtests, .github, build-logic, polaris-core, service, quarkus, extension, spec, k8, getting-started, helm'
folder-path: 'regtests, .github, build-logic, polaris-core, service, quarkus, persistence, spec, k8, getting-started, helm'
file-path: 'CHAT_BYLAWS.md, CODE_OF_CONDUCT.md, CONTRIBUTING.md, README.md, SECURITY.md'
4 changes: 2 additions & 2 deletions gradle/projects.main.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ polaris-quarkus-spark-tests=quarkus/spark-tests
polaris-quarkus-admin=quarkus/admin
polaris-quarkus-common=quarkus/common
polaris-quarkus-test-commons=quarkus/test-commons
polaris-eclipselink=extension/persistence/eclipselink
polaris-relational-jdbc=extension/persistence/relational-jdbc
polaris-eclipselink=persistence/eclipselink
polaris-relational-jdbc=persistence/relational-jdbc
polaris-tests=integration-tests
aggregated-license-report=aggregated-license-report
polaris-immutables=tools/immutables
Expand Down
0 .../persistence/eclipselink/build.gradle.kts → persistence/eclipselink/build.gradle.kts
View file
Open in desktop
File renamed without changes.
0 ...eclipselink/EclipseLinkConfiguration.java → ...eclipselink/EclipseLinkConfiguration.java
View file
Open in desktop
File renamed without changes.
0 ...seLinkPolarisMetaStoreManagerFactory.java → ...seLinkPolarisMetaStoreManagerFactory.java
View file
Open in desktop
File renamed without changes.
0 ...EclipseLinkProductionReadinessChecks.java → ...EclipseLinkProductionReadinessChecks.java
View file
Open in desktop
File renamed without changes.
0 ...larisEclipseLinkMetaStoreSessionImpl.java → ...larisEclipseLinkMetaStoreSessionImpl.java
View file
Open in desktop
File renamed without changes.
0 ...nk/PolarisEclipseLinkPersistenceUnit.java → ...nk/PolarisEclipseLinkPersistenceUnit.java
View file
Open in desktop
File renamed without changes.
0 .../PolarisEclipseLinkSessionCustomizer.java → .../PolarisEclipseLinkSessionCustomizer.java
View file
Open in desktop
File renamed without changes.
0 .../eclipselink/PolarisEclipseLinkStore.java → .../eclipselink/PolarisEclipseLinkStore.java
View file
Open in desktop
File renamed without changes.
0 ...impl/eclipselink/PolarisSequenceUtil.java → ...impl/eclipselink/PolarisSequenceUtil.java
View file
Open in desktop
File renamed without changes.
0 .../impl/eclipselink/models/ModelEntity.java → .../impl/eclipselink/models/ModelEntity.java
View file
Open in desktop
File renamed without changes.
0 ...eclipselink/models/ModelEntityActive.java → ...eclipselink/models/ModelEntityActive.java
View file
Open in desktop
File renamed without changes.
0 ...ink/models/ModelEntityChangeTracking.java → ...ink/models/ModelEntityChangeTracking.java
View file
Open in desktop
File renamed without changes.
0 .../eclipselink/models/ModelGrantRecord.java → .../eclipselink/models/ModelGrantRecord.java
View file
Open in desktop
File renamed without changes.
0 ...link/models/ModelPolicyMappingRecord.java → ...link/models/ModelPolicyMappingRecord.java
View file
Open in desktop
File renamed without changes.
0 ...pselink/models/ModelPrincipalSecrets.java → ...pselink/models/ModelPrincipalSecrets.java
View file
Open in desktop
File renamed without changes.
0 ...l/eclipselink/models/ModelSequenceId.java → ...l/eclipselink/models/ModelSequenceId.java
View file
Open in desktop
Copy link
Contributor

@dimas-b dimas-b May 29, 2025

Choose a reason for hiding this comment

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

Why do we move to a different package in other classes, but keep package org.apache.polaris.extension.persistence.... here?

Copy link
Contributor Author

@flyrain flyrain May 29, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

This was intended to not change the package name for the module eclipse link. Two reasons:

  1. It's deprecated, will be removed later. We should be fine with the temporary name inconsistency.
  2. It has been used by certain OSS users already. Changing the package name may break downstream, esp. for users who adopted EclipseLink with some customizations.

Copy link
Contributor

@dimas-b dimas-b May 31, 2025

Choose a reason for hiding this comment

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

Fair enough... although, I guess the deeper implication is that we probably need to documents at some point what modules/classes downstream projects should expect to be "stable" what what is "subject to change without notice".

Without defining that across the whole Polaris codebase if would be pretty much impossible to have a common understanding among committers what to flag as compatibility issues in reviews and what is ok 🤔

Copy link
Contributor Author

@flyrain flyrain Jun 1, 2025

Choose a reason for hiding this comment

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

That's a good point. We need to be careful about REST API compatibility for sure. But I don't worry too much about the Java APIs, as Polaris is a server rather than a lib or libs. I think we still need to make sure certain level of compatibilities, like public methods in the core module, esp. things like event listener APIs, etc. Feel free to propose something.

Copy link
Contributor

@adutra adutra Jun 2, 2025

Choose a reason for hiding this comment

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

I think we still need at least some degree of guarantee for Java APIs as well. There are a few vendors integrating Polaris in their own offerings, and a change in public method in any service module (not only core) may create problems downstream. Configuration changes are another area where some guarantees should exist.

That said, I also think that until we get to 1.0.0, any changes should be allowed as long as they are clearly communicated. So for now I'm OK with the proposed refactoring here.

Copy link
Contributor Author

@flyrain flyrain Jun 2, 2025

Choose a reason for hiding this comment

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

Good point, @adutra! The API interface scope worths separated discussion in the dev ML. Let's move on with a dedicated discussion.

File renamed without changes.
0 ...c/main/resources/META-INF/persistence.xml → ...c/main/resources/META-INF/persistence.xml
View file
Open in desktop
File renamed without changes.
0 ...larisEclipseLinkMetaStoreManagerTest.java → ...larisEclipseLinkMetaStoreManagerTest.java
View file
Open in desktop
File renamed without changes.
0 ...sistence/relational-jdbc/build.gradle.kts → persistence/relational-jdbc/build.gradle.kts
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...istence/relational/jdbc/DatabaseType.java → ...istence/relational/jdbc/DatabaseType.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import java.util.Locale;

Expand Down
4 changes: 2 additions & 2 deletions ...relational/jdbc/DatasourceOperations.java → ...relational/jdbc/DatasourceOperations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import static java.nio.charset.StandardCharsets.UTF_8;

Expand All @@ -39,7 +39,7 @@
import java.util.stream.Stream;
import javax.sql.DataSource;
import org.apache.polaris.core.persistence.EntityAlreadyExistsException;
import org.apache.polaris.extension.persistence.relational.jdbc.models.Converter;
import org.apache.polaris.persistence.relational.jdbc.models.Converter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down
2 changes: 1 addition & 1 deletion ...sistence/relational/jdbc/IdGenerator.java → ...sistence/relational/jdbc/IdGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import java.security.SecureRandom;

Expand Down
12 changes: 6 additions & 6 deletions ...ational/jdbc/JdbcBasePersistenceImpl.java → ...ational/jdbc/JdbcBasePersistenceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import static org.apache.polaris.extension.persistence.relational.jdbc.QueryGenerator.*;
import static org.apache.polaris.persistence.relational.jdbc.QueryGenerator.*;

import com.google.common.base.Preconditions;
import jakarta.annotation.Nonnull;
Expand Down Expand Up @@ -57,10 +57,10 @@
import org.apache.polaris.core.storage.PolarisStorageConfigurationInfo;
import org.apache.polaris.core.storage.PolarisStorageIntegration;
import org.apache.polaris.core.storage.PolarisStorageIntegrationProvider;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelEntity;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelGrantRecord;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelPolicyMappingRecord;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData;
import org.apache.polaris.persistence.relational.jdbc.models.ModelEntity;
import org.apache.polaris.persistence.relational.jdbc.models.ModelGrantRecord;
import org.apache.polaris.persistence.relational.jdbc.models.ModelPolicyMappingRecord;
import org.apache.polaris.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand Down
2 changes: 1 addition & 1 deletion ...nal/jdbc/JdbcMetaStoreManagerFactory.java → ...nal/jdbc/JdbcMetaStoreManagerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import io.smallrye.common.annotation.Identifier;
import jakarta.annotation.Nullable;
Expand Down
12 changes: 6 additions & 6 deletions ...tence/relational/jdbc/QueryGenerator.java → ...tence/relational/jdbc/QueryGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import com.google.common.annotations.VisibleForTesting;
import jakarta.annotation.Nonnull;
Expand All @@ -29,11 +29,11 @@
import org.apache.polaris.core.entity.PolarisEntityId;
import org.apache.polaris.core.entity.PolarisEntityType;
import org.apache.polaris.core.policy.PolicyEntity;
import org.apache.polaris.extension.persistence.relational.jdbc.models.Converter;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelEntity;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelGrantRecord;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelPolicyMappingRecord;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData;
import org.apache.polaris.persistence.relational.jdbc.models.Converter;
import org.apache.polaris.persistence.relational.jdbc.models.ModelEntity;
import org.apache.polaris.persistence.relational.jdbc.models.ModelGrantRecord;
import org.apache.polaris.persistence.relational.jdbc.models.ModelPolicyMappingRecord;
import org.apache.polaris.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData;

public class QueryGenerator {

Expand Down
2 changes: 1 addition & 1 deletion ...nal/jdbc/RelationalJdbcConfiguration.java → ...nal/jdbc/RelationalJdbcConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import java.util.Optional;

Expand Down
2 changes: 1 addition & 1 deletion ...ationalJdbcProductionReadinessChecks.java → ...ationalJdbcProductionReadinessChecks.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* under the License.
*/

package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import jakarta.enterprise.context.ApplicationScoped;
import jakarta.enterprise.inject.Produces;
Expand Down
4 changes: 2 additions & 2 deletions ...ce/relational/jdbc/ResultSetIterator.java → ...ce/relational/jdbc/ResultSetIterator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import java.sql.ResultSet;
import java.sql.SQLException;
Expand All @@ -26,7 +26,7 @@
import java.util.Spliterators;
import java.util.stream.Stream;
import java.util.stream.StreamSupport;
import org.apache.polaris.extension.persistence.relational.jdbc.models.Converter;
import org.apache.polaris.persistence.relational.jdbc.models.Converter;

/**
* Used to wrap a ResultSet and to build a stream from the data it contains. This data structure
Expand Down
2 changes: 1 addition & 1 deletion ...nce/relational/jdbc/models/Converter.java → ...nce/relational/jdbc/models/Converter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc.models;
package org.apache.polaris.persistence.relational.jdbc.models;

import java.sql.ResultSet;
import java.sql.SQLException;
Expand Down
2 changes: 1 addition & 1 deletion ...e/relational/jdbc/models/ModelEntity.java → ...e/relational/jdbc/models/ModelEntity.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc.models;
package org.apache.polaris.persistence.relational.jdbc.models;

import java.sql.ResultSet;
import java.sql.SQLException;
Expand Down
2 changes: 1 addition & 1 deletion ...ational/jdbc/models/ModelGrantRecord.java → ...ational/jdbc/models/ModelGrantRecord.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc.models;
package org.apache.polaris.persistence.relational.jdbc.models;

import java.sql.ResultSet;
import java.sql.SQLException;
Expand Down
2 changes: 1 addition & 1 deletion ...jdbc/models/ModelPolicyMappingRecord.java → ...jdbc/models/ModelPolicyMappingRecord.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc.models;
package org.apache.polaris.persistence.relational.jdbc.models;

import java.sql.ResultSet;
import java.sql.SQLException;
Expand Down
2 changes: 1 addition & 1 deletion ...els/ModelPrincipalAuthenticationData.java → ...els/ModelPrincipalAuthenticationData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc.models;
package org.apache.polaris.persistence.relational.jdbc.models;

import java.sql.ResultSet;
import java.sql.SQLException;
Expand Down
0 ...-jdbc/src/main/resources/h2/schema-v1.sql → ...-jdbc/src/main/resources/h2/schema-v1.sql
View file
Open in desktop
File renamed without changes.
0 ...src/main/resources/postgres/schema-v1.sql → ...src/main/resources/postgres/schema-v1.sql
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...nagerWithJdbcBasePersistenceImplTest.java → ...nagerWithJdbcBasePersistenceImplTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import static org.apache.polaris.core.persistence.PrincipalSecretsGenerator.RANDOM_SECRETS;

Expand Down
6 changes: 3 additions & 3 deletions ...tional/jdbc/DatasourceOperationsTest.java → ...tional/jdbc/DatasourceOperationsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
Expand All @@ -33,8 +33,8 @@
import java.time.Instant;
import java.util.Optional;
import javax.sql.DataSource;
import org.apache.polaris.extension.persistence.relational.jdbc.DatasourceOperations.Operation;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelEntity;
import org.apache.polaris.persistence.relational.jdbc.DatasourceOperations.Operation;
import org.apache.polaris.persistence.relational.jdbc.models.ModelEntity;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
Expand Down
8 changes: 4 additions & 4 deletions ...e/relational/jdbc/QueryGeneratorTest.java → ...e/relational/jdbc/QueryGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.polaris.extension.persistence.relational.jdbc;
package org.apache.polaris.persistence.relational.jdbc;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
Expand All @@ -30,9 +30,9 @@
import java.util.Map;
import org.apache.polaris.core.entity.PolarisEntityCore;
import org.apache.polaris.core.entity.PolarisEntityId;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelEntity;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelGrantRecord;
import org.apache.polaris.extension.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData;
import org.apache.polaris.persistence.relational.jdbc.models.ModelEntity;
import org.apache.polaris.persistence.relational.jdbc.models.ModelGrantRecord;
import org.apache.polaris.persistence.relational.jdbc.models.ModelPrincipalAuthenticationData;
import org.junit.jupiter.api.Test;

public class QueryGeneratorTest {
Expand Down
2 changes: 1 addition & 1 deletion ...ava/org/apache/polaris/quarkus/common/config/jdbc/QuarkusRelationalJdbcConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
package org.apache.polaris.quarkus.common.config.jdbc;

import io.smallrye.config.ConfigMapping;
import org.apache.polaris.extension.persistence.relational.jdbc.RelationalJdbcConfiguration;
import org.apache.polaris.persistence.relational.jdbc.RelationalJdbcConfiguration;

@ConfigMapping(prefix = "polaris.persistence.relational.jdbc")
public interface QuarkusRelationalJdbcConfiguration extends RelationalJdbcConfiguration {}
Loading