Änderungen von Dokument DB-Abfragen
Änderungskommentar:
Es gibt keinen Kommentar für diese Version
Zusammenfassung
-
Seiteneigenschaften (4 geändert, 0 hinzugefügt, 0 gelöscht)
-
Anhänge (0 geändert, 15 hinzugefügt, 0 gelöscht)
- data_db_query_de.png
- data_db_query_designer_de.png
- data_db_query_designer_en.png
- data_db_query_en.png
- data_db_query_example_de.png
- data_db_query_test_code_de.png
- data_db_query_test_code_en.png
- data_db_query_test_de.png
- data_db_query_test_en.png
- data_db_query_test_param_de.png
- data_db_query_test_param_en.png
- data_db_query_test_sql_de.png
- data_db_query_test_sql_en.png
- data_db_query_test_table_de.png
- data_db_query_test_table_en.png
Details
- Seiteneigenschaften
-
- Titel
-
... ... @@ -1,1 +1,1 @@ 1 - $services.localization.render("PT.Main.Abfragen")1 +DB-Abfragen - Übergeordnete Seite
-
... ... @@ -1,1 +1,1 @@ 1 - Main.Daten1 +WebHome - Dokument-Autor
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. gru1 +XWiki.awa - Inhalt
-
... ... @@ -1,21 +1,30 @@ 1 1 {{content/}} 2 2 3 -Datenbankabfragen verhalten sich ähnlich wie [[Datenquellen>>doc: Quellen]] (XML, CSV, JSON), werden jedoch nicht statisch hinterlegt, sondern dynamisch aus einer Datenbank ausgelesen.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 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 + 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 + 19 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}}. 20 20 21 21 == Verwenden der Abfrage == ... ... @@ -26,30 +26,57 @@ 26 26 http://<server>/formcycle/datenabfragedb 27 27 {{/code}} 28 28 38 +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 41 +{{table dataTypeAlpha="0" preSort="0-asc"}} 31 31 |=Parametername|=Beschreibung|=Erforderlich 32 32 |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja 33 33 |mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle 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.| \\46 +|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.| 36 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 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 38 |delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein 50 +{{/table}} 39 39 40 -Bei Zugriff aus einem Formular verwenden Sie bitte immer das globale Variablen -Objekt //XFC_METADATA//, siehe hierzu auch [[GlobaleVariablen>>doc: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}}.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}}. 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.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. 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 58 +== Testen der Abfrage == 59 + 60 +{{info}} 61 +Zum schnellen Testen der Abfrage steht die Tastenkombination {{code}}Strg + Enter{{/code}} zur Verfügung. 62 +{{/info}} 63 + 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"]]). 65 +Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage: 66 + 67 +* {{ficon name="database-search"/}}**Abfrage ausführen** 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"/}} 69 +* {{icon name="question"/}}**Abfrageparameter** 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. 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"/}} 73 +* {{ficon name="table-large"/}}**Tabellenansicht** 74 +Abfrageergebnis in Tabellenform{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}} 75 +* {{icon name="code"/}}**Quellcodeansicht** 76 +Abfrageergebnis im JSON-Format{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}} 77 +* {{icon name="Terminal"/}}**Generiertes SQL** 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"/}} 79 + 46 46 == Sonderfall Auswahlelement == 47 47 48 -Soll das Ergebnis einer Datenbankabfrage direkt in ein [[Auswahlelement>>doc: Auswahl]] geladen werden, erfolgt dies über die Eigenschaften des Auswahlelements im {{designer case="dat"/}}.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"/}}. 49 49 50 -{{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}} 84 +{{figure image="data_db_query_designer_de.png"}} 85 +Verwenden des Ergebnises einer Datenbankabfrage als Datenquelle für ein Auswahlelement im {{designer case="dat"/}}. 86 +{{/figure}} 51 51 52 -Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc: Auswahl]] in folgender Reihenfolge verwendet.88 +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,30 @@ 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(?)107 +select name, vorname from tabelle where vorname like(?) 73 73 {{/code}} 74 74 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. 111 + 75 75 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}} 76 76 77 77 78 78 {{code language="sql"}} 79 - Statement:select name, vorname from tabelle where id=?116 +select name, vorname from tabelle where id=? 80 80 {{/code}} 81 81 119 +Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben. 120 + 82 82 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}} 83 83 84 84 85 85 {{code language="sql"}} 86 - Statement:select name, vorname from tabelle where ort like(?) AND plz = ?125 +select name, vorname from tabelle where ort like(?) AND plz = ? 87 87 {{/code}} 88 88 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 + 89 89 Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/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