Documentation Regarding Retry Functionality

Open
#167 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Start by reviewing the existing Sequelize documentation and the linked issues and resources to determine the retry option's behavior and scope. Add a documentation section covering configuration, query and transaction behavior, limitations, and examples; the work is done when these questions have clear answers in the website documentation.

Written by the indexing model from the issue text.

Description

Issue Creation Checklist

[X] I have read the contribution guidelines

Issue Description

I have been running through many github project issues and through a few google search results to try and understand how to enable Retry logic with sequelize and what its capabilities are and wether it works with transactions. This isn't officially documented anywhere and there is a lot of confusion around this without clear answers.

What was unclear/insufficient/not covered in the documentation

Everything around the retry option in sequelize is kind of a mystery.

  • Is something Like this still valid?
  • what are the limitations?
  • Does this retry transactions if they fail?
  • Does this retry individual queries?
retry: {
    match: [
        Sequelize.ConnectionError,
        Sequelize.ConnectionTimedOutError,
        Sequelize.TimeoutError,
        /Deadlock/i,
        'SQLITE_BUSY'],
    max: 3
}
If possible: Provide some suggestion on how we can enhance the docs

Would be nice to have a section on retry capabilities in the documentation, how it works and what are its limitations are.

Additional context

List of resources I was able to dig up regarding this question:

Dominant language
HTML
Stars
30
Forks
170
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sequelize/website

All issues in sequelize/website

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.