engine:procedures:do_getproceduredependencies_ad
Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
|
engine:procedures:do_getproceduredependencies_ad [11.01.2016 ] |
engine:procedures:do_getproceduredependencies_ad [11.01.2016 ] (aktuell) |
||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| + | ===== do_GetProcedureDependencies_Ad ===== | ||
| + | |||
| + | Ermittelt Abhängigkeiten zwischen Prozeduren des "dStore" (welche Prozeduren rufen welche Prozeduren auf).\\ | ||
| + | |HTTP-Method|GET | | ||
| + | |HTTP-Auth|Optional | | ||
| + | |Tags|{{tag>[do Get Procedure Dependencies Ad]}}| | ||
| + | |Engine-Kategorie|documentation | | ||
| + | |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 ^ | ||
| + | |ProcedureName|NULL |Name einer Prozedur, für die abhängige bzw. benötigte Prozeduren ermittelt werden sollen. Falls "NULL", wird nur nach "ProcedureCategoryID" gefiltert - ist auch dieser "NULL", werden die Abhängigkeiten ALLER Prozeduren ermittelt.\\ |varchar(50)|4.0.0| | ||
| + | |ProcedureCategoryID|NULL |ID einer Kategorie von Prozeduren (mögliche Werte : siehe [[dstoreproc>do_GetProcedureCategories_Ad]]), nach der gefiltert werden soll. Bei "NULL" wird nur nach "ProcedureName" gefiltert - ist auch dieser "NULL", werden die Abhängigkeiten ALLER Prozeduren ermittelt.\\ |tinyint|4.0.0| | ||
| + | |AscertainUsedProcedures|1 |Sind "Procs" die Prozeduren, die "ProcedureName" bzw. "ProcedureCategoryID" entsprechen (sonst wird "AscertainUsedProcedures" nicht beachtet), dann :\\ "0" : Von welchen Prozeduren werden "Procs" benötigt ?\\ "1" : Welche Prozeduren benötigen "Procs" ?\\ |bit|4.0.0| | ||
| + | |OrderByLevelOfDependence|0 |"1" angeben, um die Rückgabemenge nach "LevelOfDependence" (kennzeichnet den "Grad der Abhängigkeit", also ob eine Prozedur direkt von einer Prozedur aufgerufen wird oder von einer Prozedur, die von der Prozedur aufgerufen wird usw.) zu sortieren\\ |bit|4.0.0| | ||
| + | |OnlyUpToDependenceLevel|NULL |Falls hier ein Wert "> 0" angegeben wird, ermittelt die Prozedur nicht alle Abhängigkeiten, sondern die Ergebnismenge enthält nur Datensätze mit "LevelOfDependence <= OnlyUpToDependenceLevel"\\ |tinyint|4.0.10| | ||
| + | ==== Rückgabe ==== | ||
| + | |||
| + | === (parameterunabhängig) === | ||
| + | |||
| + | ^Spaltenname ^Beschreibung ^SQL-Datentyp((siehe [[:webservice:engine_datatypes|Datentypen im Bereich "engine"]])) ^ab Version ^ | ||
| + | |ProcedureName|Name einer "dStore"-Prozedur\\ |varchar(50)|4.0.0 | | ||
| + | |UsedProcedure|Name einer "dStore"-Prozedur, die von der durch "ProcedureName" bezeichneten Prozedur aufgerufen wird\\ |varchar(50)|4.0.0 | | ||
| + | |LevelOfDependence|Kennzeichnet den "Grad der Abhängigkeit" :\\ "1" : "UsedProcedure" wird DIREKT aufgerufen\\ "2" : "UsedProcedure" wird von einer Prozedur aufgerufen, die auch in dieser Rückgabemenge (in "UsedProcedure") ist, und zwar mit "LevelOfDependence = 1"\\ usw.\\ |tinyint|4.0.0 | | ||
| + | |||
| + | == Sortierungen der Rückgabe == | ||
| + | |||
| + | wenn OrderByLevelOfDependence = 0 | ||
| + | * ProcedureName (aufsteigend) | ||
| + | * UsedProcedure (aufsteigend) | ||
| + | wenn OrderByLevelOfDependence = 1 | ||
| + | * ProcedureName (aufsteigend) | ||
| + | * LevelOfDependence (aufsteigend) | ||
| + | * UsedProcedure (aufsteigend) | ||
| + | |||
| + | ==== Output-Parameter ==== | ||
| + | |||
| + | Die Prozedur hat keine Output-Parameter.==== 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|nur 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.4 |2014-03-19|"set forceplan on"-Anweisung fehlte an einer Stelle\\ | | ||
| + | |6.5.3 |2013-03-18|"Start-Procedure"-Call wg. UTF-8 Unterstützung angepasst\\ | | ||
| + | |5.0.4 |2005-09-26|Performance-Verbesserung im Fall "ProcedureName = NULL"\\ | | ||
| + | |4.0.10 |2004-03-15|1. "_mi_StartProcedure", "_mi_FinishProcedure" und "_mi_ChooseParamValueSeperator"\\ 2. "set transaction isolation level 1", "set rowcount 0"\\ 3. Konsequente Fehlerbehandlung\\ 4. Div. Fehler, kl. Performance-Verbesser.\\ 5. Neu : "OnlyUpToDependenceLevel"\\ | | ||
| + | |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: | ||
| + | * [[http://playground.dstore.de/index.php?proc=do_GetProcedureDependencies_Ad|do_GetProcedureDependencies_Ad im Engine Playground öffnen]] | ||
| + | == cURL == | ||
| + | Unformatierte Ausgabe: | ||
| + | <code bash> | ||
| + | curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/do_GetProcedureDependencies_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/do_GetProcedureDependencies_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'), | ||
| + | 'do_GetProcedureDependencies_Ad', | ||
| + | array( | ||
| + | // 'ProcedureName' => NULL, | ||
| + | // 'ProcedureCategoryID' => NULL, | ||
| + | // 'AscertainUsedProcedures' => 1, | ||
| + | // 'OrderByLevelOfDependence' => 0, | ||
| + | // 'OnlyUpToDependenceLevel' => NULL | ||
| + | ) | ||
| + | ); | ||
| + | |||
| + | $service->execute($request); | ||
| + | |||
| + | $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); | ||
| + | $ResultSet = $xml_result->getRowsAsArray(); | ||
| + | |||
| + | </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="do_GetProcedureDependencies_Ad"> | ||
| + | <Parameters> | ||
| + | <!-- <Parameter Name="ProcedureName">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="ProcedureCategoryID">NULL</Parameter> --> | ||
| + | <!-- <Parameter Name="AscertainUsedProcedures">1</Parameter> --> | ||
| + | <!-- <Parameter Name="OrderByLevelOfDependence">0</Parameter> --> | ||
| + | <!-- <Parameter Name="OnlyUpToDependenceLevel">NULL</Parameter> --> | ||
| + | </Parameters> | ||
| + | </Procedure> | ||
| + | </Batch> | ||
| + | </ListOfBatches></code> | ||
engine/procedures/do_getproceduredependencies_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)