[#4881] improvement(docs): Add documents about PostgreSQL storage bac…

…kend (#4885) ### What changes were proposed in this pull request? Change documents accordingly as we have supported PostgreSQL storage backend. ### Why are the changes needed? #4611 lacks related documents. Fix: #4881 ### Does this PR introduce _any_ user-facing change? N/A. ### How was this patch tested? N/A.
apache · Sep 11, 2024 · 3121f11 · 3121f11
1 parent 491d173
commit 3121f11
Show file tree

Hide file tree

Showing 18 changed files with 177 additions and 77 deletions.
diff --git a/...in/java/org/apache/gravitino/storage/relational/mapper/CatalogMetaSQLProviderFactory.java b/...in/java/org/apache/gravitino/storage/relational/mapper/CatalogMetaSQLProviderFactory.java
@@ -30,7 +30,7 @@
 public class CatalogMetaSQLProviderFactory {
 
   private static final Map<JDBCBackendType, CatalogMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      CATALOG_META_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new CatalogMetaMySQLProvider(),
               JDBCBackendType.H2, new CatalogMetaH2Provider(),
@@ -44,7 +44,7 @@ public static CatalogMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return CATALOG_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class CatalogMetaMySQLProvider extends CatalogMetaBaseSQLProvider {}

diff --git a/...in/java/org/apache/gravitino/storage/relational/mapper/FilesetMetaSQLProviderFactory.java b/...in/java/org/apache/gravitino/storage/relational/mapper/FilesetMetaSQLProviderFactory.java
@@ -29,7 +29,7 @@
 
 public class FilesetMetaSQLProviderFactory {
   private static final Map<JDBCBackendType, FilesetMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      FILESET_META_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new FilesetMetaMySQLProvider(),
               JDBCBackendType.H2, new FilesetMetaH2Provider(),
@@ -43,7 +43,7 @@ public static FilesetMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return FILESET_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class FilesetMetaMySQLProvider extends FilesetMetaBaseSQLProvider {}

diff --git a/...java/org/apache/gravitino/storage/relational/mapper/FilesetVersionSQLProviderFactory.java b/...java/org/apache/gravitino/storage/relational/mapper/FilesetVersionSQLProviderFactory.java
@@ -28,7 +28,7 @@
 
 public class FilesetVersionSQLProviderFactory {
   private static final Map<JDBCBackendType, FilesetVersionBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      FILESET_VERSION_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new FilesetVersionMySQLProvider(),
               JDBCBackendType.H2, new FilesetVersionH2Provider(),
@@ -42,7 +42,7 @@ public static FilesetVersionBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return FILESET_VERSION_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class FilesetVersionMySQLProvider extends FilesetVersionBaseSQLProvider {}

diff --git a/...main/java/org/apache/gravitino/storage/relational/mapper/GroupMetaSQLProviderFactory.java b/...main/java/org/apache/gravitino/storage/relational/mapper/GroupMetaSQLProviderFactory.java
@@ -27,12 +27,11 @@
 import org.apache.ibatis.annotations.Param;
 
 public class GroupMetaSQLProviderFactory {
-  private static final Map<JDBCBackendType, GroupMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
-          ImmutableMap.of(
-              JDBCBackendType.MYSQL, new GroupMetaMySQLProvider(),
-              JDBCBackendType.H2, new GroupMetaH2Provider(),
-              JDBCBackendType.POSTGRESQL, new GroupMetaPostgreSQLProvider());
+  private static final Map<JDBCBackendType, GroupMetaBaseSQLProvider> GROUP_META_SQL_PROVIDER_MAP =
+      ImmutableMap.of(
+          JDBCBackendType.MYSQL, new GroupMetaMySQLProvider(),
+          JDBCBackendType.H2, new GroupMetaH2Provider(),
+          JDBCBackendType.POSTGRESQL, new GroupMetaPostgreSQLProvider());
 
   public static GroupMetaBaseSQLProvider getProvider() {
     String databaseId =
@@ -42,7 +41,7 @@ public static GroupMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return GROUP_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class GroupMetaMySQLProvider extends GroupMetaBaseSQLProvider {}

diff --git a/...n/java/org/apache/gravitino/storage/relational/mapper/GroupRoleRelSQLProviderFactory.java b/...n/java/org/apache/gravitino/storage/relational/mapper/GroupRoleRelSQLProviderFactory.java
@@ -30,7 +30,7 @@
 public class GroupRoleRelSQLProviderFactory {
 
   private static final Map<JDBCBackendType, GroupRoleRelBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      GROUP_ROLE_RELATION_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new GroupRoleRelMySQLProvider(),
               JDBCBackendType.H2, new GroupRoleRelH2Provider(),
@@ -44,7 +44,7 @@ public static GroupRoleRelBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return GROUP_ROLE_RELATION_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class GroupRoleRelMySQLProvider extends GroupRoleRelBaseSQLProvider {}

diff --git a/...main/java/org/apache/gravitino/storage/relational/mapper/OwnerMetaSQLProviderFactory.java b/...main/java/org/apache/gravitino/storage/relational/mapper/OwnerMetaSQLProviderFactory.java
@@ -28,12 +28,11 @@
 
 public class OwnerMetaSQLProviderFactory {
 
-  private static final Map<JDBCBackendType, OwnerMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
-          ImmutableMap.of(
-              JDBCBackendType.MYSQL, new OwnerMetaMySQLProvider(),
-              JDBCBackendType.H2, new OwnerMetaH2Provider(),
-              JDBCBackendType.POSTGRESQL, new OwnerMetaPostgreSQLProvider());
+  private static final Map<JDBCBackendType, OwnerMetaBaseSQLProvider> OWNER_META_SQL_PROVIDER_MAP =
+      ImmutableMap.of(
+          JDBCBackendType.MYSQL, new OwnerMetaMySQLProvider(),
+          JDBCBackendType.H2, new OwnerMetaH2Provider(),
+          JDBCBackendType.POSTGRESQL, new OwnerMetaPostgreSQLProvider());
 
   public static OwnerMetaBaseSQLProvider getProvider() {
     String databaseId =
@@ -43,7 +42,7 @@ public static OwnerMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return OWNER_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class OwnerMetaMySQLProvider extends OwnerMetaBaseSQLProvider {}

diff --git a/.../main/java/org/apache/gravitino/storage/relational/mapper/RoleMetaSQLProviderFactory.java b/.../main/java/org/apache/gravitino/storage/relational/mapper/RoleMetaSQLProviderFactory.java
@@ -27,12 +27,11 @@
 import org.apache.ibatis.annotations.Param;
 
 public class RoleMetaSQLProviderFactory {
-  private static final Map<JDBCBackendType, RoleMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
-          ImmutableMap.of(
-              JDBCBackendType.MYSQL, new RoleMetaMySQLProvider(),
-              JDBCBackendType.H2, new RoleMetaH2Provider(),
-              JDBCBackendType.POSTGRESQL, new RoleMetaPostgreSQLProvider());
+  private static final Map<JDBCBackendType, RoleMetaBaseSQLProvider> ROLE_META_SQL_PROVIDER_MAP =
+      ImmutableMap.of(
+          JDBCBackendType.MYSQL, new RoleMetaMySQLProvider(),
+          JDBCBackendType.H2, new RoleMetaH2Provider(),
+          JDBCBackendType.POSTGRESQL, new RoleMetaPostgreSQLProvider());
 
   public static RoleMetaBaseSQLProvider getProvider() {
     String databaseId =
@@ -42,7 +41,7 @@ public static RoleMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return ROLE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class RoleMetaMySQLProvider extends RoleMetaBaseSQLProvider {}

diff --git a/...ain/java/org/apache/gravitino/storage/relational/mapper/SchemaMetaSQLProviderFactory.java b/...ain/java/org/apache/gravitino/storage/relational/mapper/SchemaMetaSQLProviderFactory.java
@@ -28,7 +28,7 @@
 
 public class SchemaMetaSQLProviderFactory {
   private static final Map<JDBCBackendType, SchemaMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      SCHEMA_META_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new SchemaMetaMySQLProvider(),
               JDBCBackendType.H2, new SchemaMetaH2Provider(),
@@ -42,7 +42,7 @@ public static SchemaMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return SCHEMA_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class SchemaMetaMySQLProvider extends SchemaMetaBaseSQLProvider {}

diff --git a/...ava/org/apache/gravitino/storage/relational/mapper/SecurableObjectSQLProviderFactory.java b/...ava/org/apache/gravitino/storage/relational/mapper/SecurableObjectSQLProviderFactory.java
@@ -30,7 +30,7 @@
 public class SecurableObjectSQLProviderFactory {
 
   private static final Map<JDBCBackendType, SecurableObjectBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      SECURABLE_OBJECTS_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new SecurableObjectMySQLProvider(),
               JDBCBackendType.H2, new SecurableObjectH2Provider(),
@@ -44,7 +44,7 @@ public static SecurableObjectBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return SECURABLE_OBJECTS_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class SecurableObjectMySQLProvider extends SecurableObjectBaseSQLProvider {}

diff --git a/...main/java/org/apache/gravitino/storage/relational/mapper/TableMetaSQLProviderFactory.java b/...main/java/org/apache/gravitino/storage/relational/mapper/TableMetaSQLProviderFactory.java
@@ -28,12 +28,11 @@
 
 public class TableMetaSQLProviderFactory {
 
-  private static final Map<JDBCBackendType, TableMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
-          ImmutableMap.of(
-              JDBCBackendType.MYSQL, new TableMetaMySQLProvider(),
-              JDBCBackendType.H2, new TableMetaH2Provider(),
-              JDBCBackendType.POSTGRESQL, new TableMetaPostgreSQLProvider());
+  private static final Map<JDBCBackendType, TableMetaBaseSQLProvider> TABLE_META_SQL_PROVIDER_MAP =
+      ImmutableMap.of(
+          JDBCBackendType.MYSQL, new TableMetaMySQLProvider(),
+          JDBCBackendType.H2, new TableMetaH2Provider(),
+          JDBCBackendType.POSTGRESQL, new TableMetaPostgreSQLProvider());
 
   public static TableMetaBaseSQLProvider getProvider() {
     String databaseId =
@@ -43,7 +42,7 @@ public static TableMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return TABLE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class TableMetaMySQLProvider extends TableMetaBaseSQLProvider {}

diff --git a/...c/main/java/org/apache/gravitino/storage/relational/mapper/TagMetaSQLProviderFactory.java b/...c/main/java/org/apache/gravitino/storage/relational/mapper/TagMetaSQLProviderFactory.java
@@ -29,7 +29,7 @@
 
 public class TagMetaSQLProviderFactory {
 
-  private static final Map<JDBCBackendType, TagMetaBaseSQLProvider> METALAKE_META_SQL_PROVIDER_MAP =
+  private static final Map<JDBCBackendType, TagMetaBaseSQLProvider> TAG_META_SQL_PROVIDER_MAP =
       ImmutableMap.of(
           JDBCBackendType.MYSQL, new TagMetaMySQLProvider(),
           JDBCBackendType.H2, new TagMetaH2Provider(),
@@ -43,7 +43,7 @@ public static TagMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return TAG_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class TagMetaMySQLProvider extends TagMetaBaseSQLProvider {}

diff --git a/...rg/apache/gravitino/storage/relational/mapper/TagMetadataObjectRelSQLProviderFactory.java b/...rg/apache/gravitino/storage/relational/mapper/TagMetadataObjectRelSQLProviderFactory.java
@@ -30,7 +30,7 @@
 public class TagMetadataObjectRelSQLProviderFactory {
 
   private static final Map<JDBCBackendType, TagMetadataObjectRelBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      TAG_METADATA_OBJECT_RELATION_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new TagMetadataObjectRelMySQLProvider(),
               JDBCBackendType.H2, new TagMetadataObjectRelH2Provider(),
@@ -44,7 +44,7 @@ public static TagMetadataObjectRelBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return TAG_METADATA_OBJECT_RELATION_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class TagMetadataObjectRelMySQLProvider extends TagMetadataObjectRelBaseSQLProvider {}

diff --git a/...main/java/org/apache/gravitino/storage/relational/mapper/TopicMetaSQLProviderFactory.java b/...main/java/org/apache/gravitino/storage/relational/mapper/TopicMetaSQLProviderFactory.java
@@ -29,12 +29,11 @@
 
 public class TopicMetaSQLProviderFactory {
 
-  private static final Map<JDBCBackendType, TopicMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
-          ImmutableMap.of(
-              JDBCBackendType.MYSQL, new TopicMetaMySQLProvider(),
-              JDBCBackendType.H2, new TopicMetaH2Provider(),
-              JDBCBackendType.POSTGRESQL, new TopicMetaPostgreSQLProvider());
+  private static final Map<JDBCBackendType, TopicMetaBaseSQLProvider> TOPIC_META_SQL_PROVIDER_MAP =
+      ImmutableMap.of(
+          JDBCBackendType.MYSQL, new TopicMetaMySQLProvider(),
+          JDBCBackendType.H2, new TopicMetaH2Provider(),
+          JDBCBackendType.POSTGRESQL, new TopicMetaPostgreSQLProvider());
 
   public static TopicMetaBaseSQLProvider getProvider() {
     String databaseId =
@@ -44,7 +43,7 @@ public static TopicMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return TOPIC_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class TopicMetaMySQLProvider extends TopicMetaBaseSQLProvider {}

diff --git a/.../main/java/org/apache/gravitino/storage/relational/mapper/UserMetaSQLProviderFactory.java b/.../main/java/org/apache/gravitino/storage/relational/mapper/UserMetaSQLProviderFactory.java
@@ -29,12 +29,11 @@
 
 public class UserMetaSQLProviderFactory {
 
-  private static final Map<JDBCBackendType, UserMetaBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
-          ImmutableMap.of(
-              JDBCBackendType.MYSQL, new UserMetaMySQLProvider(),
-              JDBCBackendType.H2, new UserMetaH2Provider(),
-              JDBCBackendType.POSTGRESQL, new UserMetaPostgreSQLProvider());
+  private static final Map<JDBCBackendType, UserMetaBaseSQLProvider> USER_META_SQL_PROVIDER_MAP =
+      ImmutableMap.of(
+          JDBCBackendType.MYSQL, new UserMetaMySQLProvider(),
+          JDBCBackendType.H2, new UserMetaH2Provider(),
+          JDBCBackendType.POSTGRESQL, new UserMetaPostgreSQLProvider());
 
   public static UserMetaBaseSQLProvider getProvider() {
     String databaseId =
@@ -44,7 +43,7 @@ public static UserMetaBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return USER_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class UserMetaMySQLProvider extends UserMetaBaseSQLProvider {}

diff --git a/...in/java/org/apache/gravitino/storage/relational/mapper/UserRoleRelSQLProviderFactory.java b/...in/java/org/apache/gravitino/storage/relational/mapper/UserRoleRelSQLProviderFactory.java
@@ -31,7 +31,7 @@
 public class UserRoleRelSQLProviderFactory {
 
   private static final Map<JDBCBackendType, UserRoleRelBaseSQLProvider>
-      METALAKE_META_SQL_PROVIDER_MAP =
+      USER_ROLE_RELATIONAL_SQL_PROVIDER_MAP =
           ImmutableMap.of(
               JDBCBackendType.MYSQL, new UserRoleRelMySQLProvider(),
               JDBCBackendType.H2, new UserRoleRelH2Provider(),
@@ -45,7 +45,7 @@ public static UserRoleRelBaseSQLProvider getProvider() {
             .getDatabaseId();
 
     JDBCBackendType jdbcBackendType = JDBCBackendType.fromString(databaseId);
-    return METALAKE_META_SQL_PROVIDER_MAP.get(jdbcBackendType);
+    return USER_ROLE_RELATIONAL_SQL_PROVIDER_MAP.get(jdbcBackendType);
   }
 
   static class UserRoleRelMySQLProvider extends UserRoleRelBaseSQLProvider {}