Driver Mssql schema — Data Protocol reference

Microsoft SQL Server driver configuration — the config slot of a datasource whose driver resolves to mssql (sqlserver / tedious).

FEDERATION ONLY. SQL Server is served by @objectstack/driver-sql over knex's mssql client (the tedious binding) for an ADR-0015 external datasource — schemaMode: 'external' or 'validate-only' — whose tables already exist and are read (and, with external.allowWrites, written) in place. The platform does not build its own schema on SQL Server, so a managed datasource declaring this driver is refused at parse (DriverVocabularyEntry.federationOnly), and no boot host offers it as the platform database. The usual reason to point a datasource here is an older line-of-business system (an ERP, a MES, a HIS) whose database is federated in place rather than migrated.

Every key here is read by createDefaultDatasourceDriverFactory (→ SqlDriver, knex mssql). There is no url: tedious reads no connection-string grammar, so a URL key would have to be parsed by a second grammar the client never sees — the discrete fields are the shape it takes. There is no autoMigrate either: it governs DDL the platform emits, and on SQL Server it emits none.

TypeScript Usage

import { MssqlConfigSchema } from '@objectstack/spec/data';
import type { MssqlConfig } from '@objectstack/spec/data';

// Validate data
const result = MssqlConfigSchema.parse(data);

MssqlConfig

Microsoft SQL Server connection configuration (federation only)

Properties