Wiki-Quellcode von DB-Abfragen

Verstecke letzte Bearbeiter
gru 1.1 1 {{content/}}
2
gru 4.1 3 Datenbankabfragen verhalten sich ähnlich wie [[Datenquellen>>doc:Sources]] (XML, CSV, JSON), werden jedoch nicht statisch hinterlegt, sondern dynamisch aus einer Datenbank ausgelesen.
gru 1.1 4
5 {{info}}
awa 4.2 6 Bei der Erstellung einer Abfrage wird eine bereits angelegte [[Verbindung>>doc:DBConnections]] zu einer Datenbank benötigt.
gru 1.1 7 {{/info}}
8
9 == Anlegen einer SQL-Abfrage ==
10
nlo 9.1 11 {{id name="data_db_query"/}}
nlo 32.1 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}}
gru 1.1 13
nlo 16.1 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"]]).
nlo 19.1 15 * Für die Datenbank-Abfrage werden folgende Daten benötigt:
16 ** **Name**: Ein eindeutiger Name der Datenbank-Abfrage
nlo 16.1 17 ** **Beschreibung**: Eine optionale Beschreibung der Datenbank-Abfrage
nlo 17.1 18 ** **Verbindung**: Die [[DB-Verbindung>>doc:DBConnections]], die verwendet werden soll
nlo 16.1 19
nlo 18.1 20 * Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]).
gru 1.1 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
nlo 12.1 32 Die Servlet-URL wird unterhalb der Einstellungen angezeigt (siehe [[Abbildung>>||anchor="data_db_query"]]).
gru 1.1 33 Folgende URL-Parameter sind hierbei möglich:
34
awa 4.2 35 {{table dataTypeAlpha="0" preSort="0-asc"}}
gru 1.1 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
awa 4.2 40 |sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|
gru 1.1 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
awa 4.2 44 {{/table}}
gru 1.1 45
awa 6.2 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}}.
gru 1.1 47
awa 5.1 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.
gru 1.1 49
50 Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
51
nlo 21.1 52 == Testen der Abfrage ==
53
nlo 30.1 54 {{id name="data_db_query_test"/}}
nlo 31.1 55 {{figure image="data_db_query_test_de.png"}}Konsole zum Testen der Datenbankabfrage. Im Header befindet sich eine Reihe von Buttons zur Steuerung der Abfrage.{{/figure}}
nlo 22.1 56
nlo 31.1 57 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_test"]]).
nlo 33.1 58 Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage:
nlo 34.1 59
nlo 33.1 60 * {{ficon name="database-search"/}}**Abfrage ausführen**
nlo 37.1 61 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.
nlo 33.1 62 * {{icon name="question"/}}**Abfrageparameter**
nlo 38.1 63 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.
nlo 40.1 64 {{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}}
nlo 34.1 65 * {{ficon name="table-large"/}}**Tabellenansicht**
66 Abfrageergebnis in Tabellenform
67 * {{icon name="code"/}}**Quellcodeansicht**
68 Abfrageergebnis im JSON-Format
nlo 30.1 69
gru 1.1 70 == Sonderfall Auswahlelement ==
71
awa 4.2 72 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"/}}.
gru 1.1 73
74 {{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}}
75
awa 4.2 76 Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
gru 1.1 77
78 {{box}}
79 Sichtbarer Wert, Übertragener Wert, Optionaler Wert 1, Optionaler Wert 2, ...
80 {{/box}}
81
82 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.
83
84 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.
85
86 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.
87
88 {{code language="javascript"}}
89 $('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück.
90 {{/code}}
91
92
93 == Beipiele ==
94
95 {{code language="sql"}}
awa 4.2 96 select name, vorname from tabelle where vorname like(?)
gru 1.1 97 {{/code}}
98
nlo 21.1 99 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.
awa 4.2 100
gru 1.1 101 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
102
103
104 {{code language="sql"}}
awa 4.2 105 select name, vorname from tabelle where id=?
gru 1.1 106 {{/code}}
107
awa 4.2 108 Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
109
gru 1.1 110 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
111
112
113 {{code language="sql"}}
awa 4.2 114 select name, vorname from tabelle where ort like(?) AND plz = ?
gru 1.1 115 {{/code}}
116
awa 4.2 117 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.
118
gru 1.1 119 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}

Navigation

Copyright 2000-2024