do_GetdStoreTables_Ad [dstore]

Inhaltsverzeichnis

do_GetdStoreTables_Ad

do_GetdStoreTables_Ad

Liefert Namen der Tabellen zurück, die im „dStore“ verwendet werden

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[do, Getd, Store, Tables, 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
TableName	NULL	Name einer Tabelle. Falls angegeben, wird nur der entsprechende Datensatz zurückgegeben.	varchar(50)	7.0.3
TableCategoryID	NULL	Wird nur beachtet, wenn „TableName = NULL“. ID einer Kategorie, in die „dStore“-Tabellen eingeordnet werden können (mögliche Werte : s. do_GetTableCategories_Ad). Falls angegeben, werden nur Tabellen zurückgegeben, die dieser Kategorie zugeordnet sind.	tinyint	7.0.3

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TableName	Der Name einer Tabelle (wenn angegeben, dann natürlich „TableName“), die in (Engine-)Prozeduren verwendet wird. Das kann also durchaus auch eine System-Tabelle sein und/oder eine Tabelle aus einer anderen (System- bzw. dStore-)Datenbank.	varchar(50)	7.0.3
Description	Beschreibung wozu die Tabelle da ist bzw. was für Daten sie enthält	text	7.0.3
TableCategoryID	Die ID der Kategorie, in die die Tabelle eingeordnet ist	tinyint	7.0.3
TableCategory	Der Name von „TableCategoryID“	varchar(100)	7.0.3

Sortierung der Rückgabe

(parameterunabängige Sortierung)

TableCategoryID (aufsteigend)
TableName (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	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.3	2013-12-13	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_GetdStoreTables_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

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

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/do_GetdStoreTables_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'),
	'do_GetdStoreTables_Ad',
		array(
			// 'TableName' => NULL,
			// 'TableCategoryID' => 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_GetdStoreTables_Ad">
			<Parameters>
				<!-- <Parameter Name="TableName">NULL</Parameter> -->
				<!-- <Parameter Name="TableCategoryID">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