Änderungen von Dokument DB-Abfragen

Von Version < 70.1 >

bearbeitet von gru
am 14.10.2020, 13:00

Auf Version < 65.1 >

bearbeitet von nlo
am 09.05.2019, 11:48

< >

Änderungskommentar: Upload new image "data_db_query_designer_en.png", version 1.1

Rohform
Im Layout

Zusammenfassung

Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

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

Inhalt

@@ -11,12
          +11,6 @@
  {{id name="data_db_query"/}}
  {{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}}
--
--{{html wiki="true"}}
--<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>
--{{/html}}
--
--
  * Ö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"]]).
  * Für die Datenbank-Abfrage werden folgende Daten benötigt:
  ** **Name**: Ein eindeutiger Name der Datenbank-Abfrage
@@ -25,15
          +25,13 @@
  * Die eigentliche **SQL-Abfrage** wird im Editor in der Mitte einegeben (siehe [[Abbildung>>||anchor="data_db_query"]]).
--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}}.
++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}}.
--{{version major="6" minor="4" patch="0"/}} In den SQL-Statements können [[Platzhalter>>doc:Formcycle.UserInterface.Variables.WebHome]] verwendet werden.
--
  == Verwenden der Abfrage ==
  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:
--{{code language="none"}}
++{{code}}
  http://<server>/formcycle/datenabfragedb
  {{/code}}
@@ -43,23
          +43,17 @@
  {{table dataTypeAlpha="0" preSort="0-asc"}}
  |=Parametername|=Beschreibung|=Erforderlich
  |name|Muss dem Namen der Datenbank-Abfrage entsprechen.|Ja
--|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenbank-Abfrage erstellt wurde.|Ja, wenn //projektId// nicht gegeben
++|mandantName|Muss dem Namen des Mandanten entsprechen, unter welchen diese Datenquelle erstellt wurde.|Ja, wenn //projektId// nicht gegeben
  |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
--|sqlParameter|Synonym für //queryParameter//. Sollte in {{formcycle/}} Version 6 nicht mehr verwendet werden und wird voraussichtlich in der nächsten Major-Versionen entfernt.|
--|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.
--
--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
--|delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code language="none"}},{{/code}}.
--
--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
--|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
--
++|sqlParameter|Synonym für //queryParameter//. Sollte nicht mehr verwendet werden ab Version 6 und wird es in späteren Versionen nicht mehr geben.|
++|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
  |varName|Gibt den Namen des JSON-Response-Objektes an. Ist dieser nicht gesetzt, so besitzt das JSON-Objekt keinen expliziten Namen.|Nein
++|delimiter|Trennzeichen, welches die einzelnen Werte des //queryParameter// trennt. Standardmäßig ein Komma {{code}},{{/code}}.|Nein
  {{/table}}
--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}}.
++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}}.
--Ferner empfehlen wir, innerhalb des Formulars die JavaScript-Funktion {{jsdoc page="xutil" name="getdataquery"/}} zu verwenden, die das manuelle Aufbauen der Servlet-Abfrage erspart.
++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.
  Die Rückgabe des Abfrage-Ergebnisses erfolgt im //JSON//-Format und kann somit innerhalb des Formulars direkt genutzt werden.
@@ -66,24
          +66,29 @@
  == Testen der Abfrage ==
  {{info}}
--Zum schnellen Testen der Abfrage steht die Tastenkombination {{code language="none"}}Strg + Enter{{/code}} zur Verfügung.
++Zum schnellen Testen der Abfrage steht die Tastenkombination {{code}}Strg + Enter{{/code}} zur Verfügung.
  {{/info}}
--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"]]).
++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"]]).
  Im Header der Testkonsole befindet sich eine Reihe von Buttons zur Steuerung der Abfrage:
  * {{ficon name="database-search"/}}**Abfrage ausführen**
--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"/}}
++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"/}}
  * {{icon name="question"/}}**Abfrageparameter**
--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.
-- {{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}}
--Eigentliche Abfrage im SQL-Editor:{{lightbox image="data_db_query_example_de.png" title="Beispielabfrage"/}}
++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.
++{{lightbox image="data_db_query_test_param_de.png" title="Die Paramter der Abfrage werden nummeriert."/}}
++Eigentliche Abfrage im SQL-Editor:
++{{lightbox image="data_db_query_example_de.png" title="Beispielabfrage"/}}
  * {{ficon name="table-large"/}}**Tabellenansicht**
--Abfrageergebnis in Tabellenform{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}}
++Abfrageergebnis in Tabellenform
++{{lightbox image="data_db_query_test_table_de.png" title="Abfrageergebnis in Tabellenform"/}}
  * {{icon name="code"/}}**Quellcodeansicht**
--Abfrageergebnis im JSON-Format{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}}
++Abfrageergebnis im JSON-Format
++{{lightbox image="data_db_query_test_code_de.png" title="Abfrageergebnis im JSON-Format"/}}
  * {{icon name="Terminal"/}}**Generiertes SQL**
--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"/}}
++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"/}}
  == Sonderfall Auswahlelement ==
@@ -117,7
          +117,7 @@
  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.
--Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Mustermann{{/code}}
++Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Mustermann{{/code}}
  {{code language="sql"}}
@@ -126,7
          +126,7 @@
  Diese SQL-Abfrage liefert die Person mit einer bestimmten ID zurück. Die ID wird als URL-Parameter übergeben.
--Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=100{{/code}}
++Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=100{{/code}}
  {{code language="sql"}}
@@ -135,22
          +135,4 @@
  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.
--Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhausen,02442{{/code}}
--
--
--{{code language="sql"}}
--select name, vorname from tabelle where ort like concat(?, '%')
--{{/code}}
--
--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.
--
--Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=Entenhau{{/code}}
--
--
--{{code language="sql"}}
--select name, vorname from tabelle where lower(ort) like concat('%', lower(?), '%')
--{{/code}}
--
--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.
--
--Abfrage per Servlet: {{code language="none"}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&queryParameter=teHaUs{{/code}}
++Abfrage per Servlet: {{code}}http://meinserver/formcycle/datenquelledb?mandantName=ich&name=demo&sqlParameter=Entenhausen,02442{{/code}}

Änderungen von Dokument DB-Abfragen

Zusammenfassung

Details

Navigation