do_GetProcedureResultSets_Ad [dstore]

Inhaltsverzeichnis

do_GetProcedureResultSets_Ad

do_GetProcedureResultSets_Ad

Gibt die Dokumentation der Ergebnismenge(n) einzelner „dStore“-Prozeduren aus.

Anmerkung zur Rückgabespalte „ProcedureResultConditionID“, „ParameterName“ und „Condition“ :

Eine Rückgabemenge ist oftmals an Bedingungen gebunden, die sich dadurch ausdrücken lassen, daß beim Aufruf der Prozedur die Werte einiger Parameter ein gewisses Format haben oder bestimmten Wertebereichen entstammen müssen o.ä. Es kann sein, daß die Rückgabemenge dieser Prozedur also mehrere Datensätze bei gleicher „ProcedureResultConditionID“ und gleichem „ResultColumnName“ hat, was bedeutet, daß mehrere Bedingungen gleichzeitig erfüllt sein müssen. Beispiel :

1. Datensatz :
ProcedureResultConditionID : 17
ParameterName : „Param1“
Condition : „is NULL“
ResultColumnName : „col1“
…

2. Datensatz :
ProcedureResultConditionID : 17
ParameterName : „Param3“
Condition : „= 42“
ResultColumnName : „col1“
…

3. Datensatz :
ProcedureResultConditionID : 17
ParameterName : „Param1“
Condition : „is NULL“
ResultColumnName : „col2“
…

Das bedeutet, daß die Rückgabemenge mit „col1“, „col2“, … nur geliefert wird, wenn die Bedingung
„Parm1 is NULL“ AND „Param3 = 42“
erfüllt ist !

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Get, Procedure, Result, Sets, Ad]
Engine-Kategorie	documentation
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ProcedureName		Name einer Prozedur, zu der die Dokumentation der Rückgabemenge(n) ausgegeben werden soll	varchar(50)	4.0.0
ProcedureResultConditionID	NULL	ID einer Bedingung (mögliche Werte s. do_GetProcResultConditions_Ad). Falls angegeben, wird nur die zu dieser Bedingung dokumentierte Rückgabemenge (von „ProcedureName“) ermittelt.	integer	7.0.3

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ProcedureResultConditionID	ID einer Bedingung, unter der die Spalten „ResultColumnName“ (also alle Datensätze mit gleichem Wert in dieser Spalte) als Ergebnismenge zurückgegeben werden. „0“ bedeutet, daß die Rückgabemenge an keine Bedingung gebunden ist. (siehe Beschreibung !)	integer	4.0.0
ProcResultCondDescription	Bezeichnung der Bedingung „ProcedureResultConditionID“. Derzeit entweder „Parameterunabhängige Rückgabemenge“ oder aber <ProzedurName>_<fortlaufende Nummer>.	varchar(100)	7.0.3
ParameterName	Name eines Parameters der Prozedur „ProcedureName“. Die Rückgabemenge wird nur geliefert, wenn beim Aufruf der für diesen Parameter angegebene Wert der Bedingung „Condition“ genügt. („NULL“ bei der speziellen Bedingung „ProcedureResultConditionID = 0“.)	varchar(50)	4.0.0
Condition	Die Rückgabemenge wird nur geliefert, wenn der für „ParameterName“ übergebene Wert dieser Bedingung genügt. Fast immer handelt es sich hier um eine Bedingung, die in SQL ausgewertet werden kann, zumindest aber mit Hilfe von regulären Ausdrücken.	varchar(255)	4.0.0
ResultColumnName	Name einer Rückgabespalte der Ergebnismenge	varchar(50)	4.0.0
SortNo	Bestimmt die Reihenfolge der Spalte „ResultColumnName“ innerhalb aller Rückgabespalten. „0“ bedeutet, daß sie nicht ausgegeben wird, also entweder in einer älteren Version vorhanden war (aber aktuell nicht mehr gültig ist) oder nur zur Sortierung dient.	tinyint	4.0.0
DataType	Gibt den Daten-Typ der Spalte „ResultColumnName“ an („varchar“, „tinyint“, etc.)	varchar(20)	4.0.0
Length	Wieviel Byte können Werte, die in der Spalte „ResultColumnName“ ausgegeben werden, maximal enthalten. Bei vielen Daten-Typen ist die Speicherbelegung immer so groß wie dieser Wert (bei numerischen Daten-Typen z.B.).	smallint	4.0.0
PrecisionValue	Gilt nur für einige numerische Daten-Typen (z.B. „decimal“) und gibt die maximale Anzahl Stellen an, die ein Wert, der in der Spalte „ResultColumnName“ steht, enthalten kann	smallint	4.0.0
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, der in der Spalte „ResultColumnName“steht, enthalten kann	smallint	4.0.0
IntroducedIndStoreVersion	Seit welcher Version gibt es die Spalte „ResultColumnName“	varchar(20)	4.0.0
Description	Beschreibung der Spalte „ResultColumnName“, also was die Werte in dieser Spalte besagen oder bedeuten	varchar(255)	4.0.0
Description_ValidSinceVersion	Seit welcher Version die Beschreibung („Description“) gilt	varchar(20)	7.0.3
Description_LastEdited	Wann die Beschreibung („Description“) zuletzt editiert wurde	datetime	7.0.3

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ProcedureResultConditionID (aufsteigend)
SortNo (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-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

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-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
7.0.3	2013-12-13	1. Neue Rückgabespalten „ProcResultCondDescription“, „Description_ValidSinceVersion“ und „Description_LastEdited“ 2. Neuer Parameter „ProcedureResultConditionID“
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard
6.5.3	2013-03-18	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
4.0.10	2004-03-15	1. Aufruf der Prozeduren „_mi_StartProcedure“, „_mi_FinishProcedure“ und „_mi_ChooseParamValueSeperator“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.0	2003-04-03	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:

do_GetProcedureResultSets_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureResultSets_Ad?ProcedureName=<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_GetProcedureResultSets_Ad',
		array(
			'ProcedureName' => '<value>',
			// 'ProcedureResultConditionID' => 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="do_GetProcedureResultSets_Ad">
			<Parameters>
				<Parameter Name="ProcedureName"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="ProcedureResultConditionID">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis