Von Version < 57.1 >
bearbeitet von nlo
am 09.05.2019, 11:43
Auf Version < 3.2 >
bearbeitet von gru
am 25.03.2019, 11:57
< >
Änderungskommentar: Updated the relative links.

Zusammenfassung

Details

Seiteneigenschaften
Dokument-Autor
... ... @@ -1,1 +1,1 @@
1 -XWiki.nlo
1 +XWiki.gru
Inhalt
... ... @@ -1,24 +1,21 @@
1 1  {{content/}}
2 2  
3 -Datenbankabfragen verhalten sich ähnlich wie [[Datenquellen>>doc:Sources]] (XML, CSV, JSON), werden jedoch nicht statisch hinterlegt, sondern dynamisch aus einer Datenbank ausgelesen.
3 +Datenbankabfragen verhalten sich ähnlich wie [[Datenquellen>>doc:Main.UserInterface.Data.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:DBConnections]] zu einer Datenbank benötigt.
6 +Bei der Erstellung einer Abfrage wird eine bereits angelegte [[Verbindung>>doc:Verbindung]] zu einer Datenbank benötigt.
7 7  {{/info}}
8 8  
9 9  == Anlegen einer SQL-Abfrage ==
10 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) Konsole zum Testen der Datenbank-Abfrage.{{/figure}}
11 +{{figure image="db-abfrage.jpg" width="300"}}
12 +Anlegen einer SQL-Abfrage in {{formcycle case="dat"/}}
13 +{{/figure}}
13 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
15 +* Vergeben Sie einen eindeutigen Namen.
16 +* Wählen Sie die Verbindung zur Datenbank
17 +* Im Feld //Abfrage// geben Sie die SQL-Abfrage ein.
19 19  
20 -* Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]).
21 -
22 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 23  
24 24  == Verwenden der Abfrage ==
... ... @@ -29,62 +29,30 @@
29 29  http://<server>/formcycle/datenabfragedb
30 30  {{/code}}
31 31  
32 -Die Servlet-URL wird unterhalb der Einstellungen angezeigt (siehe [[Abbildung>>||anchor="data_db_query"]]).
33 33  Folgende URL-Parameter sind hierbei möglich:
34 34  
35 -{{table dataTypeAlpha="0" preSort="0-asc"}}
36 36  |=Parametername|=Beschreibung|=Erforderlich
37 37  |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
38 38  |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
39 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.|
35 +|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|\\
41 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 42  |varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein
43 43  |delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein
44 -{{/table}}
45 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}}.
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}}.
47 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.
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.
49 49  
50 50  Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
51 51  
52 -== Testen der Abfrage ==
53 -
54 -{{info}}
55 -Zum schnellen Testen der Abfrage steht die Tastenkombination {{code}}Strg + Enter{{/code}} zur Verfügung.
56 -{{/info}}
57 -
58 -Datenbank-Abfragen können direkt in der Konfigurationsoberfläche getestet werden. Hierzu steht eine Testkonsole unterhalb des SQL-Editor zur Verfügung (siehe [[Abbildung>>||anchor="fig_data_db_query"]]).
59 -Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage:
60 -
61 -* {{ficon name="database-search"/}}**Abfrage ausführen**
62 -Führt die Datenbank-Abfrage aus. Werden //Abfrageparameter// ({{code}}?{{/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.
63 -{{lightbox image="data_db_query_test_de.png" title="Abfrage ausführen"/}}
64 -* {{icon name="question"/}}**Abfrageparameter**
65 -Maske zum Eingeben von Werten für Abfrageparameter. Diese Option steht nur zur Verfügung, wenn Abfrageparameter ({{code}}?{{/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.
66 -Eigentliche Abfrage im SQL-Editor:
67 -{{lightbox image="data_db_query_example_de.png" title="Beispielabfrage"/}}
68 -{{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}}
69 -* {{ficon name="table-large"/}}**Tabellenansicht**
70 -Abfrageergebnis in Tabellenform
71 -{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}}
72 -* {{icon name="code"/}}**Quellcodeansicht**
73 -Abfrageergebnis im JSON-Format
74 -{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}}
75 -* {{icon name="Terminal"/}}**Generiertes SQL**
76 -Zeigt das generierte SQL-Statement mit eingefügten Parameterwerten
77 -{{lightbox image="data_db_query_test_sql_de.png" title="Zeigt den generierten SQL-Query mit eingefügten Parameterwerten"/}}
78 -
79 79  == Sonderfall Auswahlelement ==
80 80  
81 -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"/}}.
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"/}}.
82 82  
83 -{{figure image="data_db_query_designer_de.png"}}
84 -Verwenden des Ergebnises einer Datenbankabfrage als Auswahlelement im {{designer case="dat"/}}.
85 -{{/figure}}
50 +{{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}}
86 86  
87 -Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
52 +Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Main.Auswahl]] in folgender Reihenfolge verwendet.
88 88  
89 89  {{box}}
90 90  Sichtbarer Wert, Übertragener Wert, Optionaler Wert 1, Optionaler Wert 2, ...
... ... @@ -100,30 +100,25 @@
100 100  $('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück.
101 101  {{/code}}
102 102  
68 +
103 103  == Beipiele ==
104 104  
105 105  {{code language="sql"}}
106 -select name, vorname from tabelle where vorname like(?)
72 +Statement: select name, vorname from tabelle where vorname like(?)
107 107  {{/code}}
108 108  
109 -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.
110 -
111 111  Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
112 112  
113 113  
114 114  {{code language="sql"}}
115 -select name, vorname from tabelle where id=?
79 +Statement: select name, vorname from tabelle where id=?
116 116  {{/code}}
117 117  
118 -Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
119 -
120 120  Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
121 121  
122 122  
123 123  {{code language="sql"}}
124 -select name, vorname from tabelle where ort like(?) AND plz = ?
86 +Statement: select name, vorname from tabelle where ort like(?) AND plz = ?
125 125  {{/code}}
126 126  
127 -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.
128 -
129 129  Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}
data_db_query_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -50.7 KB
Inhalt
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_en.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -49.2 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_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_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_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_table_de.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.nlo
Größe
... ... @@ -1,1 +1,0 @@
1 -7.7 KB
Inhalt
Copyright 2000-2024