You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2018/04/11 11:41:28 UTC
[camel] 02/03: Polished
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 54970a53627de925f770276bd2a391b6ec3dae04
Author: Claus Ibsen <cl...@gmail.com>
AuthorDate: Wed Apr 11 13:26:42 2018 +0200
Polished
---
.../src/main/docs/sql-stored-component.adoc | 106 ++++++++++-----------
1 file changed, 52 insertions(+), 54 deletions(-)
diff --git a/components/camel-sql/src/main/docs/sql-stored-component.adoc b/components/camel-sql/src/main/docs/sql-stored-component.adoc
index a670056..6b5b2f4 100644
--- a/components/camel-sql/src/main/docs/sql-stored-component.adoc
+++ b/components/camel-sql/src/main/docs/sql-stored-component.adoc
@@ -15,23 +15,23 @@ Maven users will need to add the following dependency to their `pom.xml`
for this component:
[source,xml]
-------------------------------------------------------------
+----
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-sql</artifactId>
<version>x.x.x</version>
<!-- use the same version as your Camel core version -->
</dependency>
-------------------------------------------------------------
+----
-### URI format
+=== URI format
The SQL component uses the following endpoint URI notation:
-[source,java]
------------------------------
+[source,text]
+----
sql-stored:template[?options]
------------------------------
+----
Where template is the stored procedure template, where you declare the
name of the stored procedure and the IN, INOUT, and OUT arguments.
@@ -39,28 +39,28 @@ name of the stored procedure and the IN, INOUT, and OUT arguments.
You can also refer to the template in a external file on the file system
or classpath such as:
-[source,java]
---------------------------------------------------
+[source,text]
+----
sql-stored:classpath:sql/myprocedure.sql[?options]
---------------------------------------------------
+----
Where sql/myprocedure.sql is a plain text file in the classpath with the
template, as show:
-[source,java]
---------------------------
+[source,text]
+----
SUBNUMBERS(
INTEGER ${headers.num1},
INTEGER ${headers.num2},
INOUT INTEGER ${headers.num3} out1,
OUT INTEGER out2
)
---------------------------
+----
You can append query options to the URI in the following format,
`?option=value&option=value&...`
-### Options
+=== Options
@@ -116,16 +116,16 @@ with the following path and query parameters:
// endpoint options: END
-### Declaring the stored procedure template
+=== Declaring the stored procedure template
The template is declared using a syntax that would be similar to a Java
method signature. The name of the stored procedure, and then the
arguments enclosed in parenthesis. An example explains this well:
-[source,java]
-----------------------------------------------------------------------------------------------------------------------------------------------
+[source,xml]
+----
<to uri="sql-stored:STOREDSAMPLE(INTEGER ${headers.num1},INTEGER ${headers.num2},INOUT INTEGER ${headers.num3} result1,OUT INTEGER result2)"/>
-----------------------------------------------------------------------------------------------------------------------------------------------
+----
The arguments are declared by a type and then a mapping to the Camel
message using simple expression. So, in this example the first two
@@ -136,12 +136,12 @@ the OUT value, also an INTEGER type.
In SQL term the stored procedure could be declared as:
-[source,java]
----------------------------------------------------------------------------------------------------------
+[source,sql]
+----
CREATE PROCEDURE STOREDSAMPLE(VALUE1 INTEGER, VALUE2 INTEGER, INOUT RESULT1 INTEGER, OUT RESULT2 INTEGER)
----------------------------------------------------------------------------------------------------------
+----
-#### IN Parameters
+==== IN Parameters
IN parameters take four parts separated by a space: parameter name, SQL type (with scale), type name and value source.
@@ -149,23 +149,24 @@ Parameter name is optional and will be auto generated if not provided. It must b
SQL type is required and can be an integer (positive or negative) or reference to integer field in some class.
If SQL type contains a dot then component tries resolve that class and read the given field. For example
-SQL type com.Foo.INTEGER is read from the field INTEGER of class com.Foo. If the type doesn't
-contain comma then class to resolve the integer value will be java.sql.Types.
-Type can be postfixed by scale for example DECIMAL(10) would mean java.sql.Types.DECIMAL with scale 10.
+SQL type `com.Foo.INTEGER` is read from the field INTEGER of class `com.Foo`. If the type doesn't
+contain comma then class to resolve the integer value will be `java.sql.Types`.
+Type can be postfixed by scale for example DECIMAL(10) would mean `java.sql.Types.DECIMAL` with scale 10.
Type name is optional and must be given between quotes(').
Value source is required. Value source populates the parameter value from the Exchange.
-It can be either a Simple expression or header location i.e. :#<header name>. For example
-Simple expression ${header.val} would mean that parameter value will be read from the header "val".
+It can be either a Simple expression or header location i.e. `:#<header name>`. For example
+Simple expression `${header.val}` would mean that parameter value will be read from the header "val".
Header location expression :#val would have identical effect.
-[source,java]
-----------------------------------------------------------------------------------------------------------
+[source,xml]
+----
<to uri="sql-stored:MYFUNC('param1' org.example.Types.INTEGER(10) ${header.srcValue})"/>
-----------------------------------------------------------------------------------------------------------
+----
+
URI means that the stored procedure will be called with parameter name "param1",
-it's SQL type is read from field INTEGER of class org.example.Types and scale will be set to 10.
+it's SQL type is read from field INTEGER of class `org.example.Types` and scale will be set to 10.
Input value for the parameter is passed from the header "srcValue".
[source,java]
@@ -176,7 +177,7 @@ URI is identical to previous on except SQL-type is 100 and type name is "mytypen
Actual call will be done using org.springframework.jdbc.core.SqlParameter.
-#### OUT Parameters
+==== OUT Parameters
OUT parameters work similarly IN parameters and contain three parts: SQL type(with scale), type name and output parameter name.
@@ -186,51 +187,53 @@ Type name is optional and also works the same as IN parameters.
Output parameter name is used for the OUT parameter name, as well as the header name where the result will be stored.
-[source,java]
-----------------------------------------------------------------------------------------------------------
+[source,xml]
+----
<to uri="sql-stored:MYFUNC(OUT org.example.Types.DECIMAL(10) outheader1)"/>
-----------------------------------------------------------------------------------------------------------
+----
+
URI means that OUT parameter's name is "outheader1" and result will be but into header "outheader1".
-[source,java]
-----------------------------------------------------------------------------------------------------------
+[source,xml]
+----
<to uri="sql-stored:MYFUNC(OUT org.example.Types.NUMERIC(10) 'mytype' outheader1)"/>
-----------------------------------------------------------------------------------------------------------
+----
+
This is identical to previous one but type name will be "mytype".
-Actual call will be done using org.springframework.jdbc.core.SqlOutParameter.
+Actual call will be done using `org.springframework.jdbc.core.SqlOutParameter`.
-#### INOUT Parameters
+==== INOUT Parameters
INOUT parameters are a combination of all of the above. They receive a value from the exchange, as well as store a
result as a message header. The only caveat is that the IN parameter's "name" is skipped. Instead, the OUT
parameter's "name" defines both the SQL parameter name, as well as the result header name.
-[source,java]
-----------------------------------------------------------------------------------------------------------
+[source,xml]
+----
<to uri="sql-stored:MYFUNC(INOUT DECIMAL(10) ${headers.inheader} outheader)"/>
-----------------------------------------------------------------------------------------------------------
+----
Actual call will be done using org.springframework.jdbc.core.SqlInOutParameter.
-### Camel Sql Starter
+=== Camel SQL Starter
A starter module is available to spring-boot users. When using the starter,
the `DataSource` can be directly configured using spring-boot properties.
-[source]
-------------------------------------------------------
+[source,text]
+----
# Example for a mysql datasource
spring.datasource.url=jdbc:mysql://localhost/test
spring.datasource.username=dbuser
spring.datasource.password=dbpass
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
-------------------------------------------------------
+----
To use this feature, add the following dependencies to your spring boot pom.xml file:
[source,xml]
-------------------------------------------------------
+----
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-sql-starter</artifactId>
@@ -242,15 +245,10 @@ To use this feature, add the following dependencies to your spring boot pom.xml
<artifactId>spring-boot-starter-jdbc</artifactId>
<version>${spring-boot-version}</version>
</dependency>
-------------------------------------------------------
+----
You should also include the specific database driver, if needed.
-### See Also
-
-* Configuring Camel
-* Component
-* Endpoint
-* Getting Started
+=== See Also
* <<sql-component,SQL Component>>
--
To stop receiving notification emails like this one, please contact
davsclaus@apache.org.