colin
/
pocketbase
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated readme and Find*ByFilter godoc comment

This commit is contained in:
Gani Georgiev 2023-07-08 14:01:02 +03:00
parent 736e9673ad
commit a557aa35f5
2 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -146,11 +146,10 @@ You could help continuing its development by:
- [Suggest new features and report issues](https://github.com/pocketbase/pocketbase/issues) - [Suggest new features and report issues](https://github.com/pocketbase/pocketbase/issues)
- [Donate a small amount](https://pocketbase.io/support-us) - [Donate a small amount](https://pocketbase.io/support-us)
PRs for _small features_ (eg. adding new OAuth2 providers), bug fixes, code and documentation improvements are more than welcome. PRs for new OAuth2 providers, bug fixes, code optimizations and documentation improvements are more than welcome.
But please refrain creating PRs for _new features_ without previously discussing the implementation details. Reviewing big PRs often requires a lot of time and tedious back-and-forth communication. But please refrain creating PRs for _new features_ without previously discussing the implementation details.
PocketBase has a [roadmap](https://github.com/orgs/pocketbase/projects/2) PocketBase has a [roadmap](https://github.com/orgs/pocketbase/projects/2) and I try to work on issues in specific order and such PRs often come in out of nowhere and skew all initial planning with tedious back-and-forth communication.
and I try to work on issues in a specific order and such PRs often come in out of nowhere and skew all initial planning.
Don't get upset if I close your PR, even if it is well executed and tested. This doesn't mean that it will never be merged. Don't get upset if I close your PR, even if it is well executed and tested. This doesn't mean that it will never be merged.
Later we can always refer to it and/or take pieces of your implementation when the time comes to work on the issue (don't worry you'll be credited in the release notes). Later we can always refer to it and/or take pieces of your implementation when the time comes to work on the issue (don't worry you'll be credited in the release notes).

6
daos/record.go
View File

@ -230,6 +230,9 @@ func (dao *Dao) FindFirstRecordByData(
// If the limit argument is <= 0, no limit is applied to the query and // If the limit argument is <= 0, no limit is applied to the query and
// all matching records are returned. // all matching records are returned.
// //
// NB Don't put untrusted user input in the filter string as it
// practically would allow the users to inject their own custom filter.
//
// Example: // Example:
// //
// dao.FindRecordsByFilter("posts", "title ~ 'lorem ipsum' && visible = true", "-created", 10) // dao.FindRecordsByFilter("posts", "title ~ 'lorem ipsum' && visible = true", "-created", 10)
@ -291,6 +294,9 @@ func (dao *Dao) FindRecordsByFilter(
// FindFirstRecordByFilter returns the first available record matching the provided filter. // FindFirstRecordByFilter returns the first available record matching the provided filter.
// //
// NB Don't put untrusted user input in the filter string as it
// practically would allow the users to inject their own custom filter.
//
// Example: // Example:
// //
// dao.FindFirstRecordByFilter("posts", "slug='test'") // dao.FindFirstRecordByFilter("posts", "slug='test'")