Skip to content

Commit efd597b

Browse files
authored
visibility pg refactor (#5039)
* visibility pg split * change header levels and less duplication * Remove in this guide Removed the guide section TOC listing various visibility stores.
1 parent 344099d commit efd597b

15 files changed

Lines changed: 1175 additions & 1046 deletions

File tree

docs/encyclopedia/visibility/dual-visibility.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This page discusses [Dual Visibility](#dual-visibility).
2121
## What is Dual Visibility? {/* #dual-visibility */}
2222

2323
Dual Visibility is a feature that lets you set a secondary Visibility store in addition to a primary store in your Temporal Service.
24-
Setting up Dual Visibility is optional and can be used to [migrate your Visibility database](/self-hosted-guide/visibility#migrating-visibility-database) or create a backup Visibility store.
24+
Setting up Dual Visibility is optional and can be used to [migrate your Visibility database](/self-hosted-guide/visibility/migrate) or create a backup Visibility store.
2525

2626
For example, if you have Cassandra configured as your Visibility database, you can set up a supported SQL database as your secondary Visibility store and gradually migrate your data to the secondary store before deprecating your primary one.
2727

@@ -30,7 +30,7 @@ A Dual Visibility setup requires two Visibility store configurations:
3030
- **Primary Visibility:** The primary Visibility store where Visibility data is written to and read from by default. The primary Visibility store is set with the `visibilityStore` configuration key in your Temporal Service.
3131
- **Secondary Visibility:** A secondary storage for your Visibility data. The secondary Visibility store is set with the `secondaryVisibilityStore` configuration key in your Temporal Service.
3232

33-
For configuration details, see [Dual Visibility setup](/self-hosted-guide/visibility#dual-visibility).
33+
For configuration details, see [Dual Visibility setup](/self-hosted-guide/visibility/dual-visibility).
3434

3535
The following combinations are allowed in a Dual Visibility setting.
3636

@@ -44,4 +44,4 @@ With Dual Visibility, you can read from only one Visibility store at a time, but
4444
When migrating from one Visibility store database to another, set up the database you want to migrate to as your secondary Visibility store.
4545

4646
You can plan your migration using specific dynamic configuration keys that help you transition your read and write operations from the primary to the secondary Visibility store.
47-
For details on migrating your Visibility store databases, see [Dual Visibility](/self-hosted-guide/visibility#dual-visibility).
47+
For details on migrating your Visibility store databases, see [Dual Visibility](/self-hosted-guide/visibility/dual-visibility).

docs/encyclopedia/visibility/list-filter.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ A List Filter includes [Search Attribute](/search-attribute) names, Search Attri
2727
List Filter [Search Attribute](/search-attribute) names are case sensitive.
2828
A single [Namespace](/namespaces) scopes each List Filter.
2929

30-
A List Filter using a time range provides a resolution of 1 ns on [Elasticsearch](/self-hosted-guide/visibility#elasticsearch) and 1 µs for [SQL databases](/self-hosted-guide/visibility).
30+
A List Filter using a time range provides a resolution of 1 ns on [Elasticsearch](/self-hosted-guide/visibility/elasticsearch) and 1 µs for [SQL databases](/self-hosted-guide/visibility).
3131

3232
### Supported operators
3333

docs/encyclopedia/visibility/search-attributes.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,14 +127,14 @@ You can use the default Search Attributes in a List Filter, such as in the Tempo
127127

128128
### Custom Search Attributes {/* #custom-search-attribute */}
129129

130-
You can [create custom Search Attributes](/self-hosted-guide/visibility#create-custom-search-attributes) with unique key names that are relevant to your business needs.
130+
You can [create custom Search Attributes](/self-hosted-guide/visibility/custom-search-attributes#create-custom-search-attributes) with unique key names that are relevant to your business needs.
131131

132132
Use custom Search Attributes in a List Filter, such as in the Temporal Web UI or with the `temporal workflow list` commands, under the following conditions:
133133

134134
- Without advanced Visibility, you cannot use a custom Search Attribute in your List Filter.
135135
- With advanced Visibility, you can create multiple custom Search Attributes and use them in combinations with List Filters to get a list of specific Workflow Executions.
136136
For example: `temporal workflow list --query "WorkflowType = 'main.YourWorkflowDefinition' and YourCustomSA = 'YourCustomSAValue' and (StartTime > '2022-06-07T16:46:34.236-08:00' or CloseTime < '2022-06-08T16:46:34-08:00')"`
137-
- With Temporal Server v1.19 and earlier, you must [integrate Elasticsearch](/self-hosted-guide/visibility#elasticsearch) to use custom Search Attributes with List Filters.
137+
- With Temporal Server v1.19 and earlier, you must [integrate Elasticsearch](/self-hosted-guide/visibility/elasticsearch) to use custom Search Attributes with List Filters.
138138
- With Temporal Server v1.20 and later, custom Search Attribute capabilities are available on MySQL (v8.0.17 or later), PostgreSQL (v12 and later), and SQLite (v3.31.0 and later), in addition to Elasticsearch.
139139

140140
If you use Elasticsearch as your Visibility store, your custom Search Attributes apply globally and can be used across Namespaces.
@@ -256,8 +256,8 @@ For Temporal Cloud specific configurations, see the [Defaults, limits, and confi
256256
Search Attributes available in your Visibility store can be used with Workflow Executions for the Temporal Service.
257257
To actually have results from the use of a [List Filter](/list-filter), Search Attributes must be added to a Workflow Execution as metadata.
258258

259-
- To create custom Search Attributes in your Visibility store, see [Create custom Search Attributes](/self-hosted-guide/visibility#create-custom-search-attributes).
260-
- To remove a custom Search Attribute from the Visibility store, see [Remove custom Search Attributes](/self-hosted-guide/visibility#remove-custom-search-attributes).
259+
- To create custom Search Attributes in your Visibility store, see [Create custom Search Attributes](/self-hosted-guide/visibility/custom-search-attributes#create-custom-search-attributes).
260+
- To remove a custom Search Attribute from the Visibility store, see [Remove custom Search Attributes](/self-hosted-guide/visibility/custom-search-attributes#remove-custom-search-attributes).
261261
Removing custom Search Attributes is not supported on Temporal Cloud.
262262
- To rename a custom Search Attribute on Temporal Cloud, see [`tcld namespace search-attributes rename`](/cloud/tcld/namespace/#rename).
263263

docs/encyclopedia/visibility/visibility.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,4 +89,4 @@ Prior to Temporal Server v1.20, Temporal had two Visibility modes: "standard" an
8989

9090
Starting with Temporal Server v1.20, advanced Visibility became available on SQL databases. Standard Visibility was deprecated in v1.21 and removed in v1.24. All current deployments use what was formerly called advanced Visibility, now simply called Visibility.
9191

92-
If you are running a Temporal Server version older than v1.24, see the [legacy standard Visibility section](/self-hosted-guide/visibility#legacy-standard-visibility) in the self-hosted guide.
92+
If you are running a Temporal Server version older than v1.24, see the [legacy standard Visibility section](/self-hosted-guide/visibility/legacy-standard) in the self-hosted guide.

0 commit comments

Comments
 (0)