mi_SearchSourceCode_Ad [dstore]

Inhaltsverzeichnis

mi_SearchSourceCode_Ad

mi_SearchSourceCode_Ad

Durchsucht den Source-Code von Objekten, die „T-SQL“-Code enthalten.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Search, Source, Code, Ad]
Engine-Kategorie	system administration
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
SearchPattern		Ausdruck, nach dem (mit dem „LIKE“-Operator) im Quelltext gesucht werden soll	varchar(100)	5.1.8
CaseSensitive	0	Möchte unter Berücksichtigung von Groß- und Kleinschreibung suchen lassen, übergibt man hier den Wert „1“	bit	5.1.8
DoNotSearchInCommentPart	1	Wo soll gesucht werden : „0“ : AUCH in Kommentaren „1“ : NICHT in Kommentare „2“ : NUR in Kommentaren	tinyint	5.1.8
SearchOnlyThisObjectName	NULL	Soll nur ein bestimmtes Objekt durchsucht werden, kann man hier den entsprechenden Namen angeben (derzeit nur eine Prozedur oder ein Trigger). Ist der Quelltext dieses Objektes nicht (in „syscomments“) vorhanden, gibt es einen Fehler !	varchar(50)	5.1.8
SearchOnlyObjectType	NULL	Wird nur beachtet, wenn „NULL“ für „SearchOnlyThisObjectName“ angegeben ist ! Falls angegeben, werden nur Objekte dieses Typs durchsucht. Mögliche Werte : * „StoredProc“ (für Prozeduren) * „Trigger“ * „SQLFunct“ (für SQL-Funktionen)	varchar(10)	5.1.8
GetDistinctObjectNamesOnly	0	Ist man lediglich an einer Auflistung der „ObjectName“s, in denen „SearchPattern“ gefunden wurde, interessiert, gibt man hier „1“ an (und erhält dann eine andere Rückgabemenge)	bit	5.5.0
SearchObjectsWithNameLike	NULL	Wird nur beachtet, falls „NULL“ für „SearchOnlyThisObjectName“ angegeben wurde ! Wenn angegeben, werden alle Objekte (des Typs „SearchOnlyObjectType“ falls angegeben) durchsucht, deren Name bei Anwendung des „LIKE“-Operators übereinstimmt.	varchar(100)	5.5.2

Rückgabe

wenn GetDistinctObjectNamesOnly = 0

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
ObjectName	Name des Objektes, in dessen Source-Code „SearchPattern“ vorkommt	varchar(50)	5.1.8
ObjectType	Gibt an, um was für einen Typ es sich bei dem Objekt „ObjectName“ handelt. Mögliche Werte : * „StoredProc“ (für Prozeduren) * „Trigger“ * „SQLFunct“ (für SQL-Funktionen)	varchar(10)	5.1.8
CodeLineNumber	Eindeutige Nummer der Zeile im Source-Code von „ObjectName“, in der „SearchPattern“ gefunden wurde	smallint	5.1.8
CodeLine	Der komplette Code, der in Zeile „CodeLineNumber“ des Source-Codes von „ObjectName“ steht	varchar(255)	5.1.8

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ObjectName (aufsteigend)
ObjectType (aufsteigend)
CodeLineNumber (aufsteigend)

wenn GetDistinctObjectNamesOnly = 1

Spaltenname	Beschreibung	SQL-Datentyp⁵⁾	ab Version
ObjectName	Name des Objektes, in dessen Source-Code „SearchPattern“ vorkommt	varchar(50)	5.5.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

ObjectName (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]
6.5.3	2013-03-18	1. Interne Anpassungen wg. UTF8-Unterstützung 2. Fehler : Wenn nichts gefunden wurde, gab es bislang im Fall „GetDistinctObjectNamesOnly = 1“ keine leere Ergebnismenge sondern eine Rückgabemenge mit einem Datensatz und „NULL“ in den Rückgabespalten
6.0.4	2011-10-21	Ab jetzt werden auch „SQL-Funktionen“ unterstützt ⇒ Neuer möglicher Wert für „SearchOnlyObjectType“
5.5.2	2008-10-21	Neuer Parameter „SearchObjectsWithNameLike“
5.5.0	2008-01-07	Neuer Parameter „GetDistinctObjectNamesOnly“
5.1.8	2006-12-12	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_SearchSourceCode_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_SearchSourceCode_Ad?SearchPattern=<value>'

Mit xmllint ⁷⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_SearchSourceCode_Ad?SearchPattern=<value>' | 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_SearchSourceCode_Ad',
		array(
			'SearchPattern' => '<value>',
			// 'CaseSensitive' => 0,
			// 'DoNotSearchInCommentPart' => 1,
			// 'SearchOnlyThisObjectName' => NULL,
			// 'SearchOnlyObjectType' => NULL,
			// 'GetDistinctObjectNamesOnly' => 0,
			// 'SearchObjectsWithNameLike' => 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="mi_SearchSourceCode_Ad">
			<Parameters>
				<Parameter Name="SearchPattern"><!-- varchar value --></Parameter>
				<!-- <Parameter Name="CaseSensitive">0</Parameter> -->
				<!-- <Parameter Name="DoNotSearchInCommentPart">1</Parameter> -->
				<!-- <Parameter Name="SearchOnlyThisObjectName">NULL</Parameter> -->
				<!-- <Parameter Name="SearchOnlyObjectType">NULL</Parameter> -->
				<!-- <Parameter Name="GetDistinctObjectNamesOnly">0</Parameter> -->
				<!-- <Parameter Name="SearchObjectsWithNameLike">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