Skip to content

Commit 30edd71

Browse files
committed
Updating README.rst ..
1 parent 122971a commit 30edd71

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -321,3 +321,29 @@ Sample User Apps/Modules/Scripts
321321
(other columns not specified in the mapping dictionary will be returned as is. If a column header is mapped to an empty name, the corresponding column will be filtered out from the return).
322322
This is especially useful when passing the entire result of MDX directly to a stored procedure in a database.
323323
It allows you to map MDX column names to input parameter names of the stored procedure.
324+
325+
.
326+
327+
``pass_result_to_url``
328+
329+
Rather than just returning the MDX results to the HTTP client, the optional argument ``pass_result_to_url`` can be used to
330+
forward these result data directly to a database stored procedure for storage or further processing. The stored procedure is exposed as a URL
331+
through `DbWebApi <https://github.com/DataBooster/DbWebApi>`_, such as ``http://dbwebapi.dev.com/oradev/the_schema.etl_package.load_mdx_result``
332+
*(example for Oracle)* or ``http://dbwebapi.dev.com/sqldev/the_db.dbo.load_mdx_result`` *(example for SQL Server)*.
333+
For details about the `DbWebApi <https://github.com/DataBooster/DbWebApi>`_, please see https://github.com/DataBooster/DbWebApi/wiki.
334+
335+
``more_args``
336+
337+
Other than above MDX result data, your stored procedure may require more input parameters.
338+
The ``more_args`` argument (a dictionary) allows you to prepare all other input parameters required by the stored procedure into the dictionary.
339+
340+
.
341+
342+
``notify_url``
343+
344+
Sometimes we may need to send a notification to somewhere when above process get completed or an error is encountered.
345+
The ``notify_url`` argument allows you to specify the URL of the notification destination *(it must also be a RESTful service)*.
346+
347+
``notify_args``
348+
349+
This is also a dictionary, any items it carries will be passed to the notification service as input arguments.

0 commit comments

Comments
 (0)