Änderungen von Dokument DB-Abfragen

Von Version < 3.1 >
bearbeitet von gru
am 14.03.2019, 16:51
Auf Version < 70.3 >
bearbeitet von gru
am 14.10.2020, 13:02
< >
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -3,53 +3,96 @@
3 3  Datenbankabfragen verhalten sich ähnlich wie [[Datenquellen>>doc:Sources]] (XML, CSV, JSON), werden jedoch nicht statisch hinterlegt, sondern dynamisch aus einer Datenbank ausgelesen.
4 4  
5 5  {{info}}
6 -Bei der Erstellung einer Abfrage wird eine bereits angelegte [[Verbindung>>doc:Verbindung]] zu einer Datenbank benötigt.
6 +Bei der Erstellung einer Abfrage wird eine bereits angelegte [[Verbindung>>doc:DBConnections]] zu einer Datenbank benötigt.
7 7  {{/info}}
8 8  
9 9  == Anlegen einer SQL-Abfrage ==
10 10  
11 -{{figure image="db-abfrage.jpg" width="300"}}
12 -Anlegen einer SQL-Abfrage in {{formcycle case="dat"/}}
13 -{{/figure}}
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) Konsole zum Testen der Datenbank-Abfrage.{{/figure}}
14 14  
15 -* Vergeben Sie einen eindeutigen Namen.
16 -* Wählen Sie die Verbindung zur Datenbank
17 -* Im Feld //Abfrage// geben Sie die SQL-Abfrage ein.
18 18  
19 -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}}
20 20  
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 +
21 21  == Verwenden der Abfrage ==
22 22  
23 23  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:
24 24  
25 -{{code}}
36 +{{code language="none"}}
26 26  http://<server>/formcycle/datenabfragedb
27 27  {{/code}}
28 28  
40 +Die Servlet-URL wird unterhalb der Einstellungen angezeigt (siehe [[Abbildung>>||anchor="data_db_query"]]).
29 29  Folgende URL-Parameter sind hierbei möglich:
30 30  
43 +{{table dataTypeAlpha="0" preSort="0-asc"}}
31 31  |=Parametername|=Beschreibung|=Erforderlich
32 32  |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
33 -|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
34 34  |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
35 -|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|\\
36 -|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
37 37  |varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein
38 -|delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein
57 +{{/table}}
39 39  
40 -Bei Zugriff aus einem Formular verwenden Sie bitte immer das globale Variablen-Objekt //XFC_METADATA//, siehe hierzu auch [[Globale Designer Variablen>>doc:Main.Formular-Metadaten]]. 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}}.
59 +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}}.
41 41  
42 -Ferner empfehlen wir, innerhalb des Formulars die Skriptfunktion [[getDataQuery>>doc:Zusaetzliche_Script-Funktionen.jQuery\.xutil\.getDataQuery()]] zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart.
61 +Ferner empfehlen wir, innerhalb des Formulars die JavaScript-Funktion {{jsdoc page="xutil" name="getdataquery"/}} zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart.
43 43  
44 44  Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
45 45  
65 +== Testen der Abfrage ==
66 +
67 +{{info}}
68 +Zum schnellen Testen der Abfrage steht die Tastenkombination {{code language="none"}}Strg + Enter{{/code}} zur Verfügung.
69 +{{/info}}
70 +
71 +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"]]).
72 +Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage:
73 +
74 +* {{ficon name="database-search"/}}**Abfrage ausführen**
75 +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"/}}
76 +* {{icon name="question"/}}**Abfrageparameter**
77 +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.
78 + {{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}}
79 +Eigentliche Abfrage im SQL-Editor:{{lightbox image="data_db_query_example_de.png" title="Beispielabfrage"/}}
80 +* {{ficon name="table-large"/}}**Tabellenansicht**
81 +Abfrageergebnis in Tabellenform{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}}
82 +* {{icon name="code"/}}**Quellcodeansicht**
83 +Abfrageergebnis im JSON-Format{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}}
84 +* {{icon name="Terminal"/}}**Generiertes SQL**
85 +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"/}}
86 +
46 46  == Sonderfall Auswahlelement ==
47 47  
48 -Soll das Ergebnis einer Datenbankabfrage direkt in ein [[Auswahlelement>>doc:Main.Auswahl]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}.
89 +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"/}}.
49 49  
50 -{{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}}
91 +{{figure image="data_db_query_designer_de.png"}}
92 +Verwenden des Ergebnises einer Datenbankabfrage als Datenquelle für ein Auswahlelement im {{designer case="dat"/}}.
93 +{{/figure}}
51 51  
52 -Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Main.Auswahl]] in folgender Reihenfolge verwendet.
95 +Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
53 53  
54 54  {{box}}
55 55  Sichtbarer Wert, Übertragener Wert, Optionaler Wert 1, Optionaler Wert 2, ...
... ... @@ -65,25 +65,48 @@
65 65  $('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück.
66 66  {{/code}}
67 67  
68 -
69 69  == Beipiele ==
70 70  
71 71  {{code language="sql"}}
72 -Statement: select name, vorname from tabelle where vorname like(?)
114 +select name, vorname from tabelle where vorname like(?)
73 73  {{/code}}
74 74  
75 -Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
117 +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.
76 76  
119 +Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Mustermann{{/code}}
77 77  
121 +
78 78  {{code language="sql"}}
79 -Statement: select name, vorname from tabelle where id=?
123 +select name, vorname from tabelle where id=?
80 80  {{/code}}
81 81  
82 -Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
126 +Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
83 83  
128 +Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=100{{/code}}
84 84  
130 +
85 85  {{code language="sql"}}
86 -Statement: select name, vorname from tabelle where ort like(?) AND plz = ?
132 +select name, vorname from tabelle where ort like(?) AND plz = ?
87 87  {{/code}}
88 88  
89 -Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}
135 +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.
136 +
137 +Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhausen,02442{{/code}}
138 +
139 +
140 +{{code language="sql"}}
141 +select name, vorname from tabelle where ort like concat(?, '%')
142 +{{/code}}
143 +
144 +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.
145 +
146 +Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhau{{/code}}
147 +
148 +
149 +{{code language="sql"}}
150 +select name, vorname from tabelle where lower(ort) like concat('%', lower(?), '%')
151 +{{/code}}
152 +
153 +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.
154 +
155 +Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=teHaUs{{/code}}
data_db_query_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +50.7 KB
Inhalt
data_db_query_designer_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +20.7 KB
Inhalt
data_db_query_designer_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +21.4 KB
Inhalt
data_db_query_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +49.2 KB
Inhalt
data_db_query_example_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +1.5 KB
Inhalt
data_db_query_test_code_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +10.1 KB
Inhalt
data_db_query_test_code_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +9.7 KB
Inhalt
data_db_query_test_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +4.7 KB
Inhalt
data_db_query_test_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +4.5 KB
Inhalt
data_db_query_test_param_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +6.9 KB
Inhalt
data_db_query_test_param_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +6.9 KB
Inhalt
data_db_query_test_sql_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +4.8 KB
Inhalt
data_db_query_test_sql_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +4.7 KB
Inhalt
data_db_query_test_table_de.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +7.7 KB
Inhalt
data_db_query_test_table_en.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.nlo
Größe
... ... @@ -1,0 +1,1 @@
1 +7.3 KB
Inhalt

Navigation

Copyright 2000-2024