Skip to content

Add documentation for Data Store TTL functionality #15825

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 6 commits into from
Mar 6, 2025
Merged

Add documentation for Data Store TTL functionality #15825

merged 6 commits into from
Mar 6, 2025

Conversation

@dannyroosevelt
Copy link
Collaborator

@dannyroosevelt dannyroosevelt commented Mar 5, 2025 •
edited by coderabbitai bot
Loading

Summary

  • Added documentation for the new Data Store TTL functionality
  • Updated the Node.js docs to explain how to set and update TTL for records
  • Added a new section for the Update Record Expiration action
  • Added a practical use case example for TTL with rate limiting
  • Updated Python docs to clarify that TTL is only available in Node.js steps

Test plan

  • Review documentation for technical accuracy
  • Verify correct cross-linking between docs
  • Check that code examples are complete and working as expected

📚 This PR complements the code changes in PR #15824
🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Introduced record expiration functionality that automatically removes data after a specified duration, with options to update or remove the expiration.
    • Enabled use cases such as temporary caching and rate limiting for enhanced data management.

  • Documentation

    • Updated guides to detail how to configure record expiration and update settings.
    • Provided clarifications for both Node.js and Python users regarding TTL functionality.
    • Added new sections explaining TTL management and practical applications for data stores.

@vercel
Copy link

vercel bot commented Mar 5, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Mar 6, 2025 1:50pm
pipedream-docs ⬜️ Ignored (Inspect) Mar 6, 2025 1:50pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Mar 6, 2025 1:50pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2025 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The documentation has been updated to introduce TTL (Time To Live) functionality in data store usage. The Node.js guide now details how to set record expiration using a TTL option in the set method and introduces the setTtl method for updating a record's expiration, including examples for various use cases. The Python documentation adds a new section on setting expiration (TTL) for records, and the data management documentation is enhanced with detailed instructions and expanded use cases for record expiration.

Changes

File(s) Change Summary
docs-v2/.../nodejs/using-data-stores.mdx Changed prop name from data to dataStore, added TTL functionality in the set method, introduced setTtl for updating expiration, and provided examples for rate limiting.
docs-v2/.../python/using-data-stores.mdx Added a new section on "Setting expiration (TTL) for records," detailing how to use TTL in Python, including updating TTL for existing records.
docs-v2/.../data-management/data-stores.mdx Introduced a section on "Setting or updating record expiration (TTL)," expanded bullet points for temporary data expiration and caching, and provided instructions for managing TTL.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant DS as Data Store
    User->>DS: Store record with TTL (using set method)
    DS-->>User: Record saved with expiration applied
    User->>DS: Update record TTL (using setTtl method)
    DS-->>User: TTL updated (extended/removed)
Loading

Possibly related PRs

  • Add TTL functionality to Data Store actions #15824: The changes in the main PR regarding the introduction of TTL functionality for managing expiration times in a data store are directly related to the modifications in the retrieved PR, which also adds TTL properties and methods for record expiration in various data store actions.

Poem

I hopped along the docs one day,
Adding TTL in a clever way,
With records set to vanish on cue,
And limits set for work to do,
A rabbit's hop, a code delight—
Changes that make our docs ignite!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between db0d0f9 and 5a007d4.

📒 Files selected for processing (2)
  • docs-v2/pages/workflows/building-workflows/code/nodejs/using-data-stores.mdx (10 hunks)
  • docs-v2/pages/workflows/building-workflows/code/python/using-data-stores.mdx (3 hunks)
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

andrewjschuang
andrewjschuang previously approved these changes Mar 5, 2025
View reviewed changes
@andrewjschuang andrewjschuang merged commit 41f2aee into master Mar 6, 2025
6 of 8 checks passed
@andrewjschuang andrewjschuang deleted the docs-data-store-ttl branch March 6, 2025 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@andrewjschuang andrewjschuang andrewjschuang left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dannyroosevelt @andrewjschuang