@powersync/service-module-mssql 0.0.1

package/dist/types/types.d.ts

@@ -0,0 +1,177 @@
+import { LookupFunction } from 'node:net';
+import * as t from 'ts-codec';
+export declare const MSSQL_CONNECTION_TYPE: "mssql";
+export declare const AzureActiveDirectoryPasswordAuthentication: t.ObjectCodec<{
+    type: t.LiteralCodec<"azure-active-directory-password">;
+    options: t.ObjectCodec<{
+        /**
+         * A user need to provide `userName` associate to their account.
+         */
+        userName: t.IdentityCodec<t.CodecType.String>;
+        /**
+         * A user need to provide `password` associate to their account.
+         */
+        password: t.IdentityCodec<t.CodecType.String>;
+        /**
+         * A client id to use.
+         */
+        clientId: t.IdentityCodec<t.CodecType.String>;
+        /**
+         * Azure tenant ID
+         */
+        tenantId: t.IdentityCodec<t.CodecType.String>;
+    }>;
+}>;
+export type AzureActiveDirectoryPasswordAuthentication = t.Decoded<typeof AzureActiveDirectoryPasswordAuthentication>;
+export declare const AzureActiveDirectoryServicePrincipalSecret: t.ObjectCodec<{
+    type: t.LiteralCodec<"azure-active-directory-service-principal-secret">;
+    options: t.ObjectCodec<{
+        /**
+         * Application (`client`) ID from your registered Azure application
+         */
+        clientId: t.IdentityCodec<t.CodecType.String>;
+        /**
+         * The created `client secret` for this registered Azure application
+         */
+        clientSecret: t.IdentityCodec<t.CodecType.String>;
+        /**
+         * Directory (`tenant`) ID from your registered Azure application
+         */
+        tenantId: t.IdentityCodec<t.CodecType.String>;
+    }>;
+}>;
+export type AzureActiveDirectoryServicePrincipalSecret = t.Decoded<typeof AzureActiveDirectoryServicePrincipalSecret>;
+export declare const DefaultAuthentication: t.ObjectCodec<{
+    type: t.LiteralCodec<"default">;
+    options: t.ObjectCodec<{
+        /**
+         * User name to use for sql server login.
+         */
+        userName: t.IdentityCodec<t.CodecType.String>;
+        /**
+         * Password to use for sql server login.
+         */
+        password: t.IdentityCodec<t.CodecType.String>;
+    }>;
+}>;
+export type DefaultAuthentication = t.Decoded<typeof DefaultAuthentication>;
+export type AuthenticationType = DefaultAuthentication | AzureActiveDirectoryPasswordAuthentication | AzureActiveDirectoryServicePrincipalSecret;
+export interface CDCPollingOptions {
+    /**
+     * Maximum number of transactions to poll per polling cycle. Defaults to 10.
+     */
+    batchSize: number;
+    /**
+     * Interval in milliseconds to wait between polling cycles. Defaults to 1 second.
+     */
+    intervalMs: number;
+}
+export interface NormalizedMSSQLConnectionConfig {
+    id: string;
+    tag: string;
+    username?: string;
+    password?: string;
+    hostname: string;
+    port: number;
+    database: string;
+    schema?: string;
+    authentication?: AuthenticationType;
+    cdcPollingOptions: CDCPollingOptions;
+    /**
+     *  Whether to trust the server certificate. Set to true for local development and self-signed certificates.
+     *  Default is false.
+    */
+    trustServerCertificate: boolean;
+    lookup?: LookupFunction;
+}
+export declare const MSSQLConnectionConfig: t.Intersection<t.Codec<{
+    type: string;
+    id?: string | undefined;
+    tag?: string | undefined;
+    debug_api?: boolean | undefined;
+}, {
+    type: string;
+    id?: string | undefined;
+    tag?: string | undefined;
+    debug_api?: boolean | undefined;
+}, string, t.CodecProps>, t.ObjectCodec<{
+    type: t.LiteralCodec<"mssql">;
+    uri: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    username: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    password: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    database: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    schema: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    hostname: t.OptionalCodec<t.Codec<string, string, string, t.CodecProps>>;
+    port: t.OptionalCodec<t.Codec<number, string | number, string, t.CodecProps>>;
+    authentication: t.OptionalCodec<t.Codec<{
+        type: "azure-active-directory-password";
+        options: {
+            userName: string;
+            password: string;
+            clientId: string;
+            tenantId: string;
+        };
+    } | {
+        type: "azure-active-directory-service-principal-secret";
+        options: {
+            clientId: string;
+            tenantId: string;
+            clientSecret: string;
+        };
+    } | {
+        type: "default";
+        options: {
+            userName: string;
+            password: string;
+        };
+    }, {
+        type: "azure-active-directory-password";
+        options: {
+            userName: string;
+            password: string;
+            clientId: string;
+            tenantId: string;
+        };
+    } | {
+        type: "azure-active-directory-service-principal-secret";
+        options: {
+            clientId: string;
+            tenantId: string;
+            clientSecret: string;
+        };
+    } | {
+        type: "default";
+        options: {
+            userName: string;
+            password: string;
+        };
+    }, string, t.CodecProps>>;
+    cdcPollingOptions: t.OptionalCodec<t.Codec<{
+        batchSize?: number | undefined;
+        intervalMs?: number | undefined;
+    }, {
+        batchSize?: number | undefined;
+        intervalMs?: number | undefined;
+    }, string, t.CodecProps>>;
+    /**
+     *  Whether to trust the server certificate. Set to true for local development and self-signed certificates.
+     *  Default is false.
+     */
+    trustServerCertificate: t.OptionalCodec<t.Codec<boolean, boolean, string, t.CodecProps>>;
+    reject_ip_ranges: t.OptionalCodec<t.Codec<string[], string[], string, t.CodecProps>>;
+}>>;
+/**
+ * Config input specified when starting services
+ */
+export type MSSQLConnectionConfig = t.Decoded<typeof MSSQLConnectionConfig>;
+/**
+ * Resolved version of {@link MSSQLConnectionConfig}
+ */
+export type ResolvedMSSQLConnectionConfig = MSSQLConnectionConfig & NormalizedMSSQLConnectionConfig;
+/**
+ * Validate and normalize connection options.
+ *
+ * Returns destructured options.
+ */
+export declare function normalizeConnectionConfig(options: MSSQLConnectionConfig): NormalizedMSSQLConnectionConfig;
+export declare function baseUri(config: ResolvedMSSQLConnectionConfig): string;

