Skip to main content

Self-hosted Visibility feature setup

View Markdown

A Visibility store is set up as a part of your Persistence store to enable listing and filtering details about Workflow Executions that exist on your Temporal Service.

A Visibility store is required in a Temporal Service setup because it is used by Temporal Web UI and Temporal CLI to pull Workflow Execution data and enables features like batch operations on a group of Workflow Executions.

With the Visibility store, you can use List Filters with Search Attributes to list and filter Workflow Executions that you want to review or act upon.

Supported Visibility stores include:

  • Elasticsearch v7 with Temporal Server v1.7 and later
  • Elasticsearch v8 with Temporal Server v1.18 and later
  • OpenSearch 2+ with Temporal Server v1.30.1 and later
  • MySQL v8.0.17 and later with Temporal Server v1.20 and later
  • PostgreSQL v12 and later with Temporal Server v1.20 and later
  • SQLite v3.31.0 and later with Temporal Server v1.20 and later

Current and legacy Visibility support

Advanced Visibility is the current generation of Temporal Visibility. It supports the modern query model, including custom Search Attributes.

This page also includes guidance for the legacy (deprecated in Temporal Server v1.21 and removed in v1.24) standard Visibility model for older deployments and migration work. In this context, "advanced" and "standard (legacy)" refer to the current and legacy generations of Temporal Visibility, respectively.

The following compatibility matrix summarizes which generation of Visibility each store supports and the Temporal Server versions required:

StoreAdvanced Visibility (current)Standard Visibility (legacy)
Elasticsearch

Recommended for any setup that spawns more than a few Workflow Executions
v7 on Temporal Server v1.7+, v8 on Temporal Server v1.18+Not supported
OpenSearch2+ on Temporal Server v1.30.1+Not supported
MySQLv8.0.17+ on Temporal Server v1.20+v5.7+ on older deployments before Temporal Server v1.24
PostgreSQLv12+ on Temporal Server v1.20+v9.6+ on older deployments before Temporal Server v1.24
SQLitev3.31.0+ on Temporal Server v1.20+Not supported
CassandraNot supported.

To migrate from Cassandra to a supported advanced Visibility store, see Migrating Visibility database.
Deprecated in Temporal Server v1.21, removed in Temporal Server v1.24

You can use any combination of the supported databases for your Persistence and Visibility stores. For updates, check Server release notes.

Temporal Server v1.21 introduced support for a secondary Visibility store in your Temporal Service to enable Dual Visibility. This is useful for migrating your Visibility store database.