Von Version < 70.9 >
bearbeitet von gru
am 14.10.2020, 13:24
Auf Version < 11.2 >
bearbeitet von nlo
am 08.05.2019, 17:03
< >
Änderungskommentar: Es gibt keinen Kommentar für diese Version

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.gru
1 +XWiki.nlo
Inhalt
... ... @@ -9,88 +9,47 @@
9 9  == Anlegen einer SQL-Abfrage ==
10 10  
11 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}}
12 +{{figure image="data_db_query_de.png"}}Anlegen einer SQL-Abfrage in {{formcycle case="dat"/}}{{/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"]]).
14 14  
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}}
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}}.
18 18  
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 -
32 32  == Verwenden der Abfrage ==
33 33  
34 34  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:
35 35  
36 -{{code language="none"}}
24 +{{code}}
37 37  http://<server>/formcycle/datenabfragedb
38 38  {{/code}}
39 39  
40 -Die Servlet-URL wird unterhalb der Einstellungen angezeigt (siehe [[Abbildung>>||anchor="data_db_query"]]).
28 +Die Servlet-URL kann unterhalb der Einstellungen entnommen werden (siehe [[Abbildung>>||anchor="data_db_query"]]).
41 41  Folgende URL-Parameter sind hierbei möglich:
42 42  
43 43  {{table dataTypeAlpha="0" preSort="0-asc"}}
44 44  |=Parametername|=Beschreibung|=Erforderlich
45 45  |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
46 -|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenbank-Abfrage erstellt wurde.|Ja, wenn //projektId// nicht gegeben
34 +|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
47 47  |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
48 -|--sqlParameter--|Synonym für //queryParameter//. Sollte in {{formcycle/}} Version 6 nicht mehr verwendet werden und wird voraussichtlich in der nächsten Major-Version 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
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
56 56  |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
57 57  {{/table}}
58 58  
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}}.
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 60  
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.
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 62  
63 63  Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
64 64  
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 -
87 87  == Sonderfall Auswahlelement ==
88 88  
89 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"/}}.
90 90  
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}}
52 +{{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}}
94 94  
95 95  Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
96 96  
... ... @@ -108,22 +108,18 @@
108 108  $('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück.
109 109  {{/code}}
110 110  
70 +
111 111  == Beipiele ==
112 112  
113 -{{version major="6" minor="6" patch="3"/}}Ab {{formcycle/}} Version 6.6.3 kann Anstelle des Parameters //queryParameter// der Parameter //queryParameterValues// verwendet werden. Letzterer wird für neue Projekte empfohlen, da der Parameter //queryParameter// in einer zukünftigen Version von {{formcycle/}} nicht mehr unterstützt werden wird. In den folgenden Beispielen wird für jede SQL-Abfrage daher jeweils eine Servlet-Abfrage mit //queryParameter// und mit //queryParameterValues// gezeigt.
114 -
115 -
116 116  {{code language="sql"}}
117 117  select name, vorname from tabelle where vorname like(?)
118 118  {{/code}}
119 119  
120 -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.
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.
121 121  
122 -Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Mustermann{{/code}}
123 -{{version major="6" minor="6" patch="3"/}}Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=Mustermann{{/code}}
124 -
125 -
79 +Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
126 126  
81 +
127 127  {{code language="sql"}}
128 128  select name, vorname from tabelle where id=?
129 129  {{/code}}
... ... @@ -130,11 +130,9 @@
130 130  
131 131  Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
132 132  
133 -Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=100{{/code}}
134 -{{version major="6" minor="6" patch="3"/}}Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=100{{/code}}
135 -
136 -
88 +Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
137 137  
90 +
138 138  {{code language="sql"}}
139 139  select name, vorname from tabelle where ort like(?) AND plz = ?
140 140  {{/code}}
... ... @@ -141,27 +141,4 @@
141 141  
142 142  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.
143 143  
144 -Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhausen,02442{{/code}}
145 -{{version major="6" minor="6" patch="3"/}}Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=Entenhausen&queryParameterValues=02442{{/code}}
146 -
147 -
148 -
149 -{{code language="sql"}}
150 -select name, vorname from tabelle where ort like concat(?, '%')
151 -{{/code}}
152 -
153 -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.
154 -
155 -Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhau{{/code}}
156 -{{version major="6" minor="6" patch="3"/}}Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=Entenhau{{/code}}
157 -
158 -
159 -
160 -{{code language="sql"}}
161 -select name, vorname from tabelle where lower(ort) like concat('%', lower(?), '%')
162 -{{/code}}
163 -
164 -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.
165 -
166 -Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=teHaUs{{/code}}
167 -{{version major="6" minor="6" patch="3"/}}Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=teHaUs{{/code}}
97 +Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}
data_db_query_designer_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -20.7 KB
Inhalt
data_db_query_designer_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -21.4 KB
Inhalt
data_db_query_example_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -1.5 KB
Inhalt
data_db_query_test_code_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -10.1 KB
Inhalt
data_db_query_test_code_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -9.7 KB
Inhalt
data_db_query_test_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -4.7 KB
Inhalt
data_db_query_test_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -4.5 KB
Inhalt
data_db_query_test_param_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -6.9 KB
Inhalt
data_db_query_test_param_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -6.9 KB
Inhalt
data_db_query_test_sql_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -4.8 KB
Inhalt
data_db_query_test_sql_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -4.7 KB
Inhalt
data_db_query_test_table_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -7.7 KB
Inhalt
data_db_query_test_table_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -7.3 KB
Inhalt
Copyright 2000-2024