Changes for page DB-Abfragen

From version < 6.2 >

edited by awa
on 11.04.2019, 16:44

To version < 19.1

edited by XIMA Admin
on 30.11.2020, 13:49

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

@@ -1,1
          +1,1 @@
--XWiki.awa
++XWiki.ximaadmin

Content

@@ -8,45
          +8,96 @@
  == Creating a database query ==
--{{figure image="001En.png" width="300"}}
--Creating a database query in {{formcycle/}}
--{{/figure}}
++{{id name="data_db_query"/}}
++{{figure image="data_db_query_de.png"}}Configuration screen for creating a database query in: (1) list of existing DB queries, (2) editor for defining the SQL query, (3) settings of the DB query, (4) console for testing the DB query.{{/figure}}
--* Enter a unique name.
--* Select a database connection
--* Enter the SQL statement to be executed for the query
++{{html wiki="true"}}
++<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Configuration screen for creating a database query in: (1) list of existing DB queries, (2) editor for defining the SQL query, (3) settings of the DB query, (4) console for testing the DB query.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='data_db_query_de.png' width='300' group='$height' group='$group' title='Configuration screen for creating a database query in: (1) list of existing DB queries, (2) editor for defining the SQL query, (3) settings of the DB query, (4) console for testing the DB query.'/}}<div class='xm-figure-caption'>Configuration screen for creating a database query in: (1) list of existing DB queries, (2) editor for defining the SQL query, (3) settings of the DB query, (4) console for testing the DB query.</div></div></div>
++{{/html}}
++
++
++
++{{html wiki="true"}}
++<div class='xm-figure xm-float-right xm-clear-h2' data-alt='Configuration screen for creating a database query in: (1) list of existing DB queries, (2) editor for defining the SQL query, (3) settings of the DB query, (4) console for testing the DB query.'><div class='xm-figure-inner' style='width:310px'>{{lightbox image='data_db_query_de.png' width='300' group='$height' group='$group' title='Configuration screen for creating a database query in: (1) list of existing DB queries, (2) editor for defining the SQL query, (3) settings of the DB query, (4) console for testing the DB query.'/}}<div class='xm-figure-caption'>Configuration screen for creating a database query in: (1) list of existing DB queries, (2) editor for defining the SQL query, (3) settings of the DB query, (4) console for testing the DB query.</div></div></div>
++{{/html}}
++
++
++* Open the module "Database queries" and click "New" {{ficon name="plus-circle-outline"/}} in the header of the list (see [[figure>>||anchor="fig_data_db_query"]]).
++* The following data is needed for a Database query:
++** **Name**: A unique name for the database query
++** **Description**: An optional description for the database query
++** **Connection**: The [[Database connection>>doc:DBConnections]] that should be used
++
++* Enter the **SQL statement** to be executed for the query in the editor (see [[figure>>||anchor="data_db_query"]]).
++
  The entered SQL statement is executed as a prepared statement, which prevents SQL injection attacks. You should not and need not use inverted commas (` or '). Also, you can use question marks ( ? ) as placeholders to build queries dynamically.
++{{version major="6" minor="4" patch="0"/}} [[Variables>>doc:Formcycle.UserInterface.Variables.WebHome]] can be used in the SQL statements.
++
  == Using the database query ==
  You can access the database query by making a HTTP request to the corresponding database servlet and providing the required parameters as GET parameters. The URL to the database query servlet is as follows.
--{{code}}
++{{code language="none"}}
  http://<server>/formcycle/datenabfragedb
  {{/code}}
--The following URL parameters are supported.
++The servlet URL is displayed beneath the settings (see [[figure>>||anchor="data_db_query"]]).
++The following URL parameters are supported:
++{{table dataTypeAlpha="0" preSort="0-asc"}}
  |=Name of the paramter|=Description|=Required
  |name|Must match the name of the database query.|Yes
  |clientName|Must match the name of the client used for creating this data source.|Yes, if //projektId// is not given
  |projektId|Must match the ID of the form. This information can be seen by accessing the {{code language="javascript"}}XFC_METADATA.currentProject.id{{/code}} object from JavaScript.|Yes, if //mandantName// is not given
--|sqlParameter|Alias for //queryParameter//. This is deprecated from version 6 and should not be used anymore. It may be removed in future releases.|
--|queryParameter|Yes, if placeholders ( ? ) are used in the query. Must be a comma separated list of parameters and match the number of parameters used in the SQL query (from version 6).|No
++|--sqlParameter--|Alias for //queryParameter//. Should no longer be used in {{formcycle/}} version 6 and will most likely be removed in the next major release of {{formcycle/}}.|No
++|queryParameter|When the query contains placeholders (question marks, {{code language="none"}}?{{/code}}), a list of parameters must be supplied for each placeholder. The number of items must match the number of parameters used in the SQL query. The items are separated with the delimiter as defined by the URL parameter //delimiter//.
++
++If possible the parameter //queryParameterValues// should be used for new projects instead of //queryParameter// because //queryParameter// will not be supported in a future version of {{formcycle/}}.|No
++|queryParameterValues|{{version major="6" minor="6" patch="3"/}}Starting with {{formcycle/}} Version 6.6.3 this parameter can be used as an alternative to the parameters //queryParameter// and //delimiter//. Like these parameters, //queryParameterValues// is only required if placeholders in the form of a question mark {{code language="none"}}?{{/code}} are used within the SQL query. If this is the case, the individual query parameters are passed one after the other as a separate parameter //queryParameterValues//, which also eliminates the use of the parameter //delimiter//.|No
  |varName|Allows you to change name of the JSON response object. If not given, a plain JSON object with the result data is returned.|No
--|delimiter|The delimiter for the placeholder values, see //queryParameter//. Defaults to a comma {{code}},{{/code}}|No
++|delimiter|The delimiter for the placeholder values, see //queryParameter//. Defaults to a comma {{code language="none"}},{{/code}}
++
++If possible the parameter //queryParameterValues// should be used for new projects instead of //delimiter// and //queryParameter// because //delimiter// will not be supported in a future version of {{formcycle/}}.|No
++{{/table}}
--When accessing a database servlet from a form, always use the database URL contained in the global object //XFC_METADATA//, see also the [[form-specific JavaScript objects>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.FormMetadata]]. For example: {{code language="javascript"}}XFC_METADATA.urls.datasource_db{{/code}}.
++When accessing a database servlet from a form, always use the database URL contained in the global object //XFC_METADATA//, see also the [[metadata>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.FormMetadata]]. For example: {{code language="javascript"}}XFC_METADATA.urls.datasource_db{{/code}}.
--Further we recommend you use the script function [[getDataQuery>>doc:Formcycle.FormDesigner.CodingPanel.ScriptTab.AdditionalScriptFunctions.GetDataQuery]], so you do not have to setup the servlet request manually. The result of the database query is returned as //JSON//.
++Further we recommend you use the script function {{jsdoc page="xutil" name="getdataquery"/}}, so you do not have to setup the servlet request manually. The result of the database query is returned as //JSON//.
++== Testing the query ==
++
++{{info}}
++For quick testing of the query the shortcut {{code language="none"}}Ctrl + Enter{{/code}} is provided.
++{{/info}}
++
++Database queries can be tested directly from the configuration UI. For this purpose a test console is provided below the SQL editor (see [[figure>>||anchor="fig_data_db_query"]]).
++In the header of the console there is a row of buttons for controling the query:
++
++* {{ficon name="database-search"/}}**Perform query**
++Runs the database query. If //query parameters// ({{code language="none"}}?{{/code}}) are provided the user will be prompted to input values vor those parameters. Otherwise the result of the query will be displayed directly in the //table view//.{{lightbox image="data_db_query_test_en.png" title="Run the given query"/}}
++* {{icon name="question"/}}**Query parameters**
++Mask for inputting values for query parameters. This option is only available if query parameters ({{code language="none"}}?{{/code}}) are used in the SQL query. The individual parameters will be enumerated in the SQL query. Clicking "User parameters for query" {{ficon name="arrow-right-bold-circle-outline2"/}} executes the query with the given parameters. The result will be displayed in the //table view//.
++ {{lightbox image="data_db_query_test_param_en.png" title="Query parameters are enumerated"/}}
++Actual Query in the SQL editor:{{lightbox image="data_db_query_example_de.png" title="Example query"/}}
++* {{ficon name="table-large"/}}**Table view**
++Query result in table view{{lightbox image="data_db_query_test_table_en.png" title="Query result in table view"/}}
++* {{icon name="code"/}}**Source code view**
++Query result in JSON format{{lightbox image="data_db_query_test_code_en.png" title="Query result in JSON format"/}}
++* {{icon name="Terminal"/}}**Generated SQL**
++Displays the generated SQL statement with input parameter values{{lightbox image="data_db_query_test_sql_en.png" title="Displays the generated SQL statement with input parameter values"/}}
++
  == Selection form elements ==
  If you want to display the returned data as options of a [[selection element>>doc:Formcycle.FormDesigner.FormElements.Selection]], you can do so easily by opening the {{designer/}} and selecting the database query as the data source of the selection element.
--{{figure image="002En.png"}}
--Setting up a selection element with data from a database query. Just select the database query as the data source.
++{{info}}
++Queries that are used in selection elements must not have a question mark "?". Queries with a "?" are not offered as a data source for selection elements.
++{{/info}}
++
++{{figure image="data_db_query_designer_en.png"}}
++Using the result of a database query as the data source a select element in the {{designer case="dat"/}}.
  {{/figure}}
  The result of the database query is used to create the options of the [[selection element>>doc:Formcycle.FormDesigner.FormElements.Selection]] in the following order:
@@ -67,6
          +67,11 @@
  == Examples ==
++{{info}}
++{{version major="6" minor="6" patch="3"/}}Starting with {{formcycle/}} Version 6.6.3, the parameter //queryParameterValues// can be used instead of the parameter //queryParameter//. The former is recommended for new projects because the parameter //queryParameter// will not be supported in a future version of {{formcycle/}}. The following examples therefore show one servlet query with //queryParameter// and one with //queryParameterValues// for each SQL query.
++{{/info}}
++
++
  {{code language="sql"}}
  select name, first_name from table where first_name like (?)
  {{/code}}
@@ -73,8
          +73,12 @@
  This SQL statement returns the names of all persons with a certain first name. The first name to search for is specified via an URL parameter.
--URL for running the query: {{code}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&sqlParameter=Robinson{{/code}}
++URL for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameter=Robinson{{/code}}
++{{version major="6" minor="6" patch="3"/}}URL that can be used starting with {{formcycle/}} version 6.6.3 for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameterValues=Robinson{{/code}}
++\\
  {{code language="sql"}}
  select name, first_name from table where id = ?
@@ -82,8
          +82,12 @@
  Retrieves the name of a person with a certain ID. The ID is given as an URL parameter.
--URL for running the query: {{code}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&sqlParameter=100{{/code}}
++URL for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameter=100{{/code}}
++{{version major="6" minor="6" patch="3"/}}URL that can be used starting with {{formcycle/}} version 6.6.3 for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameterValues=100{{/code}}
++\\
  {{code language="sql"}}
  select name, first_name from table where city like(?) AND zip = ?
@@ -91,4
          +91,34 @@
  Retrieves the names of all persons that live in certain city. The city and the ZIP code are given as URL parameters.
--URL for running the query: {{code}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&sqlParameter=Paris,75001{{/code}}
++URL for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameter=Paris,75001{{/code}}
++
++{{version major="6" minor="6" patch="3"/}}URL that can be used starting with {{formcycle/}} version 6.6.3 for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameterValues=Paris&queryParameterValues=75001{{/code}}
++\\
++
++{{code language="sql"}}
++select name, vorname from tabelle where ort like concat(?, '%')
++{{/code}}
++
++This SQL statement returns the names of all persons who live in a place that **starts **with the given characters. The '%' character serves as a wildcard for any number of characters. Depending on the DBMS used, the syntax may differ slightly (here: MySQL). The requested value is passed via URL parameters.
++
++URL for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameter=Par{{/code}}
++
++{{version major="6" minor="6" patch="3"/}}URL that can be used starting with {{formcycle/}} version 6.6.3 for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameterValues=Par{{/code}}
++\\
++
++{{code language="sql"}}
++select name, vorname from tabelle where lower(ort) like concat('%', lower(?), '%')
++{{/code}}
++
++This SQL statement returns the names of all persons who live in a place that **contains **the given characters. Upper/lower case spelling is irrelevant becauce the statement converts both, the value column and the actual filter value to lower case (lower(...)). The requested value is passed via URL parameters.
++
++URL for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameter=aRi{{/code}}
++
++{{version major="6" minor="6" patch="3"/}}URL that can be used starting with {{formcycle/}} version 6.6.3 for running the query:
++{{code language="none"}}http://myserver/formcycle/datenquelledb?mandantName=myself&name=demo&queryParameterValues=aRi{{/code}}

Changes for page DB-Abfragen

Summary

Details

Navigation