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
awa 67.4 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
19
nlo 16.1 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"]]).
nlo 19.1 21 * Für die Datenbank-Abfrage werden folgende Daten benötigt:
22 ** **Name**: Ein eindeutiger Name der Datenbank-Abfrage
nlo 16.1 23 ** **Beschreibung**: Eine optionale Beschreibung der Datenbank-Abfrage
nlo 17.1 24 ** **Verbindung**: Die [[DB-Verbindung>>doc:DBConnections]], die verwendet werden soll
nlo 16.1 25
nlo 18.1 26 * Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]).
gru 1.1 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}}?{{/code}}.
29
30 == Verwenden der Abfrage ==
31
32 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:
33
34 {{code}}
35 http://<server>/formcycle/datenabfragedb
36 {{/code}}
37
nlo 67.1 38 Die Servlet-URL wird unterhalb der Einstellungen angezeigt (siehe [[Abbildung>>||anchor="data_db_query"]]).
gru 1.1 39 Folgende URL-Parameter sind hierbei möglich:
40
awa 4.2 41 {{table dataTypeAlpha="0" preSort="0-asc"}}
gru 1.1 42 |=Parametername|=Beschreibung|=Erforderlich
43 |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
44 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
45 |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 46 |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 47 |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 |varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein
49 |delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein
awa 4.2 50 {{/table}}
gru 1.1 51
awa 6.2 52 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 53
awa 67.4 54 Ferner empfehlen wir, innerhalb des Formulars die JavaScript-Funktion {{jsdoc page="xutil" name="getdataquery"/}} zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart.
gru 1.1 55
56 Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
57
nlo 21.1 58 == Testen der Abfrage ==
59
nlo 52.1 60 {{info}}
nlo 53.1 61 Zum schnellen Testen der Abfrage steht die Tastenkombination {{code}}Strg + Enter{{/code}} zur Verfügung.
nlo 52.1 62 {{/info}}
63
nlo 67.3 64 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"]]).
nlo 33.1 65 Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage:
nlo 34.1 66
nlo 33.1 67 * {{ficon name="database-search"/}}**Abfrage ausführen**
awa 67.4 68 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.{{lightbox image="data_db_query_test_de.png" title="Abfrage ausführen"/}}
nlo 33.1 69 * {{icon name="question"/}}**Abfrageparameter**
nlo 38.1 70 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.
awa 67.4 71 {{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}}
72 Eigentliche Abfrage im SQL-Editor:{{lightbox image="data_db_query_example_de.png" title="Beispielabfrage"/}}
nlo 34.1 73 * {{ficon name="table-large"/}}**Tabellenansicht**
awa 67.4 74 Abfrageergebnis in Tabellenform{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}}
nlo 34.1 75 * {{icon name="code"/}}**Quellcodeansicht**
awa 67.4 76 Abfrageergebnis im JSON-Format{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}}
nlo 43.1 77 * {{icon name="Terminal"/}}**Generiertes SQL**
awa 67.4 78 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"/}}
nlo 30.1 79
gru 1.1 80 == Sonderfall Auswahlelement ==
81
awa 4.2 82 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 83
nlo 54.1 84 {{figure image="data_db_query_designer_de.png"}}
nlo 64.2 85 Verwenden des Ergebnises einer Datenbankabfrage als Datenquelle für ein Auswahlelement im {{designer case="dat"/}}.
nlo 54.1 86 {{/figure}}
gru 1.1 87
awa 4.2 88 Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
gru 1.1 89
90 {{box}}
91 Sichtbarer Wert, Übertragener Wert, Optionaler Wert 1, Optionaler Wert 2, ...
92 {{/box}}
93
94 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.
95
96 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.
97
98 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.
99
100 {{code language="javascript"}}
101 $('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück.
102 {{/code}}
103
104 == Beipiele ==
105
106 {{code language="sql"}}
awa 4.2 107 select name, vorname from tabelle where vorname like(?)
gru 1.1 108 {{/code}}
109
nlo 21.1 110 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 111
gru 68.2 112 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Mustermann{{/code}}
gru 1.1 113
114
115 {{code language="sql"}}
awa 4.2 116 select name, vorname from tabelle where id=?
gru 1.1 117 {{/code}}
118
awa 4.2 119 Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
120
gru 68.2 121 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=100{{/code}}
gru 1.1 122
123
124 {{code language="sql"}}
awa 4.2 125 select name, vorname from tabelle where ort like(?) AND plz = ?
gru 1.1 126 {{/code}}
127
awa 4.2 128 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.
129
gru 68.2 130 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhausen,02442{{/code}}
MKO 68.1 131
132
133 {{code language="sql"}}
134 select name, vorname from tabelle where ort like concat(?, '%')
135 {{/code}}
136
137 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.
138
gru 68.2 139 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhau{{/code}}
MKO 68.1 140
141
142 {{code language="sql"}}
143 select name, vorname from tabelle where lower(ort) like concat('%', lower(?), '%')
144 {{/code}}
145
146 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.
147
gru 68.2 148 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=teHaUs{{/code}}

Navigation

Copyright 2000-2024