Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update redis connection docs to match latest Keyv API #7944

Merged
merged 1 commit into from
Oct 23, 2024

Conversation

tninesling
Copy link
Contributor

The @apollo/utils.keyvadapter package was updated in apollographql/apollo-utils#461 to be compatible with Keyv v5. The primary change is that the Keyv constructor takes a store instead of a string.

The constructor can be invoked in two ways:

// passed as first argument
new Keyv(new KeyvRedis("redis://..."))

// passed as store
new Keyv({ store: new KeyvRedis("redis://...") })

This updates the Redis examples in the documentation to match the new API. For simplicity, I've stuck to the first format.

@tninesling tninesling requested review from glasser, trevor-scheer and a team as code owners October 22, 2024 21:13
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Oct 22, 2024

✅ Docs Preview Ready

Configuration
{
  "repoOverrides": {
    "apollographql/apollo-server@main": {
      "remote": {
        "owner": "apollographql",
        "repo": "apollo-server",
        "branch": "tninesling/docs-update-keyv-usage"
      }
    }
  }
}
Name Link

Commit

92a459d

Preview

https://www.apollographql.com/docs/deploy-preview/187a5bf8c3022ea0cf68

Build ID

187a5bf8c3022ea0cf68

File Changes

0 new, 7 changed, 0 removed
* (developer-tools)/apollo-server/(latest)/performance/cache-backends.mdx
* graphos/reference/router/telemetry/instrumentation/standard-instruments.mdx
* graphos/reference/router/telemetry/instrumentation/selectors.mdx
* graphos/reference/router/rhai.mdx
* graphos/reference/router/federation-version-support.mdx
* graphos/reference/router/configuration.mdx
* graphos/routing/customization/coprocessor.mdx

Pages

7


7 pages published. Build will be available for 30 days.

Copy link

netlify bot commented Oct 22, 2024

Deploy Preview for apollo-server-docs ready!

Name Link
🔨 Latest commit 92a459d
🔍 Latest deploy log https://app.netlify.com/sites/apollo-server-docs/deploys/671815685bb07600081c8856
😎 Deploy Preview https://deploy-preview-7944--apollo-server-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Copy link
Member

@glasser glasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not an expert on the API changes but it looks like this matches the README on @keyv/redis.

@tninesling tninesling merged commit 09f1b75 into main Oct 23, 2024
24 checks passed
@tninesling tninesling deleted the tninesling/docs-update-keyv-usage branch October 23, 2024 15:43
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants