Add when stale behavior in ConnectorMaterializedViewDefinition

This is a preparatory change that allows connectors to store information
about the WHEN STALE behavior. The option cannot yet be used in practice,
as execution will still fail with a NOT_SUPPORTED error.

Author: piotrrzysko

core/trino-main/src/main/java/io/trino/execution/CreateMaterializedViewTask.java

@@ -27,6 +27,7 @@
 import io.trino.metadata.ViewColumn;
 import io.trino.security.AccessControl;
 import io.trino.spi.TrinoException;
+import io.trino.spi.connector.ConnectorMaterializedViewDefinition.WhenStaleBehavior;
 import io.trino.spi.type.Type;
 import io.trino.sql.PlannerContext;
 import io.trino.sql.analyzer.Analysis;
@@ -55,6 +56,7 @@
 import static io.trino.spi.StandardErrorCode.NOT_SUPPORTED;
 import static io.trino.spi.StandardErrorCode.TYPE_MISMATCH;
 import static io.trino.spi.connector.ConnectorCapabilities.MATERIALIZED_VIEW_GRACE_PERIOD;
+import static io.trino.spi.connector.ConnectorCapabilities.MATERIALIZED_VIEW_WHEN_STALE_BEHAVIOR;
 import static io.trino.sql.SqlFormatterUtil.getFormattedSql;
 import static io.trino.sql.analyzer.ConstantEvaluator.evaluateConstant;
 import static io.trino.sql.analyzer.SemanticExceptions.semanticException;
@@ -156,12 +158,21 @@ Analysis executeInternal(
                     return Duration.ofMillis(milliseconds);
                 });
 
