Skip to Content

SQL Server stored procedures

Runtime 0.9.7.x (Oct 2026) can call Microsoft SQL Server stored procedures through a single shared JDBC connection opened at startup.

Configuration

SettingSource
JDBC URLEnv SQLSERVER_URL, or property sqlserver.url in ecosystem.properties
UserEnv SQLSERVER_USER, or sqlserver.user
PasswordEnv SQLSERVER_PASSWORD, or sqlserver.password
Query timeout (seconds)Property sqlserver.query.timeout only (default 30)

Environment variables override the matching sqlserver.* properties.

If the connection fails at startup, the runtime logs EcosystemMaster:E002 and continues without SQL Server.

See also Runtime environment variables.

API

POST /callSqlServerProcedure Content-Type: application/json

Request body:

{ "procedure": "dbo.usp_X", "parameters": [ { "name": "CustomerId", "value": "00000000-0000-0000-0000-000000000001", "type": "uniqueidentifier", "direction": "in" }, { "name": "Points", "type": "int", "direction": "out" } ], "type": "r" }
FieldMeaning
procedureStored procedure name (for example dbo.usp_X)
parametersBindings with name, optional value, type, and direction (in or out)
typer — row objects (default); c — column arrays

Response shape:

{ "data": [], "outputs": {}, "updateCount": 0 }

Supported parameter types: varchar, nvarchar, int, bigint, bit, float, decimal, date, datetime, uniqueidentifier.

Confirm whether your deployment requires MASTER_KEY / X-API-KEY on this route the same way as other runtime admin endpoints. See API Access.

Local sample database

The runtime repo ships Docker/sqlserver/docker-compose.yml (SQL Server 2022, amd64, host port 1433, applies init/*.sql). Change the sample SA password before use.

Last updated on