[apache#3731]Update the tutorial and document for the Java client API…

… change
shaofengshi · Jul 5, 2024 · 91c953b · 91c953b
1 parent 34a81df
commit 91c953b
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 43 deletions.
diff --git a/docs/manage-fileset-metadata-using-gravitino.md b/docs/manage-fileset-metadata-using-gravitino.md
@@ -69,8 +69,7 @@ Map<String, String> properties = ImmutableMap.<String, String>builder()
     // a storage location will be stored under this location.
     .build();
 
-Catalog catalog = gravitinoClient.createCatalog(
-    NameIdentifier.of("metalake", "catalog"),
+Catalog catalog = gravitinoClient.createCatalog("catalog",
     Type.FILESET,
     "hadoop", // provider, Gravitino only supports "hadoop" for now.
     "This is a Hadoop fileset catalog",
@@ -167,7 +166,7 @@ GravitinoClient gravitinoClient = GravitinoClient
     .build();
 
 // Assuming you have just created a Hadoop catalog named `catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 
 SupportsSchemas supportsSchemas = catalog.asSchemas();
 
@@ -176,8 +175,7 @@ Map<String, String> schemaProperties = ImmutableMap.<String, String>builder()
     // specifying storage location will be stored under this location.
     .put("location", "file:/tmp/root/schema")
     .build();
-Schema schema = supportsSchemas.createSchema(
-    NameIdentifier.of("metalake", "catalog", "schema"),
+Schema schema = supportsSchemas.createSchema("schema",
     "This is a schema",
     schemaProperties
 );
@@ -270,7 +268,7 @@ GravitinoClient gravitinoClient = GravitinoClient
     .withMetalake("metalake")
     .build();
 
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 FilesetCatalog filesetCatalog = catalog.asFilesetCatalog();
 
 Map<String, String> propertiesMap = ImmutableMap.<String, String>builder()
@@ -362,7 +360,7 @@ curl -X PUT -H "Accept: application/vnd.gravitino.v1+json" \
 ```java
 // ...
 // Assuming you have just created a Fileset catalog named `catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 
 FilesetCatalog filesetCatalog = catalog.asFilesetCatalog();
 
@@ -419,7 +417,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema/fil
 ```java
 // ...
 // Assuming you have just created a Fileset catalog named `catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 
 FilesetCatalog filesetCatalog = catalog.asFilesetCatalog();
 
@@ -464,7 +462,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema/fil
 
 ```java
 // ...
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 
 FilesetCatalog filesetCatalog = catalog.asFilesetCatalog();
 NameIdentifier[] identifiers =

diff --git a/docs/manage-messaging-metadata-using-gravitino.md b/docs/manage-messaging-metadata-using-gravitino.md
@@ -59,8 +59,7 @@ Map<String, String> properties = ImmutableMap.<String, String>builder()
     .put("bootstrap.servers", "localhost:9092")
     .build();
 
-Catalog catalog = gravitinoClient.createCatalog(
-    NameIdentifier.of("metalake", "catalog"),
+Catalog catalog = gravitinoClient.createCatalog("catalog",
     Type.MESSAGING,
     "kafka", // provider, Gravitino only supports "kafka" for now.
     "This is a Kafka catalog",
@@ -172,7 +171,7 @@ GravitinoClient gravitinoClient = GravitinoClient
     .withMetalake("metalake")
     .build();
 
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 TopicCatalog topicCatalog = catalog.asTopicCatalog();
 
 Map<String, String> propertiesMap = ImmutableMap.<String, String>builder()
@@ -222,7 +221,7 @@ curl -X PUT -H "Accept: application/vnd.gravitino.v1+json" \
 ```java
 // ...
 // Assuming you have just created a Kafka catalog named `catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 
 TopicCatalog topicCatalog = catalog.asTopicCatalog();
 
@@ -263,7 +262,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/default/to
 ```java
 // ...
 // Assuming you have just created a Kafka catalog named `catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 
 TopicCatalog topicCatalog = catalog.asTopicCatalog();
 
@@ -295,7 +294,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema/top
 
 ```java
 // ...
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 
 TopicCatalog topicCatalog = catalog.asTopicCatalog();
 NameIdentifier[] identifiers =

diff --git a/docs/manage-relational-metadata-using-gravitino.md b/docs/manage-relational-metadata-using-gravitino.md
@@ -74,8 +74,7 @@ Map<String, String> hiveProperties = ImmutableMap.<String, String>builder()
         .put("metastore.uris", "thrift://localhost:9083")
         .build();
 
-Catalog catalog = gravitinoClient.createCatalog(
-    NameIdentifier.of("metalake", "catalog"),
+Catalog catalog = gravitinoClient.createCatalog("catalog",
     Type.RELATIONAL,
     "hive", // provider, We support hive, jdbc-mysql, jdbc-postgresql, lakehouse-iceberg, etc.
     "This is a hive catalog",
@@ -114,7 +113,7 @@ curl -X GET -H "Accept: application/vnd.gravitino.v1+json" \
 ```java
 // ...
 // Assuming you have created a metalake named `metalake` and a catalog named `catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("catalog");
 // ...
 ```
 
@@ -151,7 +150,7 @@ curl -X PUT -H "Accept: application/vnd.gravitino.v1+json" \
 ```java
 // ...
 // Assuming you have created a metalake named `metalake` and a catalog named `catalog`
-Catalog catalog = gravitinoClient.alterCatalog(NameIdentifier.of("metalake", "catalog"),
+Catalog catalog = gravitinoClient.alterCatalog("catalog",
     CatalogChange.rename("alter_catalog"), CatalogChange.updateComment("new comment"));
 // ...
 ```
@@ -187,7 +186,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog
 ```java
 // ...
 // Assuming you have created a metalake named `metalake` and a catalog named `catalog`
-gravitinoClient.dropCatalog(NameIdentifier.of("metalake", "catalog"));
+gravitinoClient.dropCatalog("catalog");
 // ...
 
 ```
@@ -219,7 +218,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs
 ```java
 // ...
 // Assuming you have just created a metalake named `metalake`
-NameIdentifier[] catalogsIdents = gravitinoClient.listCatalogs(Namespace.ofCatalog("metalake"));
+String[] catalogNames = gravitinoClient.listCatalogs();
 // ...
 ```
 
@@ -245,7 +244,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs?details=true
 ```java
 // ...
 // Assuming you have just created a metalake named `metalake`
-Catalog[] catalogsInfos = gravitinoMetalake.listCatalogsInfo(Namespace.ofCatalog("metalake"));
+Catalog[] catalogsInfos = gravitinoMetaLake.listCatalogsInfo();
 // ...
 ```
 
@@ -282,14 +281,13 @@ curl -X POST -H "Accept: application/vnd.gravitino.v1+json" \
 
 ```java
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 SupportsSchemas supportsSchemas = catalog.asSchemas();
 
 Map<String, String> schemaProperties = ImmutableMap.<String, String>builder()
     .build();
-Schema schema = supportsSchemas.createSchema(
-    NameIdentifier.of("metalake", "hive_catalog", "schema"),
+Schema schema = supportsSchemas.createSchema("schema",
     "This is a schema",
     schemaProperties
 );
@@ -339,9 +337,9 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 SupportsSchemas supportsSchemas = catalog.asSchemas();
-Schema schema = supportsSchemas.loadSchema(NameIdentifier.of("metalake", "hive_catalog", "schema"));
+Schema schema = supportsSchemas.loadSchema("schema");
 // ...
 ```
 
@@ -386,11 +384,11 @@ curl -X PUT -H "Accept: application/vnd.gravitino.v1+json" \
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 SupportsSchemas supportsSchemas = catalog.asSchemas();
 
-Schema schema = supportsSchemas.alterSchema(NameIdentifier.of("metalake", "hive_catalog", "schema"),
+Schema schema = supportsSchemas.alterSchema("schema",
     SchemaChange.removeProperty("key1"),
     SchemaChange.setProperty("key2", "value2"));
 // ...
@@ -440,11 +438,11 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema?cas
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 SupportsSchemas supportsSchemas = catalog.asSchemas();
 // cascade can be true or false
-supportsSchemas.dropSchema(NameIdentifier.of("metalake", "hive_catalog", "schema"), true);
+supportsSchemas.dropSchema("schema", true);
 ```
 
 </TabItem>
@@ -483,10 +481,10 @@ curl -X GET -H "Accept: application/vnd.gravitino.v1+json" \
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 SupportsSchemas supportsSchemas = catalog.asSchemas();
-NameIdentifier[] schemas = supportsSchemas.listSchemas(Namespace.ofSchema("metalake", "hive_catalog"));
+String[] schemas = supportsSchemas.listSchemas();
 ```
 
 </TabItem>
@@ -645,7 +643,7 @@ curl -X POST -H "Accept: application/vnd.gravitino.v1+json" \
 
 ```java
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 TableCatalog tableCatalog = catalog.asTableCatalog();
 
@@ -858,7 +856,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema/tab
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 TableCatalog tableCatalog = catalog.asTableCatalog();
 tableCatalog.loadTable(NameIdentifier.of("metalake", "hive_catalog", "schema", "table"));
@@ -902,7 +900,7 @@ curl -X PUT -H "Accept: application/vnd.gravitino.v1+json" \
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 TableCatalog tableCatalog = catalog.asTableCatalog();
 
@@ -952,7 +950,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema/tab
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 TableCatalog tableCatalog = catalog.asTableCatalog();
 
@@ -993,7 +991,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema/tab
 ```java
 // ...
 // Assuming you have just created a Hive catalog named `hive_catalog`
-Catalog catalog = gravitinoClient.loadCatalog(NameIdentifier.of("metalake", "hive_catalog"));
+Catalog catalog = gravitinoClient.loadCatalog("hive_catalog");
 
 TableCatalog tableCatalog = catalog.asTableCatalog();
 NameIdentifier[] identifiers =

diff --git a/docs/manage-table-partition-using-gravitino.md b/docs/manage-table-partition-using-gravitino.md
@@ -255,7 +255,7 @@ GravitinoClient gravitinoClient = GravitinoClient
 // Assume that you have a partitioned table named "metalake.catalog.schema.table".
 Partition addedPartition = 
     gravitinoClient
-        .loadCatalog(NameIdentifier.of("metalake", "catalog"))
+        .loadCatalog("catalog")
         .asTableCatalog()
         .loadTable(NameIdentifier.of("metalake", "catalog", "schema", "table"))
         .supportPartitions()
@@ -300,7 +300,7 @@ GravitinoClient gravitinoClient = GravitinoClient
 // Assume that you have a partitioned table named "metalake.catalog.schema.table".
 Partition Partition = 
     gravitinoClient
-        .loadCatalog(NameIdentifier.of("metalake", "catalog"))
+        .loadCatalog("catalog")
         .asTableCatalog()
         .loadTable(NameIdentifier.of("metalake", "catalog", "schema", "table"))
         .supportPartitions()
@@ -336,7 +336,7 @@ GravitinoClient gravitinoClient = GravitinoClient
 // Assume that you have a partitioned table named "metalake.catalog.schema.table".
 String[] partitionNames = 
     gravitinoClient
-        .loadCatalog(NameIdentifier.of("metalake", "catalog"))
+        .loadCatalog("catalog")
         .asTableCatalog()
         .loadTable(NameIdentifier.of("metalake", "catalog", "schema", "table"))
         .supportPartitions()
@@ -367,7 +367,7 @@ http://localhost:8090/api/metalakes/metalake/catalogs/catalog/schemas/schema/tab
 // Assume that you have a partitioned table named "metalake.catalog.schema.table".
 Partition[] partitions =
         gravitinoClient
-            .loadCatalog(NameIdentifier.of("metalake", "catalog"))
+            .loadCatalog("catalog")
             .asTableCatalog()
             .loadTable(NameIdentifier.of("metalake", "catalog", "schema", "table"))
             .supportPartitions()
@@ -407,7 +407,7 @@ GravitinoClient gravitinoClient = GravitinoClient
 // Assume that you have a partitioned table named "metalake.catalog.schema.table".
 Partition Partition = 
     gravitinoClient
-        .loadCatalog(NameIdentifier.of("metalake", "catalog"))
+        .loadCatalog("catalog")
         .asTableCatalog()
         .loadTable(NameIdentifier.of("metalake", "catalog", "schema", "table"))
         .supportPartitions()