mi_GetRegisteredProcedures_Ad [dstore]

Inhaltsverzeichnis

mi_GetRegisteredProcedures_Ad

mi_GetRegisteredProcedures_Ad

Gibt im „dStore“ registrierte Prozeduren zurück. Diese Registrierung wird für „BatchJob“-Prozeduren benötigt und dient der Steuerung der Protokollierung von Prozedur-Aufrufen sowie der Überprüfung von Ausführungsbeschränkungen.

Mit Hilfe von mi_ModifyRegisteredProcs_Ad kann man auch sogenannte „customized“ Prozeduren („cu“-Prozeduren, da sie im Namen ein „_cu_“ enthalten müssen), die nicht Bestandteil des „dStore“ sind sondern individuell für eine bestimmte Installation gelten, registrieren, um die genannten Funktionalitäten hinsichtlich Protokollierung und Überprüfung nutzen zu können.

Anmerkung zu „LogExecutions“ :

Wenn der Aufruf einer Prozedur protokolliert wird (bei „LogExecution“ stehe ein Wert größer als „1“), werden immer gewisse Basis-Informationen gespeichert : „Wer wann wie schnell mit welchem Ergebnis“.
Darüber hinaus kann man zusätzlich die Parameter und/oder einige Prozeß-Informationen (aus der System-Tabelle „master..sysprocesses“) speichern lassen.

Möglich Werte sind :

„2“ : Standard-Protokollierung
„6“ : Zusätzliche Protokollierung der Parameter-Werte - dazu gehören auch evtl. in „tempdb“-Tabellen übergebene Werte
„10“ : Zusätzliche Protokollierung von Werten aus „master..sysprocesses“ - derzeit die „Server-Prozeß-ID“ und die „Engine“-Nummer (vom ASE intern verwaltet) sowie den Host und das Programm von dem die Prozedur aufgerufen wird
„14“ : Komplette Protokollierung, d.h. sowohl inkl. der Parameter-Werte als auch bestimmter Werte aus „master..sysprocesses“

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Registered, Procedures, Ad]
Engine-Kategorie	basics
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
ProcedureID	NULL	ID einer registrierten Prozedur. Falls angegeben, wird nur der Datensatz zu dieser Prozedur ausgegeben.	smallint	4.0.8
ProcedureName	NULL	Wird nur beachtet, wenn „ProcedureID“ „NULL“ ist ! Ist auch hier „NULL“ angegeben, werden alle registrierten Prozeduren ausgeliefert, sonst nur die mit „ProcedureName = ProcedureName“ bzw. „ProcedureName LIKE ProcedureName“ (je nach „SearchWithLike“).	varchar(50)	4.0.8
SearchWithLike	0	Wird nur beachtet, wenn „ProcedureID = NULL“ ist ! Es werden nur die Datensätze ausgegeben mit… „0“ : „ProcedureName = ProcedureName“ „1“ : „ProcedureName LIKE ProcedureName“ („ProcedureName“ kann dann die in T-SQL erlaubten „wildcards“ enthalten)	bit	4.0.8
ExecRightConfigurable	0	Gibt an, ob nur die registrierten Prozeduren ausgegeben werden sollen, für die die Konfiguration von Ausführungsbeschränkungen möglich ist („1“) oder alle registrierten Prozeduren („0“)	bit	7.0.5

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ProcedureID	ID einer registrierten Prozedur	smallint	4.0.8
ProcedureName	Name der Prozedur	varchar(50)	4.0.8
CheckForExecutionRestrictions	Es können Einschränkungen bzgl. der Parameter beim Aufruf der Prozedur konfiguriert werden (z.B. mit mi_ModifyProcExRestForUser_Ad), sofern hier nicht „0“ steht. Ansonsten ist eine Überprüfung möglich - sie ist entweder inaktiv („1“) oder aktiv („2“).	tinyint	4.0.8
LogExecutions	Sofern jeder Aufruf der Prozedur grundsätzlich protokolliert werden kann (falls nicht, steht hier „0“), gibt der Wert an, was protokolliert werden soll (s. Beschreibung). „1“ bedeutet, daß eine Protokollierung nicht durchgeführt wird, aber möglich ist.	tinyint	4.0.8

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ProcedureName (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-577	Der Source-Code der SQL-Funktion ist nicht verfügbar	nur indirekt
-574	Der Source-Code des Triggers ist nicht verfügbar	nur indirekt
-573	Der Source-Code der Prozedur ist nicht verfügbar	nur indirekt
-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	nur 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.5	2014-05-26	Neuer Parameter „ExecRightConfigurable“
6.5.3	2013-03-18	Anpassungen an den aktuellen Quellcode-Standard, u.a. wg. UTF8-Unterstützung
5.1.3	2006-07-27	Fehler : Durch ein fehlendes explizites Konvertieren war bisher [entgegen der Dokumentation] die Rückgabespalte „CheckForExecutionRestrictions“ ein „integer“
5.0.0	2004-12-21	Interne Änderung bzgl. „CheckForExecutionRestrictions“ berücksichtigen und Abwärtskompatibilität gewährleisten
4.0.9	2004-03-03	1. Verwendung von „_mi_ChooseParamValueSeperator“ als Vorbereitung von „_mi_StartProcedure“ 2. Ausführen von „set transaction isolation level 1“ und „set rowcount 0“ zu Beginn der Prozedur
4.0.8	2004-02-20	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:

mi_GetRegisteredProcedures_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetRegisteredProcedures_Ad'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetRegisteredProcedures_Ad' | 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_GetRegisteredProcedures_Ad',
		array(
			// 'ProcedureID' => NULL,
			// 'ProcedureName' => NULL,
			// 'SearchWithLike' => 0,
			// 'ExecRightConfigurable' => 0
		)
);
 
$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_GetRegisteredProcedures_Ad">
			<Parameters>
				<!-- <Parameter Name="ProcedureID">NULL</Parameter> -->
				<!-- <Parameter Name="ProcedureName">NULL</Parameter> -->
				<!-- <Parameter Name="SearchWithLike">0</Parameter> -->
				<!-- <Parameter Name="ExecRightConfigurable">0</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