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

Document the "no_sync" write option for InfluxDB #5826

Open
MeelahMe opened this issue Feb 5, 2025 · 2 comments
Open

Document the "no_sync" write option for InfluxDB #5826

MeelahMe opened this issue Feb 5, 2025 · 2 comments
Labels
documentation Proposal Proposed changes and updates

Comments

@MeelahMe
Copy link
Contributor

MeelahMe commented Feb 5, 2025

Describe your proposal here.

A user in Kapa.ai asked about the no_sync write option. Kapa.ai could not answer the question due to not being able to find any documentation covering the topic in the InfluxDB docs.

Kapa.ai response did indicate that there is some related documentation that exists for the write consistency levels and batching options but nothing explicitly for no_sync.

My request would be to:

  • add a explanation of the no_sync write option
  • Describe its purpose, behavior, and use cases
  • Include any relevant configuration details
Relevant URLs
  • Provide relevant URLs

https://app.kapa.ai/720100f9-ce93-4305-88fd-5fcf71effad7/conversations/96609cd4-23fc-4956-8408-fa64bc247d74

@MeelahMe MeelahMe added Proposal Proposed changes and updates good-first-issue Easy update. Good for first timers! documentation and removed good-first-issue Easy update. Good for first timers! labels Feb 5, 2025
@jstirnaman
Copy link
Contributor

I talked to Pete briefly and researched this for the API spec. Here's what I came up with:

      type: boolean
      default: false
      description: |
        Do not sync writes.
            
        By default, InfluxDB writes ingested data to the WAL file and then waits for the WAL to be persistend to disk before acknowledging the write.

        If `no_sync=true`, InfluxDB writes ingested data to the WAL file and the server does not wait for the write to be persisted before acknowledging the write.

@peterbarnett03 Can you confirm (or tag someone else to confirm) this is correct?

@jstirnaman
Copy link
Contributor

@MeelahMe Nicely done! This is a great example that we can share with the team for how to create issues from Kapa conversation feedback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Proposal Proposed changes and updates
Projects
None yet
Development

No branches or pull requests

2 participants