Zusammenfassung

• Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)
• Anhänge (0 geändert, 13 hinzugefügt, 0 gelöscht)
  • data_db_query_designer_de.png
  • data_db_query_designer_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

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-XWiki.nlo
	1	+XWiki.gru

Inhalt

...	...	@@ -9,24 +9,31 @@
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) Maske zum Testen der Datenbank-Abfrage.{{/figure}}
	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}}
13	13
	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	+
14	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		-* Vergeben Sie einen beliebigen eindeutigen Namen und eine optionale Beschreibung.
16		-* Für die Datenbank-Abfrage selbst, werden folgende Daten benötigt:
17		-** **Name**: Name der Datenbank-Abfrage
	21	+* Für die Datenbank-Abfrage werden folgende Daten benötigt:
	22	+** **Name**: Ein eindeutiger Name der Datenbank-Abfrage
18	18	** **Beschreibung**: Eine optionale Beschreibung der Datenbank-Abfrage
19	19	** **Verbindung**: Die [[DB-Verbindung>>doc:DBConnections]], die verwendet werden soll
20	20
21	21	* Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]).
22	22
23		-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}}.
	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}}.
24	24
	30	+{{version major="6" minor="4" patch="0"/}} In den SQL-Statements können [[Platzhalter>>doc:Formcycle.UserInterface.Variables.WebHome]] verwendet werden.
	31	+
25	25	== Verwenden der Abfrage ==
26	26
27	27	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:
28	28
29		-{{code}}
	36	+{{code language="none"}}
30	30	http://<server>/formcycle/datenabfragedb
31	31	{{/code}}
32	32
...	...	@@ -36,25 +36,54 @@
36	36	{{table dataTypeAlpha="0" preSort="0-asc"}}
37	37	|=Parametername|=Beschreibung|=Erforderlich
38	38	|name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
39		-|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
	46	+|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenbank-Abfrage erstellt wurde.|Ja, wenn //projektId// nicht gegeben
40	40	|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
41		-|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|
42		-|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	+|--sqlParameter--|Synonym für //queryParameter//. Sollte in {{formcycle/}} Version 6 nicht mehr verwendet werden und wird voraussichtlich in der nächsten Major-Version entfernt.|Nein
	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
43	43	|varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein
44		-|delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein
45	45	{{/table}}
46	46
47		-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}}.
	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}}.
48	48
49		-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.
	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.
50	50
51	51	Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
52	52
	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	+
53	53	== Sonderfall Auswahlelement ==
54	54
55	55	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"/}}.
56	56
57		-{{figure image="http://help4.formcycle.de/xwiki/bin/download/Main/Quellen/datenquelle_csv_2.png" width="300"/}}
	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}}
58	58
59	59	Der Inhalt der SQL-Datenbankabfrage wird in einem [[Auswahlelement>>doc:Formcycle.FormDesigner.FormElements.Selection]] in folgender Reihenfolge verwendet.
60	60
...	...	@@ -72,17 +72,25 @@
72	72	$('[name=sel2]').find('option:selected').attr('col2') // Selektiert die Aktive Option des Auswahlelements mit Name 'sel2' und liefert den ersten optionalen Wert zurück.
73	73	{{/code}}
74	74
75		-
76	76	== Beipiele ==
77	77
	113	+{{info}}
	114	+{{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.{{/info}}
	115	+
	116	+
78	78	{{code language="sql"}}
79	79	select name, vorname from tabelle where vorname like(?)
80	80	{{/code}}
81	81
82		-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	+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.
83	83
84		-Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
	123	+Abfrage per Servlet:
	124	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Mustermann{{/code}}
85	85
	126	+{{version major="6" minor="6" patch="3"/}}Ab {{formcycle/}} Version 6.6.3 mögliche Abfrage per Servlet:
	127	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=Mustermann{{/code}}
	128	+
	129	+
86	86
87	87	{{code language="sql"}}
88	88	select name, vorname from tabelle where id=?
...	...	@@ -90,8 +90,13 @@
90	90
91	91	Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
92	92
93		-Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
	137	+Abfrage per Servlet:
	138	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=100{{/code}}
94	94
	140	+{{version major="6" minor="6" patch="3"/}}Ab {{formcycle/}} Version 6.6.3 mögliche Abfrage per Servlet:
	141	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=100{{/code}}
	142	+
	143	+
95	95
96	96	{{code language="sql"}}
97	97	select name, vorname from tabelle where ort like(?) AND plz = ?
...	...	@@ -99,4 +99,36 @@
99	99
100	100	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.
101	101
102		-Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}
	151	+Abfrage per Servlet:
	152	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhausen,02442{{/code}}
	153	+
	154	+{{version major="6" minor="6" patch="3"/}}Ab {{formcycle/}} Version 6.6.3 mögliche Abfrage per Servlet:
	155	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=Entenhausen&queryParameterValues=02442{{/code}}
	156	+
	157	+
	158	+
	159	+{{code language="sql"}}
	160	+select name, vorname from tabelle where ort like concat(?, '%')
	161	+{{/code}}
	162	+
	163	+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.
	164	+
	165	+Abfrage per Servlet:
	166	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhau{{/code}}
	167	+
	168	+{{version major="6" minor="6" patch="3"/}}Ab {{formcycle/}} Version 6.6.3 mögliche Abfrage per Servlet:
	169	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=Entenhau{{/code}}
	170	+
	171	+
	172	+
	173	+{{code language="sql"}}
	174	+select name, vorname from tabelle where lower(ort) like concat('%', lower(?), '%')
	175	+{{/code}}
	176	+
	177	+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.
	178	+
	179	+Abfrage per Servlet:
	180	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=teHaUs{{/code}}
	181	+
	182	+{{version major="6" minor="6" patch="3"/}}Ab {{formcycle/}} Version 6.6.3 mögliche Abfrage per Servlet:
	183	+{{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameterValues=teHaUs{{/code}}

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_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