From 6e134d1ea623c79dfc74bd03723f5d9db8d225fa Mon Sep 17 00:00:00 2001 From: Rafa de la Torre Date: Thu, 15 Dec 2016 19:10:18 +0100 Subject: [PATCH] Update exception_safe.md --- doc/internal/exception_safe.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/internal/exception_safe.md b/doc/internal/exception_safe.md index 129bb00..abec131 100644 --- a/doc/internal/exception_safe.md +++ b/doc/internal/exception_safe.md @@ -3,11 +3,15 @@ The public API dataservices functions emit exceptions in general when an error occurs 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 exceptions generated during its execution (except those due to incomplete configuration or 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 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 -See https://github.com/CartoDB/dataservices-api/issues/314 for more information. \ No newline at end of file +See https://github.com/CartoDB/dataservices-api/issues/314 for more information.