Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getdbobjects_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:mi_getdbobjects_ad [11.01.2016 ]
engine:procedures:mi_getdbobjects_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== mi_GetDBObjects_Ad =====
 +
 +Ermittelt sogenannte "​Datenbank-Objekte"​ (Tabellen, Prozeduren etc.).\\ ​
 +
 +
 +
 +Anmerkung zum Parameter "​ObjectType"​ :\\ 
 +
 +Die Objekte lassen sich nach bestimmten "​Typen"​ unterscheiden,​ weswegen man sich durch Angabe eines entsprechenden Wertes im Parameter "​ObjectType"​ auch nur Objekte eines bestimmten Typs ausgeben lassen kann. Mögliche Werte :
 +  * "​StoredProc" ​ : für Prozeduren
 +  * "​UserTable" ​  : für Tabellen, die NICHT "​System"​-Tabellen darstellen
 +  * "​SystemTable"​ : für "​System"​-Tabellen
 +  * "​Table" ​      : für Tabellen (egal ob "​System"​-Tabelle oder nicht)
 +  * "​Trigger" ​    : für Trigger
 +  * "​User" ​       : für Benutzer
 +  * "​SQLFunct" ​   : für SQL-Funktionen
 +Man kann auch mehrere der eben genannten Werte übergeben, die dann durch ","​ zu trennen sind. Beispielsweise würde der Wert "​Table,​Trigger"​ dazu führen, daß sowohl Tabellen als auch Trigger ermittelt werden würden.\\ ​
 +
 +
 +
 +Anmerkung zur Rückgabespalte "​DependentObjectID"​ :\\ 
 +
 +Hier steht (falls "​GetDependentObjects = 1" angegeben wurde) die ID eines Objekts, das vom in der Rückgabespalte "​ObjectID"​ referenzierten Objekt in der Form abhängt, daß es ohne dies nicht in der Datenbank existieren kann. Derzeit können solche Objekte nur für Tabellen existieren (es handelt sich dann z.B. um Indizes) !\\ 
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[mi Get Objects Ad]}}|
 +|Engine-Kategorie|system administration |
 +|Engine-Typ|Daten-Ermittlung |
 +|Letzte Aktualisierung|7.0.7 (2015-01-29)|
 +
 +==== Parameter ====
 +
 +^Name ((Pflichtparameter sind unterstrichen)) ^Standard-Wert ^Beschreibung ((siehe [[webservice:​engine_parameterconventions|Parameter-Konventionen engine/<​Prozedur-Name>​]])) ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|ObjectType|NULL |Angeben, wenn man nur bestimmte "​Typen"​ von Objekten haben möchte. Mögliche Werte (mehrere durch ","​ trennen, s. a. Beschreibung) :\\ "​StoredProc"​\\ "​UserTable"​\\ "​SystemTable"​\\ "​Table"​\\ "​Trigger"​\\ "​User"​\\ "​SQLFunct"​\\ |varchar(255)|5.5.0|
 +|OutputIntoOneID|0 |Wird nur beachtet, wenn "​ObjectType"​ angegeben ist !\\ "​0"​ : Nur Ergebnismenge\\ "​1"​ : Keine Ergebnismenge,​ die "​ObjectID"​s werden in "​tempdb.dbo.OneID"​ eingefügt\\ "​2"​ : Ergebnismenge UND die "​ObjectID"​s werden in "​tempdb.dbo.OneID"​ eingefügt\\ |tinyint|5.5.0|
 +|ObjectNameLike|NULL |Sucht man nur Objekte mit einem bestimmten Namen, kann man hier ein "​LIKE"​-pattern angeben (es sind die üblichen "​wildcards"​ für den "​LIKE"​-Operator erlaubt)\\ |varchar(100)|5.5.0|
 +|GetDependentObjects|0 |"​1"​ angeben, um die "​Dependent..."​-Rückgabespalten füllen zu lassen\\ |bit|6.0.0|
 +|DatabaseName|NULL |Name der DB, aus der die Objekte ermittelt werden sollen. Mögliche Werte :\\ * dstore\\ * dstoreifin\\ * dstoreifout\\ * dstoretempdb\\ * tempdb\\ * sybsystemprocs\\ * <Diese DB> o. NULL -> Objekte dieser DB\\ * AllSupportedDBs -> Objekte aus dstore und ... und dieser DB\\ |varchar(50)|6.0.0|
 +==== Rückgabe ====
 +
 +=== (parameterunabhängig) ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|DatabaseName|Name der Datenbank, in der "​ObjectName"​ gespeichert ist\\ |varchar(50)|7.0.0 |
 +|ObjectName|Name des Datenbank-Objektes\\ |varchar(50)|5.5.0 |
 +|ObjectType|Objekt-"​Typ",​ mögl. Werte :\\ "​StoredProc"​ (Prozeduren)\\ "​UserTable"​ (Tabellen, KEINE "​System"​-Tab.)\\ "​SystemTable"​ ("​System"​-Tabellen)\\ "​Trigger"​\\ "​User"​ (Datenbank-Benutzer)\\ "​SQLFunct"​ (SQL-Funktionen)\\ <​type>​ : Wert i. d. Spalte "​type"​ v. "​sysobjects"​\\ |varchar(15)|5.5.0 |
 +|DefinedInSystemTable|In welcher "​System"​-Tabelle der Datenbank das Objekt definiert ist\\ |varchar(50)|5.5.0 |
 +|ObjectID|ID des Objekts in der durch "​DefinedInSystemTable"​ angegebenen "​System"​-Tabelle der Datenbank\\ |integer|5.5.0 |
 +|DependentObjectID|ID eines Objekts, das vom Objekt "​ObjectID"​ in der Form abhängt, daß es ohne "​ObjectID"​ nicht in der Datenbank existieren kann. Wird nur gefüllt, wenn "​GetDependentObjects = 1" angegeben wird (sonst steht hier "​NULL"​). s. a. Beschreibung.\\ |integer|6.0.0 |
 +|DependentObjectName|Name des Objekts "​DependentObjectID"​ ("​NULL",​ wenn "​GetDependentObjects = 0")\\ |varchar(50)|6.0.0 |
 +|DependentObjectType|Um welche "​Art"​ von Objekt es sich bei "​DependentObjectID"​ handelt ("​NULL",​ wenn "​GetDependentObjects = 0"). Derzeit mögliche Werte :\\ - "​Trigger"​\\ - "​Index"​\\ |varchar(15)|6.0.0 |
 +|ObjectLastCreatedAt|Wann das Objekt zuletzt neu erstellt wurde. ACHTUNG : Kann "​NULL"​ sein, falls nicht bekannt (z.B. wenn "​ObjectType"​ den Wert "​User"​ enthält)\\ |datetime|6.0.2 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * DatabaseName (aufsteigend)
 +  * ObjectType (aufsteigend)
 +  * ObjectName (aufsteigend)
 +  * DependentObjectType (aufsteigend)
 +  * DependentObjectName (aufsteigend)
 +
 +==== Output-Parameter ====
 +
 +|DefinedInSystemTable|Wird nur gefüllt, wenn "​ObjectType"​ angegeben ist ! Ausgabeparameter für den Namen der "​System"​-Tabelle in dem Objekte des durch "​ObjectType"​ angegebenen Typs gespeichert werden.|
 +==== Mögliche Return-Codes ====
 +
 +^Code ^Beschreibung ^Quelle ((direkt meint "von der Prozedur selber"​ und indirekt meint "von intern aufgerufenen Unterprozeduren"​)) ^
 +|-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 [[http://​resources.dstore.de/​xsd/​webservice_SmartGate/​Response/​EngineProcedure_v1_0.xsd|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|Index-Angabe fehlte an einigen Stellen => kleine Performanceverbesserung\\ ​ |
 +|7.0.0 |2013-06-04|1. Neuer möglicher Wert für "​DatabaseName"​\\ 2. Neue Rückgabespalte "​DatabaseName"​ (=> neue Sortierung)\\ 3. Datentyp von "​ObjectType"​ erweitert (neue Möglichkeit,​ MEHRERE Werte übergeben zu können)\\ ​ |
 +|6.5.3 |2013-03-18|1. Ab jetzt kann in "​DatabaseName"​ auch der Name dieser DB angegeben werden [was dann wie "​NULL"​ behandelt wird]\\ 2. Interne Anpassungen wg. UTF8-Unterstützung\\ ​ |
 +|6.5.2 |2013-02-26|Neuer möglicher Wert für "​DatabaseName"​\\ ​ |
 +|6.0.4 |2011-10-21|Ab jetzt werden auch "​SQL-Funktionen"​ unterstützt => Neuer möglicher Wert für "​ObjectType"​\\ ​ |
 +|6.0.2 |2011-06-08|Neue Rückgabespalte "​ObjectLastCreatedAt"​\\ ​ |
 +|6.0.0 |2010-03-26|1. Neue Parameter "​GetDependentObjects"​ und "​DatabaseName"​\\ 2. Neue Rückgabespalten "​DependentObjectID",​ "​DependentObjectName"​ und "​DependentObjectType"​\\ ​ |
 +|5.5.0 |2008-01-07|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:
 +  * [[http://​playground.dstore.de/​index.php?​proc=mi_GetDBObjects_Ad|mi_GetDBObjects_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_GetDBObjects_Ad'</​code>​Mit xmllint ((I.d.R. auf Unix-artigen Systemen bereits installiert,​ Bestandteil der libxml2, siehe http://​www.xmlsoft.org)) formatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_GetDBObjects_Ad'​ | xmllint --format -</​code>​== dStore_php ==
 +<code 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_GetDBObjects_Ad',​
 + array(
 + // '​ObjectType'​ => NULL,
 + // '​OutputIntoOneID'​ => 0,
 + // '​ObjectNameLike'​ => NULL,
 + // '​GetDependentObjects'​ => 0,
 + // '​DatabaseName'​ => NULL
 + )
 +);
 +
 +$service->​execute($request);​
 +
 + $xml_result = $request->​getResponse()->​getBody()->​toSimpleXmlDocument();​
 + $ResultSet = $xml_result->​getRowsAsArray();​
 +
 +$OutputParams = $xml_result->​getOutputParametersAsArray();</​code>​
 +== engine/​execute ==
 +XML zur Ausführung mit der Methode [[:​webservice:​engine:​execute|engine/​execute]],​ z.B. per
 +  curl --header '​Content-Type:​ application/​xml'​ -X POST '​http://<​partner>​-<​kunde>​.dstore.de/​default/​engine/​execute'​ -d '<​xml-daten>'​
 +
 +<code xml>
 +<?xml version="​1.0"​ encoding="​UTF-8"?>​
 +<​ListOfBatches>​
 + <Batch No="​0">​
 + <​Procedure Name="​mi_GetDBObjects_Ad">​
 + <​Parameters>​
 + <!-- <​Parameter Name="​ObjectType">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​OutputIntoOneID">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​ObjectNameLike">​NULL</​Parameter>​ -->
 + <!-- <​Parameter Name="​GetDependentObjects">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​DatabaseName">​NULL</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/mi_getdbobjects_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)