mchades commented on code in PR #9016:
URL: https://github.com/apache/gravitino/pull/9016#discussion_r2493651353
##########
lance/lance-common/src/main/java/org/apache/gravitino/lance/common/ops/LanceTableOperations.java:
##########
@@ -18,26 +18,67 @@
*/
package org.apache.gravitino.lance.common.ops;
+import com.lancedb.lance.namespace.model.CreateTableRequest;
import com.lancedb.lance.namespace.model.CreateTableResponse;
import com.lancedb.lance.namespace.model.DeregisterTableResponse;
import com.lancedb.lance.namespace.model.DescribeTableResponse;
+import com.lancedb.lance.namespace.model.RegisterTableRequest;
import com.lancedb.lance.namespace.model.RegisterTableResponse;
import java.util.Map;
+import java.util.Optional;
public interface LanceTableOperations {
- DescribeTableResponse describeTable(String tableId, String delimiter);
+ /**
+ * Describe the details of a table.
+ *
+ * @param tableId table ids are in the format of
"{namespace}{delimiter}{table_name}"
+ * @param delimiter the delimiter used in the namespace
+ * @param version the version of the table to describe, if null, describe
the latest version
+ * @return the table description
+ */
+ DescribeTableResponse describeTable(String tableId, String delimiter,
Optional<Long> version);
+ /**
+ * Create a new table.
+ *
+ * @param tableId table ids are in the format of
"namespace/delimiter/table_name"
+ * @param mode it can be CREATE, OVERWRITE, or EXIST_OK
+ * @param delimiter the delimiter used in the namespace
+ * @param tableLocation the location where the table data will be stored
+ * @param tableProperties the properties of the table
+ * @param arrowStreamBody the arrow stream bytes containing the schema and
data
+ * @return the response of the create table operation
+ */
CreateTableResponse createTable(
String tableId,
- String mode,
+ CreateTableRequest.ModeEnum mode,
String delimiter,
String tableLocation,
Map<String, String> tableProperties,
byte[] arrowStreamBody);
+ /**
+ * Register an existing table.
+ *
+ * @param tableId table ids are in the format of
"namespace/delimiter/table_name"
+ * @param mode it can be REGISTER or OVERWRITE.
+ * @param delimiter the delimiter used in the namespace
+ * @param tableProperties the properties of the table, it should contain the
table location
+ * @return the response of the register table operation
+ */
RegisterTableResponse registerTable(
- String tableId, String mode, String delimiter, Map<String, String>
tableProperties);
+ String tableId,
+ RegisterTableRequest.ModeEnum mode,
+ String delimiter,
+ Map<String, String> tableProperties);
+ /**
+ * Deregister a table. It will not delete the underlying lance data.
+ *
+ * @param tableId table ids are in the format of
"namespace/delimiter/table_name"
Review Comment:
`"{namespace}{delimiter}{table_name}"`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
