Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getsqlfunctionparameters

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 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-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriemiscellaneous
Engine-TypDaten-Ermittlung
Letzte Aktualisierung6.0.4 (2011-10-21)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
SQLFunctionName Name einer SQL-Funktion, zu der die Parameter ermittelt werden sollen
varchar(50)6.0.4
ParameterNameNULL 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-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“.
tinyint6.0.4
ParameterNameName 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
DatatypeDaten-Typ des Parameters „ParameterName“
varchar(20)6.0.4
LengthWieviel 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.).
integer6.0.4
PrecisionValueGilt 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
tinyint6.0.4
ScaleGilt 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
tinyint6.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 6)
-500Falsche Parameternur direkt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

6.0.4 2011-10-21Erstmalig 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:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetSQLFunctionParameters?SQLFunctionName=<value>'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetSQLFunctionParameters?SQLFunctionName=<value>' | xmllint --format -
dStore_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();
engine/execute

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="mi_GetSQLFunctionParameters">
			<Parameters>
				<Parameter Name="SQLFunctionName"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="ParameterName">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
5)
Spalte wird nicht zurückgegeben und ist hier nur aus Dokumentationsgründen aufgeführt.
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/mi_getsqlfunctionparameters.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)