Persisted Queries

# Scan current directory for .graphql files
rover pq generate --include "src/**/*.graphql"

# Write manifest to a file
rover pq generate --include "src/**/*.graphql" --manifest-path ./pq-manifest.json

# Exclude generated files
rover pq generate \
  --include "src/**/*.graphql" \
  --exclude "src/__generated__/**"

# Scan a specific directory
rover pq generate --include "**/*.graphql" --root-dir ./my-app

# Preserve comments above operations in the manifest
rover pq generate --include "src/**/*.graphql" --preserve-comments

{
  "format": "apollo-persisted-query-manifest",
  "version": 1,
  "operations": [
    {
      "id": "sha256-hash-of-the-operation-body",
      "body": "query GetUser($id: ID!) {\n  user(id: $id) {\n    id\n    name\n  }\n}",
      "name": "GetUser",
      "type": "query"
    }
  ]
}

# Publish using a graph ref (list must be linked to the variant)
rover pq publish my-graph@production \
  --manifest ./pq-manifest.json

# Publish using explicit graph ID and list ID
rover pq publish \
  --graph-id my-graph \
  --list-id my-list-id \
  --manifest ./pq-manifest.json

# Publish a Relay-format manifest
rover pq publish my-graph@production \
  --manifest ./relay-manifest.json \
  --manifest-format relay

# Override the client name for all operations
rover pq publish my-graph@production \
  --manifest ./pq-manifest.json \
  --for-client-name my-web-app

# Read manifest from stdin
cat pq-manifest.json | rover pq publish my-graph@production --manifest -

# 1. Generate the manifest
rover pq generate \
  --include "src/**/*.graphql" \
  --manifest-path ./pq-manifest.json

# 2. Publish to GraphOS
rover pq publish $APOLLO_GRAPH_REF \
  --manifest ./pq-manifest.json

steps:
  - name: Generate persisted query manifest
    run: |
      rover pq generate \
        --include "src/**/*.graphql" \
        --manifest-path ./pq-manifest.json

  - name: Publish persisted queries
    run: |
      rover pq publish $APOLLO_GRAPH_REF \
        --manifest ./pq-manifest.json
    env:
      APOLLO_KEY: ${{ secrets.APOLLO_KEY }}
      APOLLO_GRAPH_REF: my-graph@production

rover pq publish my-graph@production \
  --manifest ./relay-persisted-queries.json \
  --manifest-format relay

rover pq publish my-graph@production \
  --manifest ./relay-persisted-queries.json \
  --manifest-format relay \
  --for-client-name my-relay-app

# Extract .graphql files from source
rover client extract --include "src/**/*.{ts,tsx}" --out-dir ./graphql

# Generate manifest from the extracted files
rover pq generate --include "graphql/**/*.graphql" --manifest-path ./pq-manifest.json