From 7cfdb93ff2aea4c4916b394fb943dbcd0f80fe16 Mon Sep 17 00:00:00 2001 From: ShahabT Date: Thu, 30 Apr 2026 16:02:21 -0700 Subject: [PATCH 1/2] Deprecate BuildIds search attribute --- .../visibility/search-attributes.mdx | 62 +++++++++++-------- 1 file changed, 37 insertions(+), 25 deletions(-) diff --git a/docs/encyclopedia/visibility/search-attributes.mdx b/docs/encyclopedia/visibility/search-attributes.mdx index da2ddad215..f0115bfc37 100644 --- a/docs/encyclopedia/visibility/search-attributes.mdx +++ b/docs/encyclopedia/visibility/search-attributes.mdx @@ -62,31 +62,43 @@ A Temporal Service has a set of default Search Attributes already available. Default Search Attributes are set globally in any Namespace. These Search Attributes are created when the initial index is created. -| NAME | TYPE | DEFINITION | -| ---------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| BatcherUser | Keyword | Used by internal batcher Workflow that runs in `TemporalBatcher` Namespace division to indicate the user who started the batch operation. | -| BinaryChecksums | Keyword List | List of binary Ids of Workers that run the Workflow Execution. Deprecated since server version 1.21 in favor of the `BuildIds` search attribute. | -| BuildIds | Keyword List | List of Worker Build Ids that have processed the Workflow Execution, formatted as `versioned:{BuildId}` or `unversioned:{BuildId}`, or the sentinel `unversioned` value. Available from server version 1.21. | -| CloseTime | Datetime | The time at which the Workflow Execution completed. | -| ExecutionDuration | Int | The time needed to run the Workflow Execution (in nanoseconds). Available only for closed Workflows. | -| ExecutionStatus | Keyword | The current state of the Workflow Execution. | -| ExecutionTime | Datetime | The time at which the Workflow Execution actually begins running; same as `StartTime` for most cases but different for Cron Workflows and retried Workflows. | -| HistoryLength | Int | The number of events in the history of Workflow Execution. Available only for closed Workflows. | -| HistorySizeBytes | Long | The size of the Event History. | -| RunId | Keyword | Identifies the current Workflow Execution Run. | -| StartTime | Datetime | The time at which the Workflow Execution started. | -| StateTransitionCount | Int | The number of times that Workflow Execution has persisted its state. Available only for closed Workflows. | -| TaskQueue | Keyword | Task Queue used by Workflow Execution. | -| TemporalChangeVersion | Keyword List | Stores change/version pairs if the GetVersion API is enabled. | -| TemporalReportedProblems | Keyword List | Stores information about Workflow task failures. Formatted as `category= cause=`. -| TemporalScheduledStartTime | Datetime | The time that the Workflow is schedule to start according to the Schedule Spec. Can be manually triggered. Set on Schedules. | -| TemporalScheduledById | Keyword | The Id of the Schedule that started the Workflow. | -| TemporalSchedulePaused | Boolean | Indicates whether the Schedule has been paused. Set on Schedules. | -| TemporalWorkerDeployment | Keyword | Indicates the name of the associated Worker Deployment. | -| TemporalWorkerDeploymentVersion | Keyword | Indicates the Version string of the associated Worker Deployment, in the format `:`. | -| TemporalWorkflowVersioningBehavior | Keyword | Indicates the associated Worker Versioning behavior ("Pinned", "Auto-Upgrade", or null if not using Worker Versioning). | -| WorkflowId | Keyword | Identifies the Workflow Execution. | -| WorkflowType | Keyword | The type of Workflow. | +| NAME | TYPE | DEFINITION | +|--------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BatcherUser | Keyword | Used by internal batcher Workflow that runs in `TemporalBatcher` Namespace division to indicate the user who started the batch operation. | +| ~BinaryChecksums~ | Keyword List | List of binary Ids of Workers that run the Workflow Execution. Deprecated since server version 1.21. | +| ~BuildIds~ | Keyword List | List of Worker Build Ids that have processed the Workflow Execution, formatted as `versioned:{BuildId}` or `unversioned:{BuildId}`, or the sentinel `unversioned` value. Deprecated since server version 1.31 in favor of the `TemporalUsedWorkerDeploymentVersions` search attribute. | +| CloseTime | Datetime | The time at which the Workflow Execution completed. | +| ExecutionDuration | Int | The time needed to run the Workflow Execution (in nanoseconds). Available only for closed Workflows. | +| ExecutionStatus | Keyword | The current state of the Workflow Execution. | +| ExecutionTime | Datetime | The time at which the Workflow Execution actually begins running; same as `StartTime` for most cases but different for Cron Workflows and retried Workflows. | +| HistoryLength | Int | The number of events in the history of Workflow Execution. Available only for closed Workflows. | +| HistorySizeBytes | Long | The size of the Event History. | +| RunId | Keyword | Identifies the current Workflow Execution Run. | +| StartTime | Datetime | The time at which the Workflow Execution started. | +| StateTransitionCount | Int | The number of times that Workflow Execution has persisted its state. Available only for closed Workflows. | +| TaskQueue | Keyword | Task Queue used by Workflow Execution. | +| TemporalChangeVersion | Keyword List | Stores change/version pairs if the GetVersion API is enabled. | +| TemporalReportedProblems | Keyword List | Stores information about Workflow task failures. Formatted as `category= cause=`. | +| TemporalScheduledStartTime | Datetime | The time that the Workflow is schedule to start according to the Schedule Spec. Can be manually triggered. Set on Schedules. | +| TemporalScheduledById | Keyword | The Id of the Schedule that started the Workflow. | +| TemporalSchedulePaused | Boolean | Indicates whether the Schedule has been paused. Set on Schedules. | +| TemporalUsedWorkerDeploymentVersions | Keyword List | The list of all Worker Deployment Versions that completed Workflow Tasks for the Workflow Execution. Each item is in the format `:`. | +| TemporalWorkerDeployment | Keyword | Indicates the name of the associated Worker Deployment. | +| TemporalWorkerDeploymentVersion | Keyword | Indicates the Version string of the associated Worker Deployment, in the format `:`. | +| TemporalWorkflowVersioningBehavior | Keyword | Indicates the associated Worker Versioning behavior ("Pinned", "Auto-Upgrade", or null if not using Worker Versioning). | +| WorkflowId | Keyword | Identifies the Workflow Execution. | +| WorkflowType | Keyword | The type of Workflow. | + + +:::caution +The `BuildIds` and `BinaryChecksums` Search Attributes are deprecated. They will stop being propagated for new workflows starting in Temporal Server 1.32. And will be fully removed from query support in Temporal Server 1.34. + +Instead use: +- `TemporalWorkflowVersioningBehavior` for querying the workflow Versioning Behavior or if it is unversioned. +- `TemporalWorkerDeploymentVersion` for querying the Worker Deployment Version the workflow is assigned to at the moment. +- `TemporalUsedWorkerDeploymentVersions` for querying the list of all Worker Deployment Versions that processed the workflow. + +::: - All default Search Attributes are reserved and read-only. You cannot create a custom one with the same name or alter the existing one. From 73bc5f66cb7a80c4f598159990c3e6dd1fafbec9 Mon Sep 17 00:00:00 2001 From: flippedcoder Date: Fri, 1 May 2026 08:39:04 -0500 Subject: [PATCH 2/2] chore(search attributes): minor docs edits --- .../visibility/search-attributes.mdx | 25 +++++++++---------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/docs/encyclopedia/visibility/search-attributes.mdx b/docs/encyclopedia/visibility/search-attributes.mdx index f0115bfc37..6f0c8d5279 100644 --- a/docs/encyclopedia/visibility/search-attributes.mdx +++ b/docs/encyclopedia/visibility/search-attributes.mdx @@ -58,6 +58,16 @@ You might experience lag due to time passing between the Workflow's state change ### Default Search Attributes {#default-search-attribute} +:::caution +The `BinaryChecksums` and `BuildIds` Search Attributes are deprecated. They will stop being propagated for new Workflows starting in Temporal Server 1.32 and will be fully removed from query support in Temporal Server 1.34. + +Instead use: +- `TemporalWorkflowVersioningBehavior` for querying the Workflow Versioning behavior or if it is unversioned. +- `TemporalWorkerDeploymentVersion` for querying the Worker Deployment Version the Workflow is assigned to at the moment. +- `TemporalUsedWorkerDeploymentVersions` for querying the list of all Worker Deployment Versions that processed the Workflow. + +::: + A Temporal Service has a set of default Search Attributes already available. Default Search Attributes are set globally in any Namespace. These Search Attributes are created when the initial index is created. @@ -65,8 +75,8 @@ These Search Attributes are created when the initial index is created. | NAME | TYPE | DEFINITION | |--------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | BatcherUser | Keyword | Used by internal batcher Workflow that runs in `TemporalBatcher` Namespace division to indicate the user who started the batch operation. | -| ~BinaryChecksums~ | Keyword List | List of binary Ids of Workers that run the Workflow Execution. Deprecated since server version 1.21. | -| ~BuildIds~ | Keyword List | List of Worker Build Ids that have processed the Workflow Execution, formatted as `versioned:{BuildId}` or `unversioned:{BuildId}`, or the sentinel `unversioned` value. Deprecated since server version 1.31 in favor of the `TemporalUsedWorkerDeploymentVersions` search attribute. | +| ~BinaryChecksums~ | ~Keyword List~ | List of binary Ids of Workers that run the Workflow Execution. Deprecated since server version 1.21. | +| ~BuildIds~ | ~Keyword List~ | List of Worker Build Ids that have processed the Workflow Execution, formatted as `versioned:{BuildId}` or `unversioned:{BuildId}`, or the sentinel `unversioned` value. Deprecated since server version 1.31 in favor of the `TemporalUsedWorkerDeploymentVersions` search attribute. | | CloseTime | Datetime | The time at which the Workflow Execution completed. | | ExecutionDuration | Int | The time needed to run the Workflow Execution (in nanoseconds). Available only for closed Workflows. | | ExecutionStatus | Keyword | The current state of the Workflow Execution. | @@ -89,17 +99,6 @@ These Search Attributes are created when the initial index is created. | WorkflowId | Keyword | Identifies the Workflow Execution. | | WorkflowType | Keyword | The type of Workflow. | - -:::caution -The `BuildIds` and `BinaryChecksums` Search Attributes are deprecated. They will stop being propagated for new workflows starting in Temporal Server 1.32. And will be fully removed from query support in Temporal Server 1.34. - -Instead use: -- `TemporalWorkflowVersioningBehavior` for querying the workflow Versioning Behavior or if it is unversioned. -- `TemporalWorkerDeploymentVersion` for querying the Worker Deployment Version the workflow is assigned to at the moment. -- `TemporalUsedWorkerDeploymentVersions` for querying the list of all Worker Deployment Versions that processed the workflow. - -::: - - All default Search Attributes are reserved and read-only. You cannot create a custom one with the same name or alter the existing one.