| ... |
... |
@@ -9,19
+9,31 @@ |
| 9 |
9 |
== Anlegen einer SQL-Abfrage == |
| 10 |
10 |
|
| 11 |
11 |
{{id name="data_db_query"/}} |
| 12 |
|
-{{figure image="data_db_query_de.png"}}Anlegen einer SQL-Abfrage in {{formcycle case="dat"/}}{{/figure}} |
|
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) Konsole zum Testen der Datenbank-Abfrage.{{/figure}} |
| 13 |
13 |
|
| 14 |
|
-* Vergeben Sie einen eindeutigen Namen. |
| 15 |
|
-* Wählen Sie die Verbindung zur Datenbank |
| 16 |
|
-* Die eigentliche SQL-Abfrage ein kann im Editor in der Mitte einegeben werdn (siehe [[Abbildung>>||anchor="data_db_query"]]). |
| 17 |
17 |
|
| 18 |
|
-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}}. |
|
15 |
+{{html wiki="true"}} |
|
16 |
+<div class='xm-figure xm-float-right xm-clear-global' data-alt='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) Konsole zum Testen der Datenbank-Abfrage.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='data_db_query_de.png' width='300' group='$height' group='$group' title='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) Konsole zum Testen der Datenbank-Abfrage.'/}}<div class='xm-figure-caption'>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) Konsole zum Testen der Datenbank-Abfrage.</div></div></div> |
|
17 |
+{{/html}} |
| 19 |
19 |
|
|
19 |
+ |
|
20 |
+* Ö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"]]). |
|
21 |
+* Für die Datenbank-Abfrage werden folgende Daten benötigt: |
|
22 |
+** **Name**: Ein eindeutiger Name der Datenbank-Abfrage |
|
23 |
+** **Beschreibung**: Eine optionale Beschreibung der Datenbank-Abfrage |
|
24 |
+** **Verbindung**: Die [[DB-Verbindung>>doc:DBConnections]], die verwendet werden soll |
|
25 |
+ |
|
26 |
+* Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]). |
|
27 |
+ |
|
28 |
+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 language="none"}}?{{/code}}. |
|
29 |
+ |
|
30 |
+{{version major="6" minor="4" patch="0"/}} In den SQL-Statements können [[Platzhalter>>doc:Formcycle.UserInterface.Variables.WebHome]] verwendet werden. |
|
31 |
+ |
| 20 |
20 |
== Verwenden der Abfrage == |
| 21 |
21 |
|
| 22 |
22 |
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: |
| 23 |
23 |
|
| 24 |
|
-{{code}} |
|
36 |
+{{code language="none"}} |
| 25 |
25 |
http://<server>/formcycle/datenabfragedb |
| 26 |
26 |
{{/code}} |
| 27 |
27 |
|
| ... |
... |
@@ -31,25
+31,55 @@ |
| 31 |
31 |
{{table dataTypeAlpha="0" preSort="0-asc"}} |
| 32 |
32 |
|=Parametername|=Beschreibung|=Erforderlich |
| 33 |
33 |
|name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja |
| 34 |
|
-|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben |
|
46 |
+|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenbank-Abfrage erstellt wurde.|Ja, wenn //projektId// nicht gegeben |
| 35 |
35 |
|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 |
| 36 |
|
-|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.| |
| 37 |
|
-|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 |
|
48 |
+|--sqlParameter--|Synonym für //queryParameter//. Sollte in {{formcycle/}} Version 6 nicht mehr verwendet werden und wird voraussichtlich in der nächsten Major-Versionen entfernt.| |
|
49 |
+|queryParameter|Nur erforderlich, wenn innerhalb der Datenbank-Abfrage Platzhalter in Form eines Fragezeichens verwendet werden. Ist dies der Fall, so entspricht dieser der komma-separierten Listen der zu verwendeten Parameter. |
|
50 |
+ |
|
51 |
+Wenn möglich sollte für neue Projekte anstelle des Parameters //queryParameter// der Parameter //queryParameterValues// verwendet werden, da //queryParameter// in einer zukünftigen Version von {{formcycle/}} nicht mehr unterstützt werden wird.|Nein |
|
52 |
+|delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code language="none"}},{{/code}}. |
|
53 |
+ |
|
54 |
+Wenn möglich sollte für neue Projekte anstelle der Parameter //delimiter// und //queryParameter// der Parameter //queryParameterValues// verwendet werden, da //delimiter// in einer zukünftigen Version von {{formcycle/}} nicht mehr unterstützt werden wird.|Nein |
|
55 |
+|queryParameterValues|{{version major="6" minor="6" patch="3"/}}Ab {{formcycle/}} Version 6.6.3 zur Verfügung stehende Alternative zu den Parametern //queryParameter// und //delimiter//. Wie diese Parameter ist auch //queryParameterValues// nur dann erforderlich, wenn innerhalb der Datenbank-Abfrage Platzhalter in Form eines Fragezeichens {{code language="none"}}?{{/code}} verwendet werden. Ist dies der Fall, werden die einzelnen Abfrageparameter hintereinander jeweils als ein eingener Parameter //queryParameterValues// übergegeben, wodurch auch die Verwendung des Parameters //delimiter// entfällt.|Nein |
|
56 |
+ |
| 38 |
38 |
|varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein |
| 39 |
|
-|delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein |
| 40 |
40 |
{{/table}} |
| 41 |
41 |
|
| 42 |
|
-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}}. |
|
60 |
+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}}. |
| 43 |
43 |
|
| 44 |
|
-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. |
|
62 |
+Ferner empfehlen wir, innerhalb des Formulars die JavaScript-Funktion {{jsdoc page="xutil" name="getdataquery"/}} zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart. |
| 45 |
45 |
|
| 46 |
46 |
Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden. |
| 47 |
47 |
|
|
66 |
+== Testen der Abfrage == |
|
67 |
+ |
|
68 |
+{{info}} |
|
69 |
+Zum schnellen Testen der Abfrage steht die Tastenkombination {{code language="none"}}Strg + Enter{{/code}} zur Verfügung. |
|
70 |
+{{/info}} |
|
71 |
+ |
|
72 |
+Datenbank-Abfragen können direkt in der Konfigurationsoberfläche getestet werden. Hierzu steht eine Testkonsole unterhalb des SQL-Editors zur Verfügung (siehe [[Abbildung>>||anchor="data_db_query"]]). |
|
73 |
+Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage: |
|
74 |
+ |
|
75 |
+* {{ficon name="database-search"/}}**Abfrage ausführen** |
|
76 |
+Führt die Datenbank-Abfrage aus. Werden //Abfrageparameter// ({{code language="none"}}?{{/code}}) verwendet, wird der Nutzer aufgefordert Werte für diese Parameter einzugeben. Ist dies nicht der Fall wird das Ergebnis der Abfrage direkt in der //Tabellenansicht// dargestellt.{{lightbox image="data_db_query_test_de.png" title="Abfrage ausführen"/}} |
|
77 |
+* {{icon name="question"/}}**Abfrageparameter** |
|
78 |
+Maske zum Eingeben von Werten für Abfrageparameter. Diese Option steht nur zur Verfügung, wenn Abfrageparameter ({{code language="none"}}?{{/code}}) in der SQL-Abfrage verwendet werden. Die einzelnen Abfrageparameter werden nummeriert im SQL-Query dargestellt. Ein Klick auf "Parameter für Abfrage verwenden" {{ficon name="arrow-right-bold-circle-outline2"/}} führt die Abfrage mit den eingebenen Parametern aus. Das Ergebnis wird in der //Tabellenansicht// dargestellt. |
|
79 |
+ {{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}} |
|
80 |
+Eigentliche Abfrage im SQL-Editor:{{lightbox image="data_db_query_example_de.png" title="Beispielabfrage"/}} |
|
81 |
+* {{ficon name="table-large"/}}**Tabellenansicht** |
|
82 |
+Abfrageergebnis in Tabellenform{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}} |
|
83 |
+* {{icon name="code"/}}**Quellcodeansicht** |
|
84 |
+Abfrageergebnis im JSON-Format{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}} |
|
85 |
+* {{icon name="Terminal"/}}**Generiertes SQL** |
|
86 |
+Zeigt das generierte SQL-Statement mit eingefügten Parameterwerten{{lightbox image="data_db_query_test_sql_de.png" title="Zeigt den generierten SQL-Query mit eingefügten Parameterwerten"/}} |
|
87 |
+ |
| 48 |
48 |
== Sonderfall Auswahlelement == |
| 49 |
49 |
|
| 50 |
50 |
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"/}}. |
| 51 |
51 |
|
| 52 |
|
-{{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}} |
|
92 |
+{{figure image="data_db_query_designer_de.png"}} |
|
93 |
+Verwenden des Ergebnises einer Datenbankabfrage als Datenquelle für ein Auswahlelement im {{designer case="dat"/}}. |
|
94 |
+{{/figure}} |
| 53 |
53 |
|
| 54 |
54 |
Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet. |
| 55 |
55 |
|
| ... |
... |
@@ -67,7
+67,6 @@ |
| 67 |
67 |
$('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück. |
| 68 |
68 |
{{/code}} |
| 69 |
69 |
|
| 70 |
|
- |
| 71 |
71 |
== Beipiele == |
| 72 |
72 |
|
| 73 |
73 |
{{code language="sql"}} |
| ... |
... |
@@ -74,9
+74,9 @@ |
| 74 |
74 |
select name, vorname from tabelle where vorname like(?) |
| 75 |
75 |
{{/code}} |
| 76 |
76 |
|
| 77 |
|
-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. |
|
118 |
+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. |
| 78 |
78 |
|
| 79 |
|
-Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}} |
|
120 |
+Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Mustermann{{/code}} |
| 80 |
80 |
|
| 81 |
81 |
|
| 82 |
82 |
{{code language="sql"}} |
| ... |
... |
@@ -85,7
+85,7 @@ |
| 85 |
85 |
|
| 86 |
86 |
Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben. |
| 87 |
87 |
|
| 88 |
|
-Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}} |
|
129 |
+Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=100{{/code}} |
| 89 |
89 |
|
| 90 |
90 |
|
| 91 |
91 |
{{code language="sql"}} |
| ... |
... |
@@ -94,4
+94,22 @@ |
| 94 |
94 |
|
| 95 |
95 |
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. |
| 96 |
96 |
|
| 97 |
|
-Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}} |
|
138 |
+Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhausen,02442{{/code}} |
|
139 |
+ |
|
140 |
+ |
|
141 |
+{{code language="sql"}} |
|
142 |
+select name, vorname from tabelle where ort like concat(?, '%') |
|
143 |
+{{/code}} |
|
144 |
+ |
|
145 |
+Diese SQL-Abfrage liefert die Namen aller Personen zurück, die in einem Ort wohnen der mit den gesuchten Buchstaben/Zeichen **beginnt**. Das '%'-Zeichen dient als Platzhalter für beliebig viele beliebige Zeichen. Je nach verwendetem DBMS kann die Syntax geringfügig abweichen (hier: MySQL). Der gesuchte Wert wird über URL-Parameter übergeben. |
|
146 |
+ |
|
147 |
+Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhau{{/code}} |
|
148 |
+ |
|
149 |
+ |
|
150 |
+{{code language="sql"}} |
|
151 |
+select name, vorname from tabelle where lower(ort) like concat('%', lower(?), '%') |
|
152 |
+{{/code}} |
|
153 |
+ |
|
154 |
+Diese SQL-Abfrage liefert die Namen aller Personen zurück, die in einem Ort wohnen der die gesuchten Buchstaben/Zeichen **beinhaltet**. Hierbei ist spielt die Klein/Groß-Schreibung keine Rolle, da die Abfrage in der Datenbank sowohl die Werte-Spalte als auch den eigentlichen Filter-Wert zu Kleinschreibung umwandelt (lower(...)). Der gesuchte Wert wird über URL-Parameter übergeben. |
|
155 |
+ |
|
156 |
+Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=teHaUs{{/code}} |