+        Optional<WhenStaleBehavior> whenStale = statement.getWhenStaleBehavior()
+                .map(_ -> {
+                    if (!plannerContext.getMetadata().getConnectorCapabilities(session, catalogHandle).contains(MATERIALIZED_VIEW_WHEN_STALE_BEHAVIOR)) {
+                        throw semanticException(NOT_SUPPORTED, statement, "Catalog '%s' does not support WHEN STALE", catalogName);
+                    }
+                    throw semanticException(NOT_SUPPORTED, statement, "WHEN STALE is not supported yet");
+                });
+
         MaterializedViewDefinition definition = new MaterializedViewDefinition(
                 sql,
                 session.getCatalog(),
                 session.getSchema(),
                 columns,
                 gracePeriod,
+                whenStale,
                 statement.getComment(),
                 session.getIdentity(),
                 session.getPath().getPath().stream()

core/trino-main/src/main/java/io/trino/metadata/MaterializedViewDefinition.java

@@ -16,6 +16,7 @@
 import io.trino.spi.connector.CatalogSchemaName;
 import io.trino.spi.connector.CatalogSchemaTableName;
 import io.trino.spi.connector.ConnectorMaterializedViewDefinition;
+import io.trino.spi.connector.ConnectorMaterializedViewDefinition.WhenStaleBehavior;
 import io.trino.spi.security.Identity;
 
 import java.time.Duration;
@@ -31,6 +32,7 @@ public class MaterializedViewDefinition
         extends ViewDefinition
 {
     private final Optional<Duration> gracePeriod;
+    private final Optional<WhenStaleBehavior> whenStaleBehavior;
     private final Optional<CatalogSchemaTableName> storageTable;
 
     public MaterializedViewDefinition(
@@ -39,6 +41,7 @@ public MaterializedViewDefinition(
             Optional<String> schema,
             List<ViewColumn> columns,
             Optional<Duration> gracePeriod,
+            Optional<WhenStaleBehavior> whenStaleBehavior,
             Optional<String> comment,
             Identity owner,
             List<CatalogSchemaName> path,
@@ -47,6 +50,7 @@ public MaterializedViewDefinition(
         super(originalSql, catalog, schema, columns, comment, Optional.of(owner), path);
         this.gracePeriod = requireNonNull(gracePeriod, "gracePeriod is null");
         checkArgument(gracePeriod.isEmpty() || !gracePeriod.get().isNegative(), "gracePeriod cannot be negative: %s", gracePeriod);
+        this.whenStaleBehavior = requireNonNull(whenStaleBehavior, "whenStaleBehavior is null");
         this.storageTable = requireNonNull(storageTable, "storageTable is null");
     }
 
@@ -55,6 +59,11 @@ public Optional<Duration> getGracePeriod()
         return gracePeriod;
     }
 
+    public Optional<WhenStaleBehavior> getWhenStaleBehavior()
+    {
+        return whenStaleBehavior;
+    }
+
     public Optional<CatalogSchemaTableName> getStorageTable()
     {
         return storageTable;
@@ -71,6 +80,7 @@ public ConnectorMaterializedViewDefinition toConnectorMaterializedViewDefinition
                         .map(column -> new ConnectorMaterializedViewDefinition.Column(column.name(), column.type(), column.comment()))
                         .collect(toImmutableList()),
                 getGracePeriod(),
+                whenStaleBehavior,
                 getComment(),
                 getRunAsIdentity().map(Identity::getUser),
                 getPath());
@@ -85,6 +95,7 @@ public String toString()
                 .add("schema", getSchema().orElse(null))
                 .add("columns", getColumns())
                 .add("gracePeriod", gracePeriod.orElse(null))
+                .add("whenStaleBehavior", whenStaleBehavior.orElse(null))
                 .add("comment", getComment().orElse(null))
                 .add("runAsIdentity", getRunAsIdentity())
                 .add("path", getPath())

core/trino-main/src/main/java/io/trino/metadata/MetadataManager.java

@@ -1827,6 +1827,7 @@ private static MaterializedViewDefinition createMaterializedViewDefinition(Conne
                         .map(column -> new ViewColumn(column.getName(), column.getType(), Optional.empty()))
                         .collect(toImmutableList()),
                 view.getGracePeriod(),
+                view.getWhenStaleBehavior(),
                 view.getComment(),
                 runAsIdentity,
                 view.getPath(),

core/trino-main/src/main/java/io/trino/sql/analyzer/StatementAnalyzer.java

@@ -1486,9 +1486,6 @@ protected Scope visitCreateMaterializedView(CreateMaterializedView node, Optiona
                 }
                 analyzeExpression(gracePeriod, Scope.create());
             });
-            if (node.getWhenStaleBehavior().isPresent()) {
-                throw new TrinoException(NOT_SUPPORTED, "WHEN STALE is not supported yet");
-            }
 
             // analyze the query that creates the view
             StatementAnalyzer analyzer = statementAnalyzerFactory.createStatementAnalyzer(analysis, session, warningCollector, CorrelationSupport.ALLOWED);

core/trino-main/src/test/java/io/trino/execution/BaseDataDefinitionTaskTest.java

@@ -205,6 +205,7 @@ protected MaterializedViewDefinition someMaterializedView(String sql, List<ViewC
                 columns,
                 Optional.empty(),
                 Optional.empty(),
+                Optional.empty(),
                 Identity.ofUser("owner"),
                 ImmutableList.of(),
                 Optional.empty());
@@ -591,6 +592,7 @@ public void setMaterializedViewColumnComment(Session session, QualifiedObjectNam
                                     .map(currentViewColumn -> columnName.equals(currentViewColumn.name()) ? new ViewColumn(currentViewColumn.name(), currentViewColumn.type(), comment) : currentViewColumn)
                                     .collect(toImmutableList()),
                             view.getGracePeriod(),
+                            view.getWhenStaleBehavior(),
                             view.getComment(),
                             view.getRunAsIdentity().get(),
                             view.getPath(),

core/trino-main/src/test/java/io/trino/sql/analyzer/TestAnalyzer.java

@@ -7899,6 +7899,7 @@ public void setup()
                 Optional.of("s1"),
                 ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty())),
                 Optional.of(Duration.ZERO),
+                Optional.empty(),
                 Optional.of("comment"),
                 Identity.ofUser("user"),
                 ImmutableList.of(),
@@ -8029,6 +8030,7 @@ public void setup()
                         ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty())),
                         Optional.of(Duration.ZERO),
                         Optional.empty(),
