-
Notifications
You must be signed in to change notification settings - Fork 28.1k
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.
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
[SPARK-36526][SQL] DSV2 Index Support: Add supportsIndex interface #33754
Changes from 5 commits
a84794c
b89b321
f9f4e37
d4c1931
14a819a
120b477
f6ca2e8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,84 @@ | ||||||
/* | ||||||
* 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.spark.sql.connector.catalog.index; | ||||||
|
||||||
import java.util.Map; | ||||||
import java.util.Properties; | ||||||
|
||||||
import org.apache.spark.annotation.Evolving; | ||||||
import org.apache.spark.sql.catalyst.analysis.IndexAlreadyExistsException; | ||||||
import org.apache.spark.sql.catalyst.analysis.NoSuchIndexException; | ||||||
import org.apache.spark.sql.catalyst.analysis.NoSuchTableException; | ||||||
import org.apache.spark.sql.connector.catalog.CatalogPlugin; | ||||||
import org.apache.spark.sql.connector.catalog.Identifier; | ||||||
import org.apache.spark.sql.connector.expressions.NamedReference; | ||||||
|
||||||
/** | ||||||
* Catalog methods for working with index | ||||||
* | ||||||
* @since 3.3.0 | ||||||
*/ | ||||||
@Evolving | ||||||
public interface SupportsIndex extends CatalogPlugin { | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. shall we follow There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nvm, index has a unique name. DROP INDEX does not need a table. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Actually, not all databases make index name globally unique, see https://www.w3schools.com/sql/sql_ref_drop_index.asp I think we can still make There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. After thinking more about it, I think This is also more flexible: the index name only need to be unique within the table. |
||||||
|
||||||
/** | ||||||
* Creates an index. | ||||||
* | ||||||
* @param indexName the name of the index to be created | ||||||
* @param indexType the IndexType of the index to be created | ||||||
* @param table the table on which index to be created | ||||||
* @param columns the columns on which index to be created | ||||||
* @param columnProperties the properties of the columns on which index to be created | ||||||
* @param properties the properties of the index to be created | ||||||
* @throws IndexAlreadyExistsException If the index already exists (optional) | ||||||
* @throws UnsupportedOperationException If create index is not a supported operation | ||||||
*/ | ||||||
void createIndex(String indexName, | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. For partitioned table, do we plan to support index creation on table level (for all partitions), or on individual partition level? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is up to the data source implementation. I think it makes more sense at file level (each data file has an index file). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I prefer to support index creation on individual partition level. For the existing data in the production environment, if only support index creation on table level, it is likely to be an impossible job for users. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sorry I think I didn't explain this clear: the index creation is actually done at the underlying data source. It's up to the data source's implementation on which level the index is created. For the implementation in file based data source, I believe the index is created at file level, not at table level or partition level. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks for your explain |
||||||
String indexType, | ||||||
Identifier table, | ||||||
NamedReference[] columns, | ||||||
Map<NamedReference, Properties>[] columnProperties, | ||||||
Properties properties) | ||||||
throws IndexAlreadyExistsException, UnsupportedOperationException; | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. removed |
||||||
|
||||||
/** | ||||||
* drops the index with the given name. | ||||||
* | ||||||
* @param indexName the name of the index to be dropped. | ||||||
* @return true if the index is dropped | ||||||
* @throws NoSuchIndexException If the index does not exist (optional) | ||||||
* @throws UnsupportedOperationException If drop index is not a supported operation | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ditto |
||||||
*/ | ||||||
boolean dropIndex(String indexName) throws NoSuchIndexException, UnsupportedOperationException; | ||||||
|
||||||
/** | ||||||
* Checks whether an index exists. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed |
||||||
* | ||||||
* @param indexName the name of the index | ||||||
* @return true if the index exists, false otherwise | ||||||
*/ | ||||||
boolean indexExists(String indexName); | ||||||
|
||||||
/** | ||||||
* Lists all the indexes in a table. | ||||||
* | ||||||
* @param table the table to be checked on for indexes | ||||||
* @throws NoSuchTableException | ||||||
*/ | ||||||
TableIndex[] listIndexes(Identifier table) throws NoSuchTableException; | ||||||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
/* | ||
* 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.spark.sql.connector.catalog.index; | ||
|
||
import org.apache.spark.annotation.Evolving; | ||
import org.apache.spark.sql.connector.catalog.Identifier; | ||
import org.apache.spark.sql.connector.expressions.NamedReference; | ||
|
||
import java.util.Collections; | ||
import java.util.Map; | ||
import java.util.Properties; | ||
|
||
/** | ||
* Index in a table | ||
* | ||
* @since 3.3.0 | ||
*/ | ||
@Evolving | ||
public final class TableIndex { | ||
private String indexName; | ||
private String indexType; | ||
private Identifier table; | ||
private NamedReference[] columns; | ||
private Map<NamedReference, Properties> columnProperties = Collections.emptyMap(); | ||
private Properties properties; | ||
|
||
public TableIndex( | ||
String indexName, | ||
String indexType, | ||
Identifier table, | ||
NamedReference[] columns, | ||
Map<NamedReference, Properties> columnProperties, | ||
Properties properties) { | ||
this.indexName = indexName; | ||
this.indexType = indexType; | ||
this.table = table; | ||
this.columns = columns; | ||
this.columnProperties = columnProperties; | ||
this.properties = properties; | ||
} | ||
|
||
/** | ||
* @return the Index name. | ||
*/ | ||
String indexName() { return indexName; } | ||
|
||
/** | ||
* @return the indexType of this Index. | ||
*/ | ||
String indexType() { return indexType; } | ||
|
||
/** | ||
* @return the table this Index is on. | ||
*/ | ||
Identifier table() { return table; } | ||
|
||
/** | ||
* @return the column(s) this Index is on. Could be multi columns (a multi-column index). | ||
*/ | ||
NamedReference[] columns() { return columns; } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
||
/** | ||
* @return the map of column and column property map. | ||
*/ | ||
Map<NamedReference, Properties> columnProperties() { return columnProperties; } | ||
|
||
/** | ||
* Returns the index properties. | ||
*/ | ||
Properties properties() { | ||
return properties; | ||
} | ||
|
||
Properties columnProperties(NamedReference column) { return columnProperties.get(column); } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. do we need this API? people can just get all the column properties as a map and do whatever they want to. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed. Thanks! |
||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we refine the classdoc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed. Thanks