Wiki-Quellcode von DB-Abfragen

Zeige letzte Bearbeiter
1 {{content/}}
2
3 Datenbankabfragen verhalten sich ähnlich wie [[Datenquellen>>doc:Sources]] (XML, CSV, JSON), werden jedoch nicht statisch hinterlegt, sondern dynamisch aus einer Datenbank ausgelesen.
4
5 {{info}}
6 Bei der Erstellung einer Abfrage wird eine bereits angelegte [[Verbindung>>doc:DBConnections]] zu einer Datenbank benötigt.
7 {{/info}}
8
9 == Anlegen einer SQL-Abfrage ==
10
11 {{id name="data_db_query"/}}
12 {{figure image="data_db_query_de.png"}}Die Konfigurationsoberfläche zum Anlegen einer SQL-Abfrage besteht aus vier Teilen: (1) Liste der existierenden Datenbank-Abfragen, (2) Editor zum Definieren der SQL-Abfrage, (3) Einstellungen der Datenbank-Abfrage, (4) Maske zum Testen der Datenbank-Abfrage.{{/figure}}
13
14 * Öffnen Sie das Modul "DB-Abfragen" und klicken Sie auf die Schaltfläche "Neu" {{ficon name="plus-circle-outline"/}} in der Kopzeile der Liste (siehe [[Abbildung>>||anchor="fig_data_db_query"]]).
15 * Für die Datenbank-Abfrage werden folgende Daten benötigt:
16 ** **Name**: Ein eindeutiger Name der Datenbank-Abfrage
17 ** **Beschreibung**: Eine optionale Beschreibung der Datenbank-Abfrage
18 ** **Verbindung**: Die [[DB-Verbindung>>doc:DBConnections]], die verwendet werden soll
19
20 * Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]).
21
22 Das eingegebene Statement wird als //Prepared-Statement// ausgeführt, so dass keine sogenannte //SQL-Injection// moglich ist. Verwenden Sie daher auch keine Hochkommas. Prinzipiell können auch Übergabeparameter verwendet werden. In der Abfrage setzen Sie an die Stelle des Übergabeparameters ein Fragezeichen {{code}}?{{/code}}.
23
24 == Verwenden der Abfrage ==
25
26 Die Datenbankabfrage ist innerhalb und außerhalb eines Formulars über das hierfür vorgesehene //Servlet// unter Verwendung der entsprechenden Parameter abrufbar. Die URL zur Datenbankabfrage lautet wie folgt:
27
28 {{code}}
29 http://<server>/formcycle/datenabfragedb
30 {{/code}}
31
32 Die Servlet-URL wird unterhalb der Einstellungen angezeigt (siehe [[Abbildung>>||anchor="data_db_query"]]).
33 Folgende URL-Parameter sind hierbei möglich:
34
35 {{table dataTypeAlpha="0" preSort="0-asc"}}
36 |=Parametername|=Beschreibung|=Erforderlich
37 |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
38 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
39 |projektId|Muss der ID des Formulars entsprechen. Diese Information kann über {{code language="javascript"}}XFC_METADATA.currentProject.id{{/code}} abgerufen werden.|Ja, wenn //mandantName// nicht gegeben
40 |sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|
41 |queryParameter|Nur erforderlich, wenn innerhalb der Datenbank-Datenquelle Platzhalter in Form eines Fragezeichens verwendet werden. Ist dies der Fall, so entspricht dieser der komma-separierten Listen der zu verwendeten Parameter. (ab Version 6)|Nein
42 |varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein
43 |delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein
44 {{/table}}
45
46 Bei Zugriff aus einem Formular verwenden Sie bitte immer das globale Variablenobjekt //XFC_METADATA//, siehe hierzu auch die [[Metadaten>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.FormMetadata]]. In diesem Objekt stehen alle relevanten URLs von {{formcycle case="dat"/}} zur Verfügung, sodass diese Beispielhaft wie folgt ermittelt werden kann: {{code language="javascript"}}XFC_METADATA.urls.datasource_db{{/code}}.
47
48 Ferner empfehlen wir, innerhalb des Formulars die Skriptfunktion [[getDataQuery>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.AdditionalScriptFunctions.GetDataQuery]] zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart.
49
50 Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
51
52 == Sonderfall Auswahlelement ==
53
54 Soll das Ergebnis einer Datenbankabfrage direkt in ein [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}.
55
56 {{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}}
57
58 Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
59
60 {{box}}
61 Sichtbarer Wert, Übertragener Wert, Optionaler Wert 1, Optionaler Wert 2, ...
62 {{/box}}
63
64 Alle übertragenenen Werte werden als Wert des HTML-Attribut //col0// (//sichtbarer Wert//), //col1// (//übertragener Wert//), //col2// (//optionaler Wert 1//), //col3// (//optionaler Wert 2//) usw. an das jeweilige //option//-Element angefügt.
65
66 Der //sichtbare Wert// wird in der Auswahlliste im Formular angezeigt. Der //übertragene Wert// wird als Wert des HTML-Attributs //value// beim Absenden des Formulars übertragen.
67
68 Werden zudem noch ein oder mehrere //optionale Werte// von der SQL-Datenbankabfrage zurückgegeben, so können diese per //Javascript// über den folgenden //jQuery-Selector// abgerufen werden.
69
70 {{code language="javascript"}}
71 $('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück.
72 {{/code}}
73
74
75 == Beipiele ==
76
77 {{code language="sql"}}
78 select name, vorname from tabelle where vorname like(?)
79 {{/code}}
80
81 Diese SQL-Abfrage liefert die Namen aller Personen zurück, die einen bestimmten Vornamen haben. Nach welchem Vornamen gesucht werden soll, kann über einen URL-Parameter angegeben werden.
82
83 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
84
85
86 {{code language="sql"}}
87 select name, vorname from tabelle where id=?
88 {{/code}}
89
90 Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
91
92 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
93
94
95 {{code language="sql"}}
96 select name, vorname from tabelle where ort like(?) AND plz = ?
97 {{/code}}
98
99 Diese SQL-Abfrage liefert die Namen aller Personen zurück, die an einem bestimmten Ort wohnen. Der Ort mit Postleitzahl wird über URL-Parameter übergeben.
100
101 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}

Navigation

Copyright 2000-2024