Inhaltsverzeichnis

mi_GetProcMetaProperties_Ad

Ermittelt gewisse Meta-Eigenschaften einer Prozedur (wie z.B. Erstellungsdatum, Autor, etc.).

Anmerkung zur Meta-Eigenschaft „ShortDescription“ : Hierbei handelt es sich um den ersten Absatz der Meta-Eigenschaft „Description“.

HTTP-MethodGET
HTTP-AuthOptional
Aliasmi_GetProcedureMetaProperties_Ad
Tags
, , , , ,
Engine-Kategoriesystem administration
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
ProcedureName Name einer Prozedur, zu der Meta-Eigenschaften ermittelt werden sollen
varchar(30)6.0.0
MetaInfoTypeNULL Angeben, um nur eine bestimmte Meta-Information zu erhalten. Mögliche Werte :
* 'Author'
* 'FirstCreatedAt'
* 'FirstdStoreVersion'
* 'LastChangedAt'
* 'LastCreationDate'
* 'ChangeLog'
* 'Description'
* 'ShortDescription'
varchar(50)6.0.0

Rückgabe

(parameterunabhängig)

Spaltenname Beschreibung SQL-Datentyp4) ab Version
MetaInfoTypeArt der Meta-Eigenschaft. Mögliche Werte : s. Beschreibung zum Parameter „MetaInfoType“.
Hinweis : Zu ein und demselben „MetaInfoType“-Wert können mehrere Datensätze zurückkommen (dann aber mit unterschiedlicher „CodeLineNumber“)
varchar(50)6.0.0
InformationDie in der Zeile „CodeLineNumber“ gefundene Meta-Eigenschaft
varchar(250)6.0.0
CodeLineNumberEindeutige Nummer der Zeile im Quellcode, in der die Meta-Eigenschaft „Information“ gefunden wurde
smallint6.0.0
Sortierung der Rückgabe

(parameterunabängige Sortierung)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 5)
-577Der Source-Code der SQL-Funktion ist nicht verfügbarnur indirekt
-574Der Source-Code des Triggers ist nicht verfügbarnur indirekt
-573Der Source-Code der Prozedur ist nicht verfügbarnur indirekt
-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 Parameternur 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-18Interne Anpassungen wg. UTF8-Unterstützung
6.0.2 2011-06-08Neue Werte „Description“ und „ShortDescription“ für „MetaInfoType“ möglich ⇒ Doku-Anpassung
6.0.0 2010-03-26Erstmalig 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_GetProcMetaProperties_Ad?ProcedureName=<value>'

Mit xmllint 6) formatierte Ausgabe: 

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetProcMetaProperties_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'),
	'mi_GetProcMetaProperties_Ad',
		array(
			'ProcedureName' => '<value>',
			// 'MetaInfoType' => 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_GetProcMetaProperties_Ad">
			<Parameters>
				<Parameter Name="ProcedureName"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="MetaInfoType">NULL</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
2)
siehe Parameter-Konventionen engine/<Prozedur-Name>
3) , 4)
siehe Datentypen im Bereich "engine"
5)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
6)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org