diff --git a/Home.md b/Home.md index 93a012c..558a535 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,39 @@ -# Deploy the Project on CamelX Platform +# Microsoft SQL Server Source -Deploy on CamelX Platform in three steps +Query data from a Microsoft SQL Server Database. -## Step 1: Create a release -From the project space, click on **"Create a release"** +In your Pipe file, you must explicitly declare the SQL Server driver dependency in spec->integration->dependencies -The new version is automatically available in the list +- "mvn:com.microsoft.sqlserver:mssql-jdbc:" -## Step 2: Deploy -Click on **"Deploy"** +## Metadata -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +| Property | Value | +|----------|-------| +| Type | source | +| Group | SQL | +| Namespace | Database | +| Support Level | Stable | +| Provider | Apache Software Foundation | -## Step 3: Expose -Enable **"Expose"** +## Properties -Choose an **API Gateway** (Internal, Public, etc.) +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `serverName` | string | ✓ | | The server name for the data source. | +| `serverPort` | string | | `1433` | The server port for the data source. | +| `username` | string | ✓ | | The username to access a secured SQL Server Database | +| `password` | string | ✓ | | The password to access a secured SQL Server Database | +| `query` | string | ✓ | | The query to execute against the SQL Server Database | +| `databaseName` | string | ✓ | | The name of the Database. | +| `consumedQuery` | string | | | A query to run on a tuple consumed | +| `encrypt` | boolean | | `false` | Encrypt the connection to SQL Server. | +| `trustServerCertificate` | boolean | | `true` | Trust Server Certificate | +| `delay` | integer | | `500` | The number of milliseconds before the next poll | + +## Dependencies + +- `camel:jackson` +- `camel:kamelet` +- `camel:sql` +- `mvn:org.apache.commons:commons-dbcp2:2.13.0`