Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:do_getsqlfunctionparameters_ad

do_GetSQLFunctionParameters_Ad

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-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategoriedocumentation
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
SQLFunctionName Name einer SQL-Funktion, zu der die (dokumentierten) Parameter ermittelt werden sollen
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
ParameterNameParameter-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
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.).
smallint6.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
DefaultValueDer 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
IntroducedIndStoreVersionSeit welcher Version gibt es den Parameter „ParameterName“
varchar(20)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 6)
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt

XML-Schema

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

Historie

7.0.7 2015-01-29Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.3 2013-03-18Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.0.5 2011-12-13Holger Wies : Fehler in der Dokumentation mehrerer Rückgabespalten berichtigt
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/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 -
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'),
	'do_GetSQLFunctionParameters_Ad',
		array(
			'SQLFunctionName' => '<value>'
		)
);
 
$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="do_GetSQLFunctionParameters_Ad">
			<Parameters>
				<Parameter Name="SQLFunctionName"><!-- varchar value --></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/do_getsqlfunctionparameters_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)