Liefert die Parameter einer SQL-Funktion inkl. Informationen über den Datentyp zurück, so wie (in „dstore.dbo.SQLFunctionParameters“) dokumentiert (d.h. es KÖNNTEN fehlerhafte Informationen enthalten sein).
Im Gegensatz zu mi_GetSQLFunctionParameters kann es daher zwar sein, daß für eine neue aber eben noch nicht dokumentierte
Funktion der Aufruf hier nix (bzw. einen Fehler) liefert. Aber dafür werden hier evtl. vorhandene Default-Werte für Parameter
zurückgegeben sowie die Information, in welcher „dStore-Version“ der Parameter eingeführt wurde.
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | documentation |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 7.0.7 (2015-01-29) |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
SortNo5) | 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 | Parameter-Name der SQL-Funktion „SQLFunctionName“. Hinweis : Im Vergleich zu mi_GetSQLFunctionParameters gibt es KEINEN „dummy“-Parameter mit dem 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.). | smallint | 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 |
DefaultValue | Der Wert, mit dem der Parameter „ParameterName“ vorbelegt ist. Hinweis : Im Gegensatz zu Parametern bei Prozeduren muß bei SQL-Funktionen ein Parameter IMMER angegeben werden, auch wenn ein „Default“ definiert ist (um den zu verwenden, „default“ angeben). | varchar(255) | 6.0.4 |
IntroducedIndStoreVersion | Seit welcher Version gibt es den Parameter „ParameterName“ | varchar(20) | 6.0.4 |
(parameterunabängige Sortierung)
Die Prozedur hat keine Output-Parameter.
Code | Beschreibung | Quelle 6) |
---|---|---|
-569 | Der Benutzer hat kein Ausführungsrecht für die Prozedur | nur indirekt |
-567 | Die Prozedur darf z. Zt. nicht ausgeführt werden | nur indirekt |
-566 | Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden | nur indirekt |
-535 | Das Datum liegt nicht in der Vergangenheit | nur indirekt |
-530 | Der Wert ist nicht konvertierbar | nur indirekt |
-510 | Der Benutzer ist nicht registriert | nur indirekt |
-504 | Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen | nur indirekt |
-502 | Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen) | nur indirekt |
-500 | Falsche Parameter | direkt und indirekt |
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
7.0.7 | 2015-01-29 | Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf] |
6.5.3 | 2013-03-18 | Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung |
6.0.5 | 2011-12-13 | Holger Wies : Fehler in der Dokumentation mehrerer Rückgabespalten berichtigt |
6.0.4 | 2011-10-21 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/do_GetSQLFunctionParameters_Ad?SQLFunctionName=<value>'
Mit xmllint 7) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/do_GetSQLFunctionParameters_Ad?SQLFunctionName=<value>' | xmllint --format -
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'), 'do_GetSQLFunctionParameters_Ad', array( 'SQLFunctionName' => '<value>' ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
XML zur Ausführung mit der Methode engine/execute, z.B. per
curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?xml version="1.0" encoding="UTF-8"?> <ListOfBatches> <Batch No="0"> <Procedure Name="do_GetSQLFunctionParameters_Ad"> <Parameters> <Parameter Name="SQLFunctionName"><!-- varchar value --></Parameter> </Parameters> </Procedure> </Batch> </ListOfBatches>