cartodb4/dataservices-api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update exception_safe.md

Browse Source
This commit is contained in:
Rafa de la Torre 2016-12-15 19:10:18 +01:00 committed by GitHub
parent 59ae4a5492
commit 6e134d1ea6
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/internal/exception_safe.md
View File

@ -3,11 +3,15 @@
The public API dataservices functions emit exceptions in general when an error occurs The public API dataservices functions emit exceptions in general when an error occurs
or a limiting condition is met (e.g. quotas are exceeded). or a limiting condition is met (e.g. quotas are exceeded).
For each public function `x` we have a internal function named `_x_exception_safe` which For each public function `func` we have a internal function named `_func_exception_safe` which
acts as a wrapper to the public function, with the same signature, but captures acts as a wrapper to the public function, with the same signature, but captures
exceptions generated during its execution (except those due to incomplete configuration or exceptions generated during its execution (except those due to incomplete configuration or
authentication issues) and returns NULL or empty set values in those cases. authentication issues) and returns NULL or empty set values in those cases.
Please note these functions are considered **not public** and therefore their API (including which exceptions are wrapped and which ones are not) may change.
Instead of raising an exception they raise warnings, hopefully containing the same information of the original exception.
## Intended Use ## Intended Use
These functions are useful in cases when it is undesirable to rollback a transaction. These functions are useful in cases when it is undesirable to rollback a transaction.
@ -29,4 +33,4 @@ UPDATE table SET the_geom=_cdb_geocode_street_point_exception_safe(user,NULL,add
# Addition Information # Addition Information
See https://github.com/CartoDB/dataservices-api/issues/314 for more information. See https://github.com/CartoDB/dataservices-api/issues/314 for more information.