Member Junction
    Preparing search index...

    Interface SQLServerConnectionConfig

    Non-secret connection config stored in ExternalDataSource.ConnectionConfig (JSON).

    interface SQLServerConnectionConfig {
        allowInsecureTransport?: boolean;
        authMode?: "sql" | "entra-service-principal";
        database?: string;
        host?: string;
        instanceName?: string;
        maxPoolSize?: number;
        port?: number;
        server?: string;
        ssl?: boolean;
        sslRejectUnauthorized?: boolean;
    }
    Index

    Properties

    allowInsecureTransport? authMode? database? host? instanceName? maxPoolSize? port? server? ssl? sslRejectUnauthorized?

    Properties

    allowInsecureTransport?: boolean

    Explicitly accept an UNENCRYPTED connection to a non-local host. Default false → the driver refuses plaintext to a remote host (local hosts are always allowed).

    authMode?: "sql" | "entra-service-principal"

    Authentication mode. 'sql' (default) uses username/password. 'entra-service-principal' authenticates with a Microsoft Entra service principal (tenantId/clientId/clientSecret from the credential) — required for Microsoft Fabric SQL endpoints, which speak TDS but refuse SQL auth. When unset, the driver infers 'entra-service-principal' if the credential carries a clientId, otherwise 'sql' (so a correctly-shaped credential Just Works without setting this).

    database?: string
    host?: string
    instanceName?: string

    Named instance (e.g. 'SQLEXPRESS'); mutually exclusive with an explicit port on most setups.

    maxPoolSize?: number

    Max pool connections (default 5).

    port?: number
    server?: string

    Server host (accepts server or host).

    ssl?: boolean

    Enable TLS encryption for the connection.

    sslRejectUnauthorized?: boolean

    Whether TLS must present a trusted certificate. Defaults to TRUE (verify the server cert). Set to false only for managed/self-signed dev endpoints that you knowingly accept — doing so disables MITM protection. Maps to mssql trustServerCertificate.

    Settings

    Member Visibility

    On This Page

    Properties