+                        Optional.empty(),
                         Identity.ofUser("some user"),
                         ImmutableList.of(),
                         Optional.of(new CatalogSchemaTableName(TPCH_CATALOG, "s1", "t1"))),
@@ -8083,6 +8085,7 @@ public void setup()
                         ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty()), new ViewColumn("b", BIGINT.getTypeId(), Optional.empty())),
                         Optional.empty(),
                         Optional.empty(),
+                        Optional.empty(),
                         Identity.ofUser("some user"),
                         ImmutableList.of(),
                         // t3 has a, b column and hidden column x
@@ -8103,6 +8106,7 @@ public void setup()
                         ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty())),
                         Optional.empty(),
                         Optional.empty(),
+                        Optional.empty(),
                         Identity.ofUser("some user"),
                         ImmutableList.of(),
                         Optional.of(new CatalogSchemaTableName(TPCH_CATALOG, "s1", "t2"))),
@@ -8122,6 +8126,7 @@ public void setup()
                         ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty()), new ViewColumn("c", BIGINT.getTypeId(), Optional.empty())),
                         Optional.empty(),
                         Optional.empty(),
+                        Optional.empty(),
                         Identity.ofUser("some user"),
                         ImmutableList.of(),
                         Optional.of(new CatalogSchemaTableName(TPCH_CATALOG, "s1", "t2"))),
@@ -8141,6 +8146,7 @@ public void setup()
                         ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty()), new ViewColumn("b", RowType.anonymousRow(TINYINT).getTypeId(), Optional.empty())),
                         Optional.empty(),
                         Optional.empty(),
+                        Optional.empty(),
                         Identity.ofUser("some user"),
                         ImmutableList.of(),
                         Optional.of(new CatalogSchemaTableName(TPCH_CATALOG, "s1", "t2"))),

core/trino-main/src/test/java/io/trino/sql/planner/TestMaterializedViews.java

@@ -186,6 +186,7 @@ protected PlanTester createPlanTester()
                 ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty()), new ViewColumn("b", BIGINT.getTypeId(), Optional.empty())),
                 Optional.of(STALE_MV_STALENESS.plusHours(1)),
                 Optional.empty(),
+                Optional.empty(),
                 Identity.ofUser("some user"),
                 ImmutableList.of(),
                 Optional.of(new CatalogSchemaTableName(TEST_CATALOG_NAME, SCHEMA, "storage_table")));
@@ -220,6 +221,7 @@ protected PlanTester createPlanTester()
                 ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty()), new ViewColumn("b", BIGINT.getTypeId(), Optional.empty())),
                 Optional.empty(),
                 Optional.empty(),
+                Optional.empty(),
                 Identity.ofUser("some user"),
                 ImmutableList.of(),
                 Optional.of(new CatalogSchemaTableName(TEST_CATALOG_NAME, SCHEMA, "storage_table_with_casts")));
@@ -254,6 +256,7 @@ protected PlanTester createPlanTester()
                 ImmutableList.of(new ViewColumn("id", BIGINT.getTypeId(), Optional.empty()), new ViewColumn("ts", timestampWithTimezone3.getTypeId(), Optional.empty())),
                 Optional.empty(),
                 Optional.empty(),
+                Optional.empty(),
                 Identity.ofUser("some user"),
                 ImmutableList.of(),
                 Optional.of(new CatalogSchemaTableName(TEST_CATALOG_NAME, SCHEMA, "timestamp_test_storage")));
