[FLINK-37407][state] Add savepoint metadata SQL built-in process function #26393
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,72 @@ | ||
| /* | ||
| * 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.flink.state.table; | ||
|
|
||
| import org.apache.flink.annotation.Internal; | ||
| import org.apache.flink.runtime.checkpoint.OperatorState; | ||
| import org.apache.flink.runtime.checkpoint.metadata.CheckpointMetadata; | ||
| import org.apache.flink.state.api.runtime.SavepointLoader; | ||
| import org.apache.flink.table.annotation.DataTypeHint; | ||
| import org.apache.flink.table.annotation.FunctionHint; | ||
| import org.apache.flink.table.functions.SpecializedFunction; | ||
| import org.apache.flink.table.functions.TableFunction; | ||
| import org.apache.flink.types.Row; | ||
|
|
||
| @Internal | ||
|
There was a problem hiding this comment. is this internal -as it is driven directly from SQL? There was a problem hiding this comment. Similar classes are having such annotation. |
||
| @FunctionHint( | ||
| output = | ||
| @DataTypeHint( | ||
| "ROW<checkpoint-id BIGINT NOT NULL, " | ||
| + "operator-name STRING, " | ||
| + "operator-uid STRING, operator-uid-hash STRING NOT NULL, " | ||
| + "operator-parallelism INT NOT NULL, " | ||
| + "operator-max-parallelism INT NOT NULL, " | ||
| + "operator-subtask-state-count INT NOT NULL, " | ||
| + "operator-coordinator-state-size-in-bytes BIGINT NOT NULL, " | ||
| + "operator-total-size-in-bytes BIGINT NOT NULL>")) | ||
| public class SavepointMetadataTableFunction extends TableFunction<Row> { | ||
| public SavepointMetadataTableFunction(SpecializedFunction.SpecializedContext context) {} | ||
|
|
||
| public void eval(String savepointPath) { | ||
| try { | ||
| CheckpointMetadata checkpointMetadata = | ||
| SavepointLoader.loadSavepointMetadata(savepointPath); | ||
|
|
||
| for (OperatorState operatorState : checkpointMetadata.getOperatorStates()) { | ||
| Row row = Row.withNames(); | ||
| row.setField("checkpoint-id", checkpointMetadata.getCheckpointId()); | ||
| row.setField("operator-name", operatorState.getOperatorName().orElse(null)); | ||
| row.setField("operator-uid", operatorState.getOperatorUid().orElse(null)); | ||
| row.setField("operator-uid-hash", operatorState.getOperatorID().toHexString()); | ||
| row.setField("operator-parallelism", operatorState.getParallelism()); | ||
| row.setField("operator-max-parallelism", operatorState.getMaxParallelism()); | ||
| row.setField("operator-subtask-state-count", operatorState.getStates().size()); | ||
|
Comment on lines
+57
to
+59
There was a problem hiding this comment. Ah, is There was a problem hiding this comment. No, for example broadcast source has There was a problem hiding this comment. Thus I suggest adding a more detailed description for There was a problem hiding this comment. Yeah, this is a hidden gem and worth to add some more info. Your understanding is correct so I would add your sentence as-is. |
||
| row.setField( | ||
| "operator-coordinator-state-size-in-bytes", | ||
| operatorState.getCoordinatorState() != null | ||
| ? operatorState.getCoordinatorState().getStateSize() | ||
| : 0L); | ||
| row.setField("operator-total-size-in-bytes", operatorState.getCheckpointedSize()); | ||
| collect(row); | ||
| } | ||
| } catch (Exception e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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,123 @@ | ||
| /* | ||
| * 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.flink.state.table.module; | ||
|
|
||
| import org.apache.flink.annotation.Experimental; | ||
| import org.apache.flink.state.table.SavepointMetadataTableFunction; | ||
| import org.apache.flink.table.api.DataTypes; | ||
| import org.apache.flink.table.functions.BuiltInFunctionDefinition; | ||
| import org.apache.flink.table.functions.FunctionDefinition; | ||
| import org.apache.flink.table.module.Module; | ||
| import org.apache.flink.table.types.inference.TypeStrategies; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.function.Function; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static org.apache.flink.table.functions.FunctionKind.TABLE; | ||
|
|
||
| /** Module of state in Flink. */ | ||
|
There was a problem hiding this comment. we should mention savepoint if this is only savepoint There was a problem hiding this comment. Not only. As mentioned before everything is called |
||
| @Experimental | ||
| public class StateModule implements Module { | ||
|
There was a problem hiding this comment. I suggest we rename SavepointStateModule so it is more descriptive |
||
|
|
||
| public static final String IDENTIFIER = "state"; | ||
|
There was a problem hiding this comment. I think the identified should mention the word savepoint maybe "savepoint-state" |
||
|
|
||
| public static final BuiltInFunctionDefinition SAVEPOINT_METADATA = | ||
| BuiltInFunctionDefinition.newBuilder() | ||
| .name("savepoint_metadata") | ||
| .kind(TABLE) | ||
| .runtimeClass(SavepointMetadataTableFunction.class.getName()) | ||
| .outputTypeStrategy( | ||
| TypeStrategies.explicit( | ||
| DataTypes.ROW( | ||
| DataTypes.FIELD( | ||
| "checkpoint-id", DataTypes.BIGINT().notNull()), | ||
| DataTypes.FIELD("operator-name", DataTypes.STRING()), | ||
| DataTypes.FIELD("operator-uid", DataTypes.STRING()), | ||
| DataTypes.FIELD( | ||
| "operator-uid-hash", | ||
| DataTypes.STRING().notNull()), | ||
| DataTypes.FIELD( | ||
| "operator-parallelism", | ||
| DataTypes.INT().notNull()), | ||
| DataTypes.FIELD( | ||
| "operator-max-parallelism", | ||
| DataTypes.INT().notNull()), | ||
| DataTypes.FIELD( | ||
| "operator-subtask-state-count", | ||
| DataTypes.INT().notNull()), | ||
| DataTypes.FIELD( | ||
| "operator-coordinator-state-size-in-bytes", | ||
| DataTypes.BIGINT().notNull()), | ||
| DataTypes.FIELD( | ||
| "operator-total-size-in-bytes", | ||
| DataTypes.BIGINT().notNull())))) | ||
| .build(); | ||
|
|
||
| public static final StateModule INSTANCE = new StateModule(); | ||
|
|
||
| private final Map<String, BuiltInFunctionDefinition> normalizedFunctions; | ||
| private final Set<String> functionNamesWithInternal; | ||
| private final Set<String> functionNamesWithoutInternal; | ||
|
|
||
| private StateModule() { | ||
| final List<BuiltInFunctionDefinition> definitions = | ||
| Collections.singletonList(SAVEPOINT_METADATA); | ||
| this.normalizedFunctions = | ||
| definitions.stream() | ||
| .collect( | ||
| Collectors.toMap( | ||
| f -> f.getName().toUpperCase(Locale.ROOT), | ||
| Function.identity())); | ||
| this.functionNamesWithInternal = | ||
| definitions.stream() | ||
| .map(BuiltInFunctionDefinition::getName) | ||
| .collect(Collectors.toSet()); | ||
| this.functionNamesWithoutInternal = | ||
| definitions.stream() | ||
| .filter(f -> !f.isInternal()) | ||
| .map(BuiltInFunctionDefinition::getName) | ||
| .collect(Collectors.toSet()); | ||
| } | ||
|
|
||
| @Override | ||
| public Set<String> listFunctions() { | ||
| return listFunctions(false); | ||
| } | ||
|
|
||
| @Override | ||
| public Set<String> listFunctions(boolean includeHiddenFunctions) { | ||
| if (includeHiddenFunctions) { | ||
| return functionNamesWithInternal; | ||
| } else { | ||
| return functionNamesWithoutInternal; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Optional<FunctionDefinition> getFunctionDefinition(String name) { | ||
| final String normalizedName = name.toUpperCase(Locale.ROOT); | ||
| return Optional.ofNullable(normalizedFunctions.get(normalizedName)); | ||
| } | ||
| } | ||
This file contains hidden or 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,52 @@ | ||
| /* | ||
| * 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.flink.state.table.module; | ||
|
|
||
| import org.apache.flink.annotation.Internal; | ||
| import org.apache.flink.configuration.ConfigOption; | ||
| import org.apache.flink.table.factories.ModuleFactory; | ||
| import org.apache.flink.table.module.Module; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.Set; | ||
|
|
||
| /** Factory for {@link StateModule}. */ | ||
| @Internal | ||
| public class StateModuleFactory implements ModuleFactory { | ||
|
|
||
| @Override | ||
| public String factoryIdentifier() { | ||
| return StateModule.IDENTIFIER; | ||
| } | ||
|
|
||
| @Override | ||
| public Set<ConfigOption<?>> requiredOptions() { | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| @Override | ||
| public Set<ConfigOption<?>> optionalOptions() { | ||
| return Collections.emptySet(); | ||
| } | ||
|
|
||
| @Override | ||
| public Module createModule(Context context) { | ||
| return StateModule.INSTANCE; | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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 hidden or 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,61 @@ | ||
| /* | ||
| * 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.flink.state.table; | ||
|
|
||
| import org.apache.flink.api.common.RuntimeExecutionMode; | ||
| import org.apache.flink.configuration.Configuration; | ||
| import org.apache.flink.streaming.api.environment.StreamExecutionEnvironment; | ||
| import org.apache.flink.table.api.Table; | ||
| import org.apache.flink.table.api.bridge.java.StreamTableEnvironment; | ||
| import org.apache.flink.types.Row; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.util.Comparator; | ||
| import java.util.Iterator; | ||
| import java.util.List; | ||
|
|
||
| import static org.apache.flink.configuration.ExecutionOptions.RUNTIME_MODE; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| /** Unit tests for the savepoint metadata SQL reader. */ | ||
| public class SavepointMetadataDynamicTableSourceTest { | ||
| @Test | ||
| public void testReadMetadata() throws Exception { | ||
| Configuration config = new Configuration(); | ||
| config.set(RUNTIME_MODE, RuntimeExecutionMode.BATCH); | ||
| StreamExecutionEnvironment env = StreamExecutionEnvironment.getExecutionEnvironment(config); | ||
| StreamTableEnvironment tEnv = StreamTableEnvironment.create(env); | ||
|
|
||
| tEnv.executeSql("LOAD MODULE state"); | ||
| Table table = | ||
| tEnv.sqlQuery("SELECT * FROM savepoint_metadata('src/test/resources/table-state')"); | ||
| List<Row> result = tEnv.toDataStream(table).executeAndCollect(100); | ||
| result.sort(Comparator.comparing(a -> ((String) a.getField("operator-uid-hash")))); | ||
|
|
||
| assertThat(result.size()).isEqualTo(7); | ||
| Iterator<Row> it = result.iterator(); | ||
| assertThat(it.next().toString()) | ||
| .isEqualTo( | ||
| "+I[2, Source: broadcast-source, broadcast-source-uid, 3a6f51704798c4f418be51bfb6813b77, 1, 128, 0, 0, 0]"); | ||
| assertThat(it.next().toString()) | ||
| .isEqualTo( | ||
| "+I[2, keyed-broadcast-process, keyed-broadcast-process-uid, 413c1d6f88ee8627fe4b8bc533b4cf1b, 2, 128, 2, 0, 4548]"); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
nit: if this is savepoints only ; should we call it savepoint-state. Currently the implementation seems to be tied to a fixed savepoint schema. savepoint-state would be more descriptive and better scoped - allowing us to provide a more generic state module later - if we want to.
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.
Seems like all the rest of the questions related
is savepoint only?. My answer to all of them is no. We've agreed on this naming in the discussion.