Skip to content

[SPEC] Add location keyword for GenericTable API #1543

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[SPEC] Add location keyword for GenericTable API #1543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1b4b938
add location keyword for generic table
gh-yzou May 7, 2025
0cdab34
add change
gh-yzou May 19, 2025
f91a547
fix table
gh-yzou May 21, 2025
e5b37cf
add doc for location
gh-yzou May 21, 2025
9084a87
update spec
gh-yzou May 21, 2025
1a9168d
address feedback
gh-yzou Jun 5, 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
11 changes: 6 additions & 5 deletions ...s/src/main/java/org/apache/polaris/service/it/test/PolarisRestCatalogIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1468,11 +1468,12 @@ public void testCreateGenericTableWithReservedProperty() {
Map.of("cat", currentCatalogName, "ns", ns))
.post(
Entity.json(
new CreateGenericTableRequest(
tableIdentifier.name(),
"format",
"doc",
Map.of("polaris.reserved", "true"))))) {
CreateGenericTableRequest.builder()
.setName(tableIdentifier.name())
.setFormat("format")
.setDoc("doc")
.setProperties(Map.of("polaris.reserved", "true"))
.build()))) {
Assertions.assertThat(res.getStatus()).isEqualTo(Response.Status.BAD_REQUEST.getStatusCode());
Assertions.assertThat(res.readEntity(String.class)).contains("reserved prefix");
}
Expand Down
10 changes: 8 additions & 2 deletions ...v3.5/spark/src/main/java/org/apache/polaris/spark/rest/CreateGenericTableRESTRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,19 @@ public class CreateGenericTableRESTRequest extends CreateGenericTableRequest
public CreateGenericTableRESTRequest(
@JsonProperty(value = "name", required = true) String name,
@JsonProperty(value = "format", required = true) String format,
@JsonProperty(value = "location") String location,
@JsonProperty(value = "doc") String doc,
@JsonProperty(value = "properties") Map<String, String> properties) {
super(name, format, doc, properties);
super(name, format, location, doc, properties);
}

public CreateGenericTableRESTRequest(CreateGenericTableRequest request) {
this(request.getName(), request.getFormat(), request.getDoc(), request.getProperties());
this(
request.getName(),
request.getFormat(),
request.getLocation(),
request.getDoc(),
request.getProperties());
}

@Override
Expand Down
18 changes: 14 additions & 4 deletions spec/polaris-catalog-apis/generic-tables-api.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,8 @@ components:
type: string
format:
type: string
location:
type: string
doc:
type: string
properties:
Expand All @@ -205,13 +207,19 @@ components:
description: >
Generic Table information.

- `name` name for the generic table
- `name`(REQUIRED): name for the generic table

- `format`(REQUIRED): format for the generic table, i.e. "delta", "csv"

- `format` format for the generic table, i.e. "delta", "csv"
- `location`(OPTIONAL): table root location in URI format. For example: s3://<my-bucket>/path/to/table.
- The table root location is a location that includes all files for the table.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@dimas-b i will follow up with a dedicated webpage for generic table

Copy link
Contributor

Choose a reason for hiding this comment

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

thx!

- Clients (engines) are responsible to make sure all files are written under the configured location.
- A table with multiple root locations (i.e. containing files that are outside the configured root location) is not compliant with the current generic table support in Polaris.
- If no location is provided, clients or users are responsible to manage the location and location related concerns such as path conflict etc.

- `properties` properties for the generic table passed on creation
- `properties`(OPTIONAL): properties for the generic table passed on creation

- `doc` comment or description for the generic table
- `doc`(OPTIONAL): comment or description for the generic table
required:
- name
- format
Expand All @@ -220,6 +228,8 @@ components:
type: string
format:
type: string
location:
type: string
doc:
type: string
properties:
Expand Down
Loading