package/dist/types/types.js

@@ -0,0 +1,141 @@
+import { ErrorCode, makeHostnameLookupFunction, ServiceError } from '@powersync/lib-services-framework';
+import * as service_types from '@powersync/service-types';
+import * as t from 'ts-codec';
+import * as urijs from 'uri-js';
+export const MSSQL_CONNECTION_TYPE = 'mssql';
+export const AzureActiveDirectoryPasswordAuthentication = t.object({
+    type: t.literal('azure-active-directory-password'),
+    options: t.object({
+        /**
+         * A user need to provide `userName` associate to their account.
+         */
+        userName: t.string,
+        /**
+         * A user need to provide `password` associate to their account.
+         */
+        password: t.string,
+        /**
+         * A client id to use.
+         */
+        clientId: t.string,
+        /**
+         * Azure tenant ID
+         */
+        tenantId: t.string
+    })
+});
+export const AzureActiveDirectoryServicePrincipalSecret = t.object({
+    type: t.literal('azure-active-directory-service-principal-secret'),
+    options: t.object({
+        /**
+         * Application (`client`) ID from your registered Azure application
+         */
+        clientId: t.string,
+        /**
+         * The created `client secret` for this registered Azure application
+         */
+        clientSecret: t.string,
+        /**
+         * Directory (`tenant`) ID from your registered Azure application
+         */
+        tenantId: t.string
+    })
+});
+export const DefaultAuthentication = t.object({
+    type: t.literal('default'),
+    options: t.object({
+        /**
+         * User name to use for sql server login.
+         */
+        userName: t.string,
+        /**
+         * Password to use for sql server login.
+         */
+        password: t.string
+    })
+});
+export const MSSQLConnectionConfig = service_types.configFile.DataSourceConfig.and(t.object({
+    type: t.literal(MSSQL_CONNECTION_TYPE),
+    uri: t.string.optional(),
+    username: t.string.optional(),
+    password: t.string.optional(),
+    database: t.string.optional(),
+    schema: t.string.optional(),
+    hostname: t.string.optional(),
+    port: service_types.configFile.portCodec.optional(),
+    authentication: DefaultAuthentication.or(AzureActiveDirectoryPasswordAuthentication)
+        .or(AzureActiveDirectoryServicePrincipalSecret)
+        .optional(),
+    cdcPollingOptions: t.object({
+        batchSize: t.number.optional(),
+        intervalMs: t.number.optional()
+    }).optional(),
+    /**
+     *  Whether to trust the server certificate. Set to true for local development and self-signed certificates.
+     *  Default is false.
+     */
+    trustServerCertificate: t.boolean.optional(),
+    reject_ip_ranges: t.array(t.string).optional()
+}));
+/**
+ * Validate and normalize connection options.
+ *
+ * Returns destructured options.
+ */
+export function normalizeConnectionConfig(options) {
+    let uri;
+    if (options.uri) {
+        uri = urijs.parse(options.uri);
+        if (uri.scheme != 'mssql') {
+            throw new ServiceError(ErrorCode.PSYNC_S1109, `Invalid URI - protocol must be mssql, got ${JSON.stringify(uri.scheme)}`);
+        }
+    }
+    else {
+        uri = urijs.parse('mssql:///');
+    }
+    const hostname = options.hostname ?? uri.host ?? '';
+    const port = Number(options.port ?? uri.port ?? 1433);
+    const database = options.database ?? uri.path?.substring(1) ?? '';
+    const [uri_username, uri_password] = (uri.userinfo ?? '').split(':');
+    const username = options.username ?? uri_username ?? '';
+    const password = options.password ?? uri_password ?? '';
+    if (hostname == '') {
+        throw new ServiceError(ErrorCode.PSYNC_S1106, `MSSQL connection: hostname required`);
+    }
+    if (username == '' && !options.authentication) {
+        throw new ServiceError(ErrorCode.PSYNC_S1107, `MSSQL connection: username or authentication config is required`);
+    }
+    if (password == '' && !options.authentication) {
+        throw new ServiceError(ErrorCode.PSYNC_S1108, `MSSQL connection: password or authentication config is required`);
+    }
+    if (database == '') {
+        throw new ServiceError(ErrorCode.PSYNC_S1105, `MSSQL connection: database required`);
+    }
+    const lookup = makeHostnameLookupFunction(hostname, { reject_ip_ranges: options.reject_ip_ranges ?? [] });
+    return {
+        id: options.id ?? 'default',
+        tag: options.tag ?? 'default',
+        username,
+        password,
+        hostname,
+        port,
+        database,
+        lookup,
+        authentication: options.authentication,
+        cdcPollingOptions: {
+            /**
+             * Maximum number of transactions to poll per polling cycle. Defaults to 10.
+             */
+            batchSize: options.cdcPollingOptions?.batchSize ?? 10,
+            /**
+             * Interval in milliseconds to wait between polling cycles. Defaults to 1 second.
+             */
+            intervalMs: options.cdcPollingOptions?.intervalMs ?? 1000,
+        },
+        trustServerCertificate: options.trustServerCertificate ?? false,
+    };
+}
+export function baseUri(config) {
+    return `mssql://${config.hostname}:${config.port}/${config.database}`;
+}
+//# sourceMappingURL=types.js.map

