WorkflowExecutionInfoConnection

WorkflowExecutionInfoConnection Type - Paginated workflow execution results

Audience: Programmer

A connection type for paginated access to workflow execution information. This type follows the Relay connection specification and is returned by the workflowExecutions query.

This connection provides efficient pagination through potentially large result sets of workflow executions, using Temporal's NextPageToken for cursor-based navigation.

Fields

Field	Type	Description
edges	[WorkflowExecutionInfoEdge!]!	List of workflow execution info edges
pageInfo	WorkflowExecutionPageInfo!	Information for pagination
totalCount	Int!	Total number of matching workflow executions

Related Types

WorkflowExecutionInfoEdge

Field	Type	Description
node	WorkflowExecutionInfo!	The workflow execution information
cursor	String!	Cursor for use in pagination

WorkflowExecutionPageInfo

Field	Type	Description
hasNextPage	Boolean!	Whether there are more items after this page
hasPreviousPage	Boolean!	Whether there are more items before this page
startCursor	String	Cursor of the first item
endCursor	String	Cursor of the last item

Service

This type is defined in the Workflow service.

Usage Example

Basic Paginated Query

query {
  workflowExecutions(
    where: {
      status: "RUNNING"
    }
    first: 50
    orderBy: { direction: DESC, field: START_TIME }
  ) {
    edges {
      node {
        execution {
          workflowId
          id
        }
        type {
          name
        }
        status
        startTime
        historyLength
        memo {
          title
          subtitle
        }
      }
      cursor
    }
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    totalCount
  }
}

Paginating Through Results

# First page
query FirstPage {
  workflowExecutions(
    where: { typeName: "PickingWorkflow" }
    first: 100
  ) {
    edges {
      node {
        execution { workflowId }
        status
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
    totalCount
  }
}

# Next page (use endCursor from previous response)
query NextPage {
  workflowExecutions(
    where: { typeName: "PickingWorkflow" }
    first: 100
    after: "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjMwOjAwWiJ9"
  ) {
    edges {
      node {
        execution { workflowId }
        status
      }
      cursor
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

Example Response

{
  "data": {
    "workflowExecutions": {
      "edges": [
        {
          "node": {
            "execution": {
              "workflowId": "picking-order-12345",
              "id": "run-abc-123"
            },
            "type": {
              "name": "PickingWorkflow"
            },
            "status": "RUNNING",
            "startTime": "2024-01-15T10:30:00Z",
            "historyLength": 42,
            "memo": {
              "title": "Picking Order #12345",
              "subtitle": "Zone A"
            }
          },
          "cursor": "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjMwOjAwWiJ9"
        },
        {
          "node": {
            "execution": {
              "workflowId": "picking-order-12346",
              "id": "run-def-456"
            },
            "type": {
              "name": "PickingWorkflow"
            },
            "status": "RUNNING",
            "startTime": "2024-01-15T10:25:00Z",
            "historyLength": 28,
            "memo": {
              "title": "Picking Order #12346",
              "subtitle": "Zone B"
            }
          },
          "cursor": "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjI1OjAwWiJ9"
        }
      ],
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": false,
        "startCursor": "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjMwOjAwWiJ9",
        "endCursor": "eyJzdGFydFRpbWUiOiIyMDI0LTAxLTE1VDEwOjI1OjAwWiJ9"
      },
      "totalCount": 150
    }
  }
}

Breaking Change

This connection type is new and replaces the previous array return type of the workflowExecutions query.

Before:

query {
  workflowExecutions(where: { ... }) {  # Returned [WorkflowExecutionInfo!]!
    execution { workflowId }
    status
  }
}

After:

query {
  workflowExecutions(where: { ... }) {  # Returns WorkflowExecutionInfoConnection!
    edges {
      node {
        execution { workflowId }
        status
      }
    }
  }
}

Notes

• This connection provides lightweight execution metadata WITHOUT history

• To fetch history, use the workflowHistory query with WorkflowExecutionHistoryConnection

• Pagination uses Temporal's NextPageToken directly, encoded in the cursor

• Default page size is 100 if first is not specified

• Use totalCount to display the total number of matching executions

Related Documentation

• workflowExecutions Query - Query that returns this connection type

• WorkflowExecutionInfo - The node type in this connection

• WorkflowExecutionHistoryConnection - Connection for history retrieval

• workflowHistory Query - Query for history data