-
Notifications
You must be signed in to change notification settings - Fork 153
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[590] Add interfaces for CatalogSyncClient and CatalogSync
- Loading branch information
1 parent
a08ca24
commit fb724f0
Showing
34 changed files
with
1,148 additions
and
269 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
xtable-api/src/main/java/org/apache/xtable/model/catalog/CatalogTableIdentifier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.xtable.model.catalog; | ||
|
||
/** Represents a catalog table identifier in a multi-level catalog system. */ | ||
public interface CatalogTableIdentifier { | ||
/** Returns the string identifier for the table within its catalog context */ | ||
String getId(); | ||
} |
34 changes: 34 additions & 0 deletions
34
xtable-api/src/main/java/org/apache/xtable/model/catalog/HierarchicalTableIdentifier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.xtable.model.catalog; | ||
|
||
/** | ||
* Represents a hierarchical table identifier, often including catalog, database (or schema), and | ||
* table names. Some catalogs may omit the catalog name. | ||
*/ | ||
public interface HierarchicalTableIdentifier extends CatalogTableIdentifier { | ||
/** @return the catalog name if present, otherwise null */ | ||
String getCatalogName(); | ||
|
||
/** @return the database (or schema) name; required */ | ||
String getDatabaseName(); | ||
|
||
/** @return the table name; required */ | ||
String getTableName(); | ||
} |
105 changes: 105 additions & 0 deletions
105
...i/src/main/java/org/apache/xtable/model/catalog/ThreePartHierarchicalTableIdentifier.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.xtable.model.catalog; | ||
|
||
import lombok.NonNull; | ||
import lombok.Value; | ||
|
||
/** | ||
* An internal representation of a fully qualified table identifier within a catalog. The naming | ||
* convention follows a three level hierarchy, few examples can be found below. | ||
* | ||
* <ul> | ||
* <li>1. catalog.database.table | ||
* <li>2. catalog.schema.table | ||
* <li>3. database.schema.table | ||
* </ul> | ||
* | ||
* We have selected the first naming convention and will interoperate among other catalogs following | ||
* a different convention. | ||
*/ | ||
@Value | ||
public class ThreePartHierarchicalTableIdentifier implements HierarchicalTableIdentifier { | ||
/** | ||
* The top level hierarchy/namespace for organizing tables. Each catalog can have multiple | ||
* databases/schemas. This is an optional field as many catalogs have a "default" catalog whose | ||
* name varies depending on the catalogType. | ||
*/ | ||
String catalogName; | ||
/** | ||
* Catalogs have the ability to group tables logically, databaseName is the identifier for such | ||
* logical classification. The alternate names for this field include namespace, schemaName etc. | ||
*/ | ||
@NonNull String databaseName; | ||
|
||
/** | ||
* The table name used when syncing the table to the catalog. NOTE: This name can be different | ||
* from the table name in storage. | ||
*/ | ||
@NonNull String tableName; | ||
|
||
public ThreePartHierarchicalTableIdentifier( | ||
String catalogName, @NonNull String databaseName, @NonNull String tableName) { | ||
this.catalogName = catalogName; | ||
this.databaseName = databaseName; | ||
this.tableName = tableName; | ||
} | ||
|
||
public ThreePartHierarchicalTableIdentifier(String databaseName, String tableName) { | ||
this(null, databaseName, tableName); | ||
} | ||
|
||
/** | ||
* Constructs a new {@code CatalogTableIdentifier} from a hierarchical string identifier. | ||
* | ||
* <p>The identifier is expected to be in one of the following formats: | ||
* | ||
* <ul> | ||
* <li>{@code database.table} (two parts, no catalog) | ||
* <li>{@code catalog.database.table} (three parts) | ||
* </ul> | ||
* | ||
* If the identifier does not match one of these formats, an {@link IllegalArgumentException} is | ||
* thrown. | ||
* | ||
* @param hierarchicalTableIdentifier The hierarchical string identifier (e.g., | ||
* "myCatalog.myDatabase.myTable" or "myDatabase.myTable"). | ||
* @throws IllegalArgumentException If the provided string does not match a valid two-part or | ||
* three-part identifier. | ||
*/ | ||
public static ThreePartHierarchicalTableIdentifier fromDotSeparatedIdentifier( | ||
String hierarchicalTableIdentifier) { | ||
String[] parts = hierarchicalTableIdentifier.split("\\."); | ||
if (parts.length == 2) { | ||
return new ThreePartHierarchicalTableIdentifier(parts[0], parts[1]); | ||
} else if (parts.length == 3) { | ||
return new ThreePartHierarchicalTableIdentifier(parts[0], parts[1], parts[2]); | ||
} else { | ||
throw new IllegalArgumentException("Invalid table identifier " + hierarchicalTableIdentifier); | ||
} | ||
} | ||
|
||
@Override | ||
public String getId() { | ||
if (catalogName != null && !catalogName.isEmpty()) { | ||
return catalogName + "." + databaseName + "." + tableName; | ||
} | ||
return databaseName + "." + tableName; | ||
} | ||
} |
31 changes: 31 additions & 0 deletions
31
xtable-api/src/main/java/org/apache/xtable/model/exception/CatalogRefreshException.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
/* | ||
* Licensed to the Apache Software Foundation (ASF) under one | ||
* or more contributor license agreements. See the NOTICE file | ||
* distributed with this work for additional information | ||
* regarding copyright ownership. The ASF licenses this file | ||
* to you under the Apache License, Version 2.0 (the | ||
* "License"); you may not use this file except in compliance | ||
* with the License. You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.apache.xtable.model.exception; | ||
|
||
/** Exception thrown when refresh operation (updating table format metadata) in catalog fails. */ | ||
public class CatalogRefreshException extends InternalException { | ||
|
||
public CatalogRefreshException(String message, Throwable e) { | ||
super(ErrorCode.CATALOG_REFRESH_EXCEPTION, message, e); | ||
} | ||
|
||
public CatalogRefreshException(String message) { | ||
super(ErrorCode.CATALOG_REFRESH_EXCEPTION, message); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.