package/dist/types/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,0BAA0B,EAAE,YAAY,EAAE,MAAM,mCAAmC,CAAC;AACxG,OAAO,KAAK,aAAa,MAAM,0BAA0B,CAAC;AAE1D,OAAO,KAAK,CAAC,MAAM,UAAU,CAAC;AAC9B,OAAO,KAAK,KAAK,MAAM,QAAQ,CAAC;AAEhC,MAAM,CAAC,MAAM,qBAAqB,GAAG,OAAgB,CAAC;AAEtD,MAAM,CAAC,MAAM,0CAA0C,GAAG,CAAC,CAAC,MAAM,CAAC;IACjE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iCAAiC,CAAC;IAClD,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;QAClB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;QAClB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;QAClB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;KACnB,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,0CAA0C,GAAG,CAAC,CAAC,MAAM,CAAC;IACjE,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,iDAAiD,CAAC;IAClE,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;QAClB;;WAEG;QACH,YAAY,EAAE,CAAC,CAAC,MAAM;QACtB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;KACnB,CAAC;CACH,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC5C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;IAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC;QAChB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;QAClB;;WAEG;QACH,QAAQ,EAAE,CAAC,CAAC,MAAM;KACnB,CAAC;CACH,CAAC,CAAC;AA2CH,MAAM,CAAC,MAAM,qBAAqB,GAAG,aAAa,CAAC,UAAU,CAAC,gBAAgB,CAAC,GAAG,CAChF,CAAC,CAAC,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC;IACtC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IACxB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAC7B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAC3B,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;IAC7B,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,SAAS,CAAC,QAAQ,EAAE;IAEnD,cAAc,EAAE,qBAAqB,CAAC,EAAE,CAAC,0CAA0C,CAAC;SACjF,EAAE,CAAC,0CAA0C,CAAC;SAC9C,QAAQ,EAAE;IAEb,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC1B,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;QAC9B,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE;KAChC,CAAC,CAAC,QAAQ,EAAE;IAEb;;;OAGG;IACH,sBAAsB,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;IAE5C,gBAAgB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE;CAC/C,CAAC,CACH,CAAC;AAYF;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CAAC,OAA8B;IACtE,IAAI,GAAwB,CAAC;IAC7B,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAChB,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,GAAG,CAAC,MAAM,IAAI,OAAO,EAAE,CAAC;YAC1B,MAAM,IAAI,YAAY,CACpB,SAAS,CAAC,WAAW,EACrB,6CAA6C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAC1E,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;IACpD,MAAM,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,IAAI,IAAI,CAAC,CAAC;IAEtD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAElE,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAErE,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,IAAI,EAAE,CAAC;IACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,YAAY,IAAI,EAAE,CAAC;IAExD,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;QACnB,MAAM,IAAI,YAAY,CAAC,SAAS,CAAC,WAAW,EAAE,qCAAqC,CAAC,CAAC;IACvF,CAAC;IAED,IAAI,QAAQ,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAC9C,MAAM,IAAI,YAAY,CAAC,SAAS,CAAC,WAAW,EAAE,iEAAiE,CAAC,CAAC;IACnH,CAAC;IAED,IAAI,QAAQ,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;QAC9C,MAAM,IAAI,YAAY,CAAC,SAAS,CAAC,WAAW,EAAE,iEAAiE,CAAC,CAAC;IACnH,CAAC;IAED,IAAI,QAAQ,IAAI,EAAE,EAAE,CAAC;QACnB,MAAM,IAAI,YAAY,CAAC,SAAS,CAAC,WAAW,EAAE,qCAAqC,CAAC,CAAC;IACvF,CAAC;IAED,MAAM,MAAM,GAAG,0BAA0B,CAAC,QAAQ,EAAE,EAAE,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,IAAI,EAAE,EAAE,CAAC,CAAC;IAE1G,OAAO;QACL,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,SAAS;QAC3B,GAAG,EAAE,OAAO,CAAC,GAAG,IAAI,SAAS;QAE7B,QAAQ;QACR,QAAQ;QACR,QAAQ;QACR,IAAI;QACJ,QAAQ;QAER,MAAM;QACN,cAAc,EAAE,OAAO,CAAC,cAAc;QAEtC,iBAAiB,EAAE;YACjB;;eAEG;YACH,SAAS,EAAE,OAAO,CAAC,iBAAiB,EAAE,SAAS,IAAI,EAAE;YAErD;;eAEG;YACH,UAAU,EAAE,OAAO,CAAC,iBAAiB,EAAE,UAAU,IAAI,IAAI;SAC1D;QAED,sBAAsB,EAAE,OAAO,CAAC,sBAAsB,IAAI,KAAK;KACtB,CAAC;AAC9C,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,MAAqC;IAC3D,OAAO,WAAW,MAAM,CAAC,QAAQ,IAAI,MAAM,CAAC,IAAI,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;AACxE,CAAC"}

package/dist/utils/mssql.d.ts

@@ -0,0 +1,80 @@
+import sql from 'mssql';
+import { MSSQLConnectionManager } from '../replication/MSSQLConnectionManager.js';
+import { LSN } from '../common/LSN.js';
+import { CaptureInstance, MSSQLSourceTable } from '../common/MSSQLSourceTable.js';
+import { MSSQLParameter } from '../types/mssql-data-types.js';
+import { SqlSyncRules, TablePattern } from '@powersync/service-sync-rules';
+import { ResolvedTable } from './schema.js';
+import * as service_types from '@powersync/service-types';
+export declare const POWERSYNC_CHECKPOINTS_TABLE = "_powersync_checkpoints";
+export declare const SUPPORTED_ENGINE_EDITIONS: Map<number, string>;
+export declare const MINIMUM_SUPPORTED_VERSION = "16.0";
+export declare function checkSourceConfiguration(connectionManager: MSSQLConnectionManager): Promise<string[]>;
+export declare function ensurePowerSyncCheckpointsTable(connectionManager: MSSQLConnectionManager): Promise<string[]>;
+export declare function createCheckpoint(connectionManager: MSSQLConnectionManager): Promise<void>;
+export interface IsTableEnabledForCDCOptions {
+    connectionManager: MSSQLConnectionManager;
+    table: string;
+    schema: string;
+}
+/**
+ *  Check if the specified table is enabled for CDC.
+ *  @param options
+ */
+export declare function isTableEnabledForCDC(options: IsTableEnabledForCDCOptions): Promise<boolean>;
+export interface EnableCDCForTableOptions {
+    connectionManager: MSSQLConnectionManager;
+    table: string;
+}
+export declare function enableCDCForTable(options: EnableCDCForTableOptions): Promise<void>;
+/**
+ *  Check if the supplied version is newer or equal to the target version.
+ *  @param version
+ *  @param minimumVersion
+ */
+export declare function isVersionAtLeast(version: string, minimumVersion: string): boolean;
+export interface IsWithinRetentionThresholdOptions {
+    checkpointLSN: LSN;
+    tables: MSSQLSourceTable[];
+    connectionManager: MSSQLConnectionManager;
+}
+/**
+ *  Checks that CDC the specified checkpoint LSN is within the retention threshold for all specified tables.
+ *  CDC periodically cleans up old data up to the retention threshold. If replication has been stopped for too long it is
+ *  possible for the checkpoint LSN to be older than the minimum LSN in the CDC tables. In such a case we need to perform a new snapshot.
+ *  @param options
+ */
+export declare function isWithinRetentionThreshold(options: IsWithinRetentionThresholdOptions): Promise<boolean>;
+export declare function getMinLSN(connectionManager: MSSQLConnectionManager, captureInstance: string): Promise<LSN>;
+export declare function incrementLSN(lsn: LSN, connectionManager: MSSQLConnectionManager): Promise<LSN>;
+export interface GetCaptureInstanceOptions {
+    connectionManager: MSSQLConnectionManager;
+    tableName: string;
+    schema: string;
+}
+export declare function getCaptureInstance(options: GetCaptureInstanceOptions): Promise<CaptureInstance | null>;
+/**
+ *  Return the LSN of the latest transaction recorded in the transaction log
+ *  @param connectionManager
+ */
+export declare function getLatestLSN(connectionManager: MSSQLConnectionManager): Promise<LSN>;
+/**
+ *  Return the LSN of the lastest transaction replicated to the CDC tables.
+ *  @param connectionManager
+ */
+export declare function getLatestReplicatedLSN(connectionManager: MSSQLConnectionManager): Promise<LSN>;
+/**
+ *  Escapes an identifier for use in MSSQL queries.
+ *  @param identifier
+ */
+export declare function escapeIdentifier(identifier: string): string;
+export declare function toQualifiedTableName(schema: string, tableName: string): string;
+export declare function isIColumnMetadata(obj: any): obj is sql.IColumnMetadata;
+export declare function addParameters(request: sql.Request, parameters: MSSQLParameter[]): sql.Request;
+export interface GetDebugTableInfoOptions {
+    connectionManager: MSSQLConnectionManager;
+    tablePattern: TablePattern;
+    table: ResolvedTable;
+    syncRules: SqlSyncRules;
+}
+export declare function getDebugTableInfo(options: GetDebugTableInfoOptions): Promise<service_types.TableInfo>;