Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
engine:procedures:mi_getsqlfunctionparameters [11.01.2016 ] |
engine:procedures:mi_getsqlfunctionparameters [11.01.2016 ] (aktuell) |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ===== mi_GetSQLFunctionParameters ===== | ||
+ | |||
+ | Liefert die Parameter einer SQL-Funktion inkl. Informationen über den Datentyp zurück - optional auch nur für\\ einen bestimmten Parameter.\\ | ||
+ | |||
+ | Im Gegensatz zu [[dstoreproc>do_GetSQLFunctionParameters_Ad]] werden zwar keine Default-Werte zurückgegeben und auch keine Angabe, ob es sich um einen Ausgabeparameter handelt oder nicht, aber dafür ist dieses Ergebnis "verläßlich", d.h. die Angaben kommen aus den System-Tabellen der Datenbank selbst, so daß Fehler (wie in der Dokumentation) AUSGESCHLOSSEN sind.\\ | ||
+ | |HTTP-Method|GET | | ||
+ | |HTTP-Auth|Optional | | ||
+ | |Tags|{{tag>[mi Get Function Parameters]}}| | ||
+ | |Engine-Kategorie|miscellaneous | | ||
+ | |Engine-Typ|Daten-Ermittlung | | ||
+ | |Letzte Aktualisierung|6.0.4 (2011-10-21)| | ||
+ | |||
+ | ==== Parameter ==== | ||
+ | |||
+ | ^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:engine_parameterconventions|Parameter-Konventionen engine/<Prozedur-Name>]])) ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |__SQLFunctionName__| |Name einer SQL-Funktion, zu der die Parameter ermittelt werden sollen\\ |varchar(50)|6.0.4| | ||
+ | |ParameterName|NULL |Name eines Parameters der SQL-Funktion "SQLFunctionName". Falls angegeben, wird nur der Datensatz zu diesem Parameter ausgegeben.\\ |varchar(50)|6.0.4| | ||
+ | ==== Rückgabe ==== | ||
+ | |||
+ | === (parameterunabhängig) === | ||
+ | |||
+ | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
+ | |//SortNo((Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.))//|Wird nicht ausgegeben, sondern nur zur Sortierung verwendet ! Bestimmt die Reihenfolge des Parameters "ParameterName" innerhalb aller Parameter der SQL-Funktion "SQLFunctionName".\\ |tinyint|6.0.4 | | ||
+ | |ParameterName|Name eines Parameters der SQL-Funktion "SQLFunctionName". Hinweis : Es gibt immer einen "Parameter" mit dem festen Namen "Return Type", was den Rückgabewert der Funktion darstellt.\\ |varchar(50)|6.0.4 | | ||
+ | |Datatype|Daten-Typ des Parameters "ParameterName"\\ |varchar(20)|6.0.4 | | ||
+ | |Length|Wieviel Byte können Werte, die für den Parameter "ParameterName" übergeben werden, maximal enthalten. Bei vielen Daten-Typen ist die Speicherbelegung immer so groß wie dieser Wert (bei numerischen Daten-Typen z.B.).\\ |integer|6.0.4 | | ||
+ | |PrecisionValue|Gilt nur für einige numerische Daten-Typen (z.B. "decimal") und gibt die maximale Anzahl Stellen an, die ein Wert für den Parameter "ParameterName" enthalten kann\\ |tinyint|6.0.4 | | ||
+ | |Scale|Gilt nur für einige numerische Daten-Typen (z.B. "decimal") und gibt die Genauigkeit, sprich die maximale Anzahl an Nachkomma-Stellen an, die ein Wert für den Parameter "ParameterName" enthalten kann\\ |tinyint|6.0.4 | | ||
+ | |||
+ | == Sortierung der Rückgabe == | ||
+ | |||
+ | (parameterunabängige Sortierung) | ||
+ | * SortNo (aufsteigend) | ||
+ | |||
+ | ==== Output-Parameter ==== | ||
+ | |||
+ | Die Prozedur hat keine Output-Parameter.==== Mögliche Return-Codes ==== | ||
+ | |||
+ | ^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber" und indirekt meint "von intern aufgerufenen Unterprozeduren")) ^ | ||
+ | |-500|Falsche Parameter|nur direkt| | ||
+ | ==== XML-Schema ==== | ||
+ | |||
+ | Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema [[http://resources.dstore.de/xsd/webservice_SmartGate/Response/EngineProcedure_v1_0.xsd|Response/EngineProcedure_v1_0.xsd]] validiert. | ||
+ | ==== Historie ==== | ||
+ | |||
+ | |6.0.4 |2011-10-21|Erstmalig in dieser Version erstellt\\ | | ||
+ | |||
+ | ==== Code-Snippets ==== | ||
+ | |||
+ | == Engine Playground == | ||
+ | Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist: | ||
+ | * [[http://playground.dstore.de/index.php?proc=mi_GetSQLFunctionParameters|mi_GetSQLFunctionParameters im Engine Playground öffnen]] | ||
+ | == cURL == | ||
+ | Unformatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetSQLFunctionParameters?SQLFunctionName=<value>'</code>Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org)) formatierte Ausgabe: | ||
+ | <code bash> | ||
+ | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/mi_GetSQLFunctionParameters?SQLFunctionName=<value>' | xmllint --format -</code>== dStore_php == | ||
+ | <code php> | ||
+ | use dStore_php\WebService; | ||
+ | |||
+ | $service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80); | ||
+ | |||
+ | $request = new WebService\Requests\Engine\Procedure\Request( | ||
+ | new WebService\Requests\AccessData('default'), | ||
+ | 'mi_GetSQLFunctionParameters', | ||
+ | array( | ||
+ | 'SQLFunctionName' => '<value>', | ||
+ | // 'ParameterName' => NULL | ||
+ | ) | ||
+ | ); | ||
+ | |||
+ | $service->execute($request); | ||
+ | |||
+ | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
+ | $ResultSet = $xml_result->getRowsAsArray(); | ||
+ | |||
+ | </code> | ||
+ | == engine/execute == | ||
+ | XML zur Ausführung mit der Methode [[:webservice:engine:execute|engine/execute]], z.B. per | ||
+ | curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>' | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <ListOfBatches> | ||
+ | <Batch No="0"> | ||
+ | <Procedure Name="mi_GetSQLFunctionParameters"> | ||
+ | <Parameters> | ||
+ | <Parameter Name="SQLFunctionName"><!-- varchar value --></Parameter> | ||
+ | <!-- <Parameter Name="ParameterName">NULL</Parameter> --> | ||
+ | </Parameters> | ||
+ | </Procedure> | ||
+ | </Batch> | ||
+ | </ListOfBatches></code> | ||