TemporalMetadata

TemporalMetadata Type

Audience: Programmer

The TemporalMetadata type represents a key-value pair used to store metadata information for Temporal workflows, particularly in search attributes.

Fields

Field	Type	Description
key	String!	The metadata key identifier
value	String!	The metadata value as a string

Usage Context

TemporalMetadata is used for:

• Workflow Search Attributes: Used in workflow queries to access indexed workflow metadata

• Workflow Filtering: Enables searching and filtering workflows based on custom attributes

Usage Example

query GetWorkflowDetails {
  workflow(id: "wf_12345") {
    id
    type
    searchAttributes {
      key
      value
    }
  }
}

JavaScript Example

// Accessing workflow search attributes
const response = await client.query({
  query: gql`
    query GetWorkflow($id: ID!) {
      workflow(id: $id) {
        id
        type
        searchAttributes {
          key
          value
        }
      }
    }
  `,
  variables: {
    id: "wf_12345"
  }
});

// Process search attributes into a map
const searchAttrs = response.data.workflow.searchAttributes;
const attributesMap = searchAttrs.reduce((acc, item) => {
  acc[item.key] = item.value;
  return acc;
}, {});

console.log('Workflow search attributes:', attributesMap);

Common Search Attribute Keys

While search attribute keys are workflow-specific, common patterns include:

Key	Purpose
tenant_id	Multi-tenant identifier
user_id	User who initiated the workflow
trace_id	Distributed tracing identifier
priority	Workflow execution priority
source	Origin system or service
status	Custom workflow status

Notes

• All values are stored as strings regardless of original type

• Search attributes are indexed and can be used for workflow queries

• Used for filtering, monitoring, and debugging workflows

• Available across all pyck services that use Temporal workflows

• Defined in the temporalworkflow.graphql schema across services