Skip to content

[FLINK-40843] State Catalog docs - #29992

Open
gyfora wants to merge 1 commit into
apache:masterfrom
gyfora:FLINK-40843
Open

gyfora wants to merge 1 commit into
apache:masterfrom
gyfora:FLINK-40843

Conversation

@gyfora

@gyfora gyfora commented Nov 17, 2026

Copy link
Copy Markdown
Contributor

What is the purpose of the change

State Catalog basic user facing documentation

image image image image

Verifying this change

Built locally

Does this pull request potentially affect one of the following parts:

  • Dependencies (does it add or upgrade a dependency): no
  • The public API, i.e., is any changed class annotated with @Public(Evolving): no
  • The serializers: no
  • The runtime per-record code paths (performance sensitive):no
  • Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn, ZooKeeper: no
  • The S3 file system connector: no

Documentation

Doc only pr


Was generative AI tooling used to co-author this PR?
  • Yes

Generated-by: Claude Opus 5

@gyfora
gyfora requested a review from RocMarshal November 17, 2026 13:49
@flinkbot

flinkbot commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

@RocMarshal RocMarshal left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @gyfora .
LGTM +1, just a comment.
PTAL when you have the free time

@gyfora

gyfora commented Nov 17, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @gyfora . LGTM +1, just a comment. PTAL when you have the free time

Did you add a comment somewhere?

The `state` catalog is a read-only catalog that finds savepoints and checkpoints in one or more directories and exposes their state as tables.
Table schemas are inferred from the snapshot, so you don't need `CREATE TABLE` statements or the job's POJO or Avro classes on the classpath.

The catalog is part of `flink-state-processor-api`. For the SQL Client, copy the jar from `opt/` to `lib/`.

@RocMarshal RocMarshal Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
The catalog is part of `flink-state-processor-api`. For the SQL Client, copy the jar from `opt/` to `lib/`.
The catalog is part of `flink-state-processor-api`. For the SQL Client, copy the jar from `${FLINK_HOME}/opt/` to `${FLINK_HOME}/lib/`.

@RocMarshal

Copy link
Copy Markdown
Contributor

Thanks @gyfora . LGTM +1, just a comment. PTAL when you have the free time

Did you add a comment somewhere?

Thanks for your reminder & Sorry for ignoring submtting before.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants