Update wiki Home page for sql-stored

gitea_admin 2026-03-11 14:42:36 +00:00
parent 4501235bcb
commit 65261da9dc

43
Home.md

@ -1,21 +1,36 @@
# Deploy the Project on CamelX Platform
# SQL Stored Procedure
Deploy on CamelX Platform in three steps
Perform SQL queries as a JDBC Stored Procedures using Spring JDBC.
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Scheme | `sql-stored` |
| Support Level | Stable |
| Labels | database |
| Version | 4.10.2 |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-sql</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `template` | string | ✓ | | Sets the stored procedure template to perform. You can externalize the template by using file: or classpath: as prefix and specify the location of the file. |
| `batch` | boolean | | `false` | Enables or disables batch mode |
| `dataSource` | object | | | Sets the DataSource to use to communicate with the database. |
| `function` | boolean | | `false` | Whether this call is for a function. |
| `noop` | boolean | | `false` | If set, will ignore the results of the stored procedure template and use the existing IN message as the OUT message for the continuation of processing |
| `outputHeader` | string | | | Store the template result in a header instead of the message body. By default, outputHeader == null and the template result is stored in the message body, any existing content in the message body is discarded. If outputHeader is set, the value is used as the name of the header to store the template result and the original message body is preserved. |
| `useMessageBodyForTemplate` | boolean | | `false` | Whether to use the message body as the stored procedure template and then headers for parameters. If this option is enabled then the template in the uri is not used. |
| `lazyStartProducer` | boolean | | `false` | Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing. |
| `templateOptions` | object | | | Configures the Spring JdbcTemplate with the key/values from the Map |