Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:mi_getsqlfunctioncode_ad

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

engine:procedures:mi_getsqlfunctioncode_ad [11.01.2016 ] (aktuell)
Zeile 1: Zeile 1:
 +===== mi_GetSQLFunctionCode_Ad =====
 +
 +Gibt den Source-Code einer SQL-Funktion (entweder via "​print"​ auf der Standard-Ausgabe oder als Ergebnismenge) aus.\\ ​
 +
 +Hinweise :\\ 
 +
 +1.) Wenn Kommentare ausgelassen werden sollen und die verbleibenden Zeichen NUR aus "​tabs"​ und/oder "​spaces"​ und/oder "​CRs"​ bestehen, lassen wir die entsprechende Zeile ganz aus !\\ 
 +
 +2.) Wir gehen davon aus, daß eine Code-Zeile mit dem "line feed"​-Zeichen (ASCII-Code "​10"​) endet !\\ 
 +
 +3.) Das "line feed"​-Zeichen geben wir NICHT MIT ZURÜCK !\\ Anmerkung : Falls jedoch die Zeile NUR aus einem "line feed" besteht, geben wir einen "​leeren string"​ (%%''​%%) zurück.\\ ​
 +
 +4.) Wenn der Quellcode von einem DOS-/​Windows-Client wie dem "SQL Advantage"​ kompiliert wurde, enthält das Zeilenende die "​CR-LF"​-Kombination,​ also ein "​carriage return"​ (ASCII-Code "​13"​) gefolgt von einem "line feed" (ASCII-Code "​10"​). In diesem Fall lassen wir (neben dem "line feed") auch das "​carriage return"​ aus !\\ Analog (zu 3.) gilt, wenn NUR eine "​CR-LF"​-Kombination vorhanden ist, geben wir einen "​leeren string"​ (%%''​%%) zurück.\\ ​
 +|HTTP-Method|GET |
 +|HTTP-Auth|Optional |
 +|Tags|{{tag>​[mi Get Function Code 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 ^
 +|__SQLFunctionName__| |Name einer SQL-Funktion,​ zu der der Quellcode ermittelt werden soll\\ |varchar(50)|6.0.4|
 +|IgnoreComments|0 |Hiermit kann man steuern, ob Kommentare mit ausgegeben werden sollen ("​0"​) oder nicht ("​1"​)\\ |bit|6.0.4|
 +|GetCodeLinesAsResultSet|0 |Wird nur beachtet, wenn "​OnlyFunctionHeader = 0" ist ! Wird hier "​1"​ angegeben, bekommt man den Source-Code als Ergebnismenge.\\ |bit|6.0.4|
 +|IncludeStatementsForCreation|0 |Wird nur beachtet, wenn "​0"​ für "​GetCodeLinesAsResultSet"​ UND "​OnlyFunctionHeader"​ angegeben ist ! "​1"​ angeben, wenn die Ausgabe alles enthalten soll, um die Prozedur zu erstellen (z.B. inkl. "If exists ... DROP FUNCTION ..."​).\\ |bit|6.0.4|
 +|OnlyFunctionHeader|0 |Soll nur der Funktions-Kopf (Deklaration plus nachfolgender "​Kommentar-Block"​) ausgegeben werden, ist hier "​1"​ zu übergeben. "​GetCodeLinesAsResultSet"​ und "​IncludeStatementsForCreation"​ werden dann ignoriert !\\ |bit|6.0.4|
 +==== Rückgabe ====
 +
 +=== wenn OnlyFunctionHeader = 0 und GetCodeLinesAsResultSet = 1 ===
 +
 +^Spaltenname ​ ^Beschreibung ^SQL-Datentyp((siehe [[:​webservice:​engine_datatypes|Datentypen im Bereich "​engine"​]])) ^ab Version ^
 +|CodeLineNumber|Eindeutige Zeilennummer des Codes "​CodeLine"​\\ |smallint|6.0.4 |
 +|CodePartLineNumber|Eindeutige Zeilennummer des REINEN Codes "​CodePart"​ (also ohne Kommentare). Wenn hier "​NULL"​ steht, ist "​CodePart"​ auch "​NULL"​ !\\ |smallint|6.0.4 |
 +|CodeLine|Der komplette Code, der in Zeile "​CodeLineNumber"​ steht. ACHTUNG : Ist "​IgnoreComments = 1", steht hier immer "​NULL"​ !\\ |varchar(255)|6.0.4 |
 +|CodePart|Der "​reine"​ Code der Code-Zeile (ohne Kommentare). Anmerkungen :\\ * Wenn die verbleibenden Zeichen NUR aus "​tabs"​ und/oder "​spaces"​ und/oder "​CRs"​ bestehen, steht hier "​NULL"​\\ * Ist "​IgnoreComments = 1", erhält man nur Zeilen, die hier NICHT "​NULL"​ enth.\\ |varchar(255)|6.0.4 |
 +|CommentPart|Jeglicher Kommentar in der Code-Zeile\\ ACHTUNG : Ist "​IgnoreComments = 1", steht hier immer "​NULL"​ !\\ |varchar(255)|6.0.4 |
 +
 +== Sortierung der Rückgabe ==
 +
 +(parameterunabängige Sortierung)
 +  * CodeLineNumber (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"​)) ^
 +|-577|Der Source-Code der SQL-Funktion 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 [[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]\\ ​ |
 +|6.5.3 |2013-03-18|Interne Anpassungen wg. UTF8-Unterstützung\\ ​ |
 +|6.0.4 |2011-10-21|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_GetSQLFunctionCode_Ad|mi_GetSQLFunctionCode_Ad im Engine Playground öffnen]]
 +== cURL ==
 +Unformatierte Ausgabe:
 +<code bash>
 +curl -X GET  '​http://<​partner>​-<​project>​.dstore.de/​default/​engine/​mi_GetSQLFunctionCode_Ad?​SQLFunctionName=<​value>'</​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_GetSQLFunctionCode_Ad?​SQLFunctionName=<​value>'​ | 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_GetSQLFunctionCode_Ad',​
 + array(
 + '​SQLFunctionName'​ => '<​value>',​
 + // '​IgnoreComments'​ => 0,
 + // '​GetCodeLinesAsResultSet'​ => 0,
 + // '​IncludeStatementsForCreation'​ => 0,
 + // '​OnlyFunctionHeader'​ => 0
 + )
 +);
 +
 +$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="​mi_GetSQLFunctionCode_Ad">​
 + <​Parameters>​
 + <​Parameter Name="​SQLFunctionName"><​!-- varchar value --></​Parameter>​
 + <!-- <​Parameter Name="​IgnoreComments">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​GetCodeLinesAsResultSet">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​IncludeStatementsForCreation">​0</​Parameter>​ -->
 + <!-- <​Parameter Name="​OnlyFunctionHeader">​0</​Parameter>​ -->
 + </​Parameters>​
 + </​Procedure>​
 + </​Batch>​
 +</​ListOfBatches></​code>​
  
engine/procedures/mi_getsqlfunctioncode_ad.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)