@@ -285,6 +288,7 @@ private void createMaterializedView(String materializedViewName, String query)
                 ImmutableList.of(new ViewColumn("a", BIGINT.getTypeId(), Optional.empty()), new ViewColumn("b", BIGINT.getTypeId(), Optional.empty())),
                 Optional.of(STALE_MV_STALENESS.plusHours(1)),
                 Optional.empty(),
+                Optional.empty(),
                 Identity.ofUser("some user"),
                 ImmutableList.of(),
                 Optional.of(new CatalogSchemaTableName(TEST_CATALOG_NAME, SCHEMA, "storage_table")));

core/trino-main/src/test/java/io/trino/sql/query/TestColumnMask.java

@@ -133,6 +133,7 @@ public TestColumnMask()
                         new ConnectorMaterializedViewDefinition.Column("comment", VarcharType.createVarcharType(152).getTypeId(), Optional.empty())),
                 Optional.of(Duration.ZERO),
                 Optional.empty(),
+                Optional.empty(),
                 Optional.of(VIEW_OWNER),
                 ImmutableList.of());
 
@@ -148,6 +149,7 @@ public TestColumnMask()
                         new ConnectorMaterializedViewDefinition.Column("comment", VarcharType.createVarcharType(152).getTypeId(), Optional.empty())),
                 Optional.of(Duration.ZERO),
                 Optional.empty(),
+                Optional.empty(),
                 Optional.of(VIEW_OWNER),
                 ImmutableList.of());
 
@@ -163,6 +165,7 @@ public TestColumnMask()
                         new ConnectorMaterializedViewDefinition.Column("comment", VarcharType.createVarcharType(152).getTypeId(), Optional.empty())),
                 Optional.of(Duration.ZERO),
                 Optional.empty(),
+                Optional.empty(),
                 Optional.of(VIEW_OWNER),
                 ImmutableList.of());
 

core/trino-main/src/test/java/io/trino/testing/TestTestingMetadata.java

@@ -61,6 +61,7 @@ private static ConnectorMaterializedViewDefinition someMaterializedView()
                 ImmutableList.of(new Column("test", BIGINT.getTypeId(), Optional.empty())),
                 Optional.of(Duration.ZERO),
                 Optional.empty(),
+                Optional.empty(),
                 Optional.of("owner"),
                 ImmutableList.of());
     }

core/trino-spi/pom.xml

@@ -297,6 +297,11 @@
                                     <old>method void io.trino.spi.block.PageBuilderStatus::&lt;init&gt;()</old>
                                     <justification>Method is unnecessary</justification>
                                 </item>
+                                <item>
+                                    <code>java.method.numberOfParametersChanged</code>
+                                    <old>method void io.trino.spi.connector.ConnectorMaterializedViewDefinition::&lt;init&gt;(java.lang.String, java.util.Optional&lt;io.trino.spi.connector.CatalogSchemaTableName&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.List&lt;io.trino.spi.connector.ConnectorMaterializedViewDefinition.Column&gt;, java.util.Optional&lt;java.time.Duration&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.List&lt;io.trino.spi.connector.CatalogSchemaName&gt;)</old>
+                                    <new>method void io.trino.spi.connector.ConnectorMaterializedViewDefinition::&lt;init&gt;(java.lang.String, java.util.Optional&lt;io.trino.spi.connector.CatalogSchemaTableName&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.List&lt;io.trino.spi.connector.ConnectorMaterializedViewDefinition.Column&gt;, java.util.Optional&lt;java.time.Duration&gt;, java.util.Optional&lt;io.trino.spi.connector.ConnectorMaterializedViewDefinition.WhenStaleBehavior&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.Optional&lt;java.lang.String&gt;, java.util.List&lt;io.trino.spi.connector.CatalogSchemaName&gt;)</new>
+                                </item>
                             </differences>
                         </revapi.differences>
                     </analysisConfiguration>