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

[DOCS]: Provide color on the transaction attribute in FindOneOptions / SaveOptions #9647

Open
luizguilhermefr opened this issue Dec 21, 2022 · 0 comments

Comments

@luizguilhermefr
Copy link

What was unclear or otherwise insufficient?

In the documentation, there are no mentions at all of the transaction boolean flag that is present on the FindOneOptions and SaveOptions interfaces.

/**
* If this is set to true, SELECT query in a `find` method will be executed in a transaction.
*/
transaction?: boolean

/**
* By default transactions are enabled and all queries in persistence operation are wrapped into the transaction.
* You can disable this behaviour by setting { transaction: false } in the persistence options.
*/
transaction?: boolean

I am confused if when I am using a data source transaction, I should use it within my statements or not.

Recommended Fix

Documentation I'd expect to have more color about those flags: https://typeorm.io/transactions

Additional Context

No response

Are you willing to resolve this issue by submitting a Pull Request?

Yes, I have the time, but I don't know how to start. I would need guidance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant