@mastra/mssql 0.2.1-alpha.0

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+> @mastra/mssql@0.2.1-alpha.0 build /home/runner/work/mastra/mastra/stores/mssql
+> tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+TSC Build start
+TSC ⚡️ Build success in 10417ms
+DTS Build start
+CLI Target: es2022
+Analysis will use the bundled TypeScript version 5.8.3
+Writing package typings: /home/runner/work/mastra/mastra/stores/mssql/dist/_tsup-dts-rollup.d.ts
+Analysis will use the bundled TypeScript version 5.8.3
+Writing package typings: /home/runner/work/mastra/mastra/stores/mssql/dist/_tsup-dts-rollup.d.cts
+DTS ⚡️ Build success in 12492ms
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+ESM dist/index.js 61.79 KB
+ESM ⚡️ Build success in 1450ms
+CJS dist/index.cjs 62.90 KB
+CJS ⚡️ Build success in 1973ms

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog for mastra-mssql
+
+## 0.2.1-alpha.0
+
+### Patch Changes
+
+- 03745fa: mssql provider
+- Updated dependencies [7827943]
+- Updated dependencies [bf1e7e7]
+- Updated dependencies [cbddd18]
+  - @mastra/core@0.11.0-alpha.0
+
+## 0.1.0
+
+- Initial implementation

package/LICENSE.md

@@ -0,0 +1,15 @@
+# Apache License 2.0
+
+Copyright (c) 2025 Kepler Software, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,96 @@
+# @mastra/mssql
+
+Microsoft SQL Server implementation for Mastra, providing general storage capabilities with connection pooling and transaction support.
+
+## Installation
+
+```bash
+npm install @mastra/mssql
+```
+
+## Prerequisites
+
+- Microsoft SQL Server 2016 or higher
+- User with privileges to create tables and schemas (if needed)
+
+## Usage
+
+### Storage
+
+```typescript
+import { MSSQLStore } from '@mastra/mssql';
+
+const store = new MSSQLStore({
+  server: 'localhost',
+  port: 1433,
+  database: 'mastra',
+  user: 'sa',
+  password: 'yourStrong(!)Password',
+  // options: { encrypt: true, trustServerCertificate: true }, // Optional
+});
+
+// Create a thread
+await store.saveThread({
+  id: 'thread-123',
+  resourceId: 'resource-456',
+  title: 'My Thread',
+  metadata: { key: 'value' },
+});
+
+// Add messages to thread
+await store.saveMessages([
+  {
+    id: 'msg-789',
+    threadId: 'thread-123',
+    role: 'user',
+    type: 'text',
+    content: [{ type: 'text', text: 'Hello' }],
+    resourceId: 'resource-456',
+    createdAt: new Date(),
+  },
+]);
+
+// Query threads and messages
+const savedThread = await store.getThreadById({ threadId: 'thread-123' });
+const messages = await store.getMessages({ threadId: 'thread-123' });
+```
+
+## Configuration
+
+The MSSQL store can be initialized with either:
+
+- `connectionString`: Microsoft SQL Server connection string
+- Configuration object with server, port, database, user, and password
+
+Connection pool settings are managed by the [mssql](https://www.npmjs.com/package/mssql) package.
+
+## Features
+
+- Thread and message storage with JSON support
+- Atomic transactions for data consistency
+- Efficient batch operations
+- Rich metadata support
+- Timestamp tracking
+- Cascading deletes (emulated)
+
+## Storage Methods
+
+- `saveThread({ thread })`: Create or update a thread
+- `getThreadById({ threadId })`: Get a thread by ID
+- `deleteThread({ threadId })`: Delete a thread and its messages
+- `saveMessages({ messages })`: Save multiple messages in a transaction
+- `getMessages({ threadId })`: Get all messages for a thread
+- `updateMessages({ messages })`: Update messages by ID
+- `getThreadsByResourceIdPaginated({ resourceId, page, perPage })`: Paginated thread listing
+- `getMessagesPaginated({ threadId, selectBy })`: Paginated message listing
+- `clearTable({ tableName })`: Remove all rows from a table (with cascade)
+- `createTable({ tableName, schema })`: Create a table if it does not exist
+- `alterTable({ tableName, schema, ifNotExists })`: Add columns if they do not exist
+- `saveResource({ resource })`: Save a resource
+- `getResourceById({ resourceId })`: Get a resource by ID
+- `updateResource({ resourceId, ... })`: Update a resource
+
+## Related Links
+
+- [Microsoft SQL Server Documentation](https://docs.microsoft.com/en-us/sql/sql-server/)
+- [node-mssql Documentation](https://www.npmjs.com/package/mssql)

package/dist/_tsup-dts-rollup.d.cts

@@ -0,0 +1,213 @@
+import type { EvalRow } from '@mastra/core/storage';
+import type { MastraMessageContentV2 } from '@mastra/core/agent';
+import type { MastraMessageV1 } from '@mastra/core/memory';
+import type { MastraMessageV2 } from '@mastra/core/agent';
+import { MastraStorage } from '@mastra/core/storage';
+import type { PaginationArgs } from '@mastra/core/storage';
+import type { PaginationInfo } from '@mastra/core/storage';
+import sql from 'mssql';
+import type { StorageColumn } from '@mastra/core/storage';
+import type { StorageGetMessagesArg } from '@mastra/core/storage';
+import type { StorageResourceType } from '@mastra/core/storage';
+import type { StorageThreadType } from '@mastra/core/memory';
+import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { WorkflowRun } from '@mastra/core/storage';
+import type { WorkflowRuns } from '@mastra/core/storage';
+import type { WorkflowRunState } from '@mastra/core/workflows';
+
+declare type MastraMessageV2WithTypedContent = Omit<MastraMessageV2, 'content'> & {
+    content: MastraMessageContentV2;
+};
+export { MastraMessageV2WithTypedContent }
+export { MastraMessageV2WithTypedContent as MastraMessageV2WithTypedContent_alias_1 }
+
+declare type MSSQLConfig = MSSQLConfigType;
+export { MSSQLConfig }
+export { MSSQLConfig as MSSQLConfig_alias_1 }
+
+declare type MSSQLConfigType = {
+    schemaName?: string;
+} & ({
+    server: string;
+    port: number;
+    database: string;
+    user: string;
+    password: string;
+    options?: sql.IOptions;
+} | {
+    connectionString: string;
+});
+export { MSSQLConfigType }
+export { MSSQLConfigType as MSSQLConfigType_alias_1 }
+
+declare class MSSQLStore extends MastraStorage {
+    pool: sql.ConnectionPool;
+    private schema?;
+    private setupSchemaPromise;
+    private schemaSetupComplete;
+    private isConnected;
+    constructor(config: MSSQLConfigType);
+    init(): Promise<void>;
+    private _performInitializationAndStore;
+    get supports(): {
+        selectByIncludeResourceScope: boolean;
+        resourceWorkingMemory: boolean;
+    };
+    private getTableName;
+    private getSchemaName;
+    private transformEvalRow;
+    /** @deprecated use getEvals instead */
+    getEvalsByAgentName(agentName: string, type?: 'test' | 'live'): Promise<EvalRow[]>;
+    batchInsert({ tableName, records }: {
+        tableName: TABLE_NAMES;
+        records: Record<string, any>[];
+    }): Promise<void>;
+    /** @deprecated use getTracesPaginated instead*/
+    getTraces(args: {
+        name?: string;
+        scope?: string;
+        attributes?: Record<string, string>;
+        filters?: Record<string, any>;
+        page: number;
+        perPage?: number;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<any[]>;
+    getTracesPaginated(args: {
+        name?: string;
+        scope?: string;
+        attributes?: Record<string, string>;
+        filters?: Record<string, any>;
+    } & PaginationArgs): Promise<PaginationInfo & {
+        traces: any[];
+    }>;
+    private setupSchema;
+    protected getSqlType(type: StorageColumn['type'], isPrimaryKey?: boolean): string;
+    createTable({ tableName, schema, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+    }): Promise<void>;
+    protected getDefaultValue(type: StorageColumn['type']): string;
+    alterTable({ tableName, schema, ifNotExists, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+        ifNotExists: string[];
+    }): Promise<void>;
+    clearTable({ tableName }: {
+        tableName: TABLE_NAMES;
+    }): Promise<void>;
+    insert({ tableName, record }: {
+        tableName: TABLE_NAMES;
+        record: Record<string, any>;
+    }): Promise<void>;
+    load<R>({ tableName, keys }: {
+        tableName: TABLE_NAMES;
+        keys: Record<string, string>;
+    }): Promise<R | null>;
+    getThreadById({ threadId }: {
+        threadId: string;
+    }): Promise<StorageThreadType | null>;
+    getThreadsByResourceIdPaginated(args: {
+        resourceId: string;
+    } & PaginationArgs): Promise<PaginationInfo & {
+        threads: StorageThreadType[];
+    }>;
+    saveThread({ thread }: {
+        thread: StorageThreadType;
+    }): Promise<StorageThreadType>;
+    /**
+     * @deprecated use getThreadsByResourceIdPaginated instead
+     */
+    getThreadsByResourceId(args: {
+        resourceId: string;
+    }): Promise<StorageThreadType[]>;
+    /**
+     * Updates a thread's title and metadata, merging with existing metadata. Returns the updated thread.
+     */
+    updateThread({ id, title, metadata, }: {
+        id: string;
+        title: string;
+        metadata: Record<string, unknown>;
+    }): Promise<StorageThreadType>;
+    deleteThread({ threadId }: {
+        threadId: string;
+    }): Promise<void>;
+    private _getIncludedMessages;
+    /**
+     * @deprecated use getMessagesPaginated instead
+     */
+    getMessages(args: StorageGetMessagesArg & {
+        format?: 'v1';
+    }): Promise<MastraMessageV1[]>;
+    getMessages(args: StorageGetMessagesArg & {
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    getMessagesPaginated(args: StorageGetMessagesArg & {
+        format?: 'v1' | 'v2';
+    }): Promise<PaginationInfo & {
+        messages: MastraMessageV1[] | MastraMessageV2[];
+    }>;
+    private _parseAndFormatMessages;
+    saveMessages(args: {
+        messages: MastraMessageV1[];
+        format?: undefined | 'v1';
+    }): Promise<MastraMessageV1[]>;
+    saveMessages(args: {
+        messages: MastraMessageV2[];
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    persistWorkflowSnapshot({ workflowName, runId, snapshot, }: {
+        workflowName: string;
+        runId: string;
+        snapshot: WorkflowRunState;
+    }): Promise<void>;
+    loadWorkflowSnapshot({ workflowName, runId, }: {
+        workflowName: string;
+        runId: string;
+    }): Promise<WorkflowRunState | null>;
+    private hasColumn;
+    private parseWorkflowRun;
+    getWorkflowRuns({ workflowName, fromDate, toDate, limit, offset, resourceId, }?: {
+        workflowName?: string;
+        fromDate?: Date;
+        toDate?: Date;
+        limit?: number;
+        offset?: number;
+        resourceId?: string;
+    }): Promise<WorkflowRuns>;
+    getWorkflowRunById({ runId, workflowName, }: {
+        runId: string;
+        workflowName?: string;
+    }): Promise<WorkflowRun | null>;
+    updateMessages({ messages, }: {
+        messages: (Partial<Omit<MastraMessageV2, 'createdAt'>> & {
+            id: string;
+            content?: {
+                metadata?: MastraMessageContentV2['metadata'];
+                content?: MastraMessageContentV2['content'];
+            };
+        })[];
+    }): Promise<MastraMessageV2[]>;
+    close(): Promise<void>;
+    getEvals(options?: {
+        agentName?: string;
+        type?: 'test' | 'live';
+    } & PaginationArgs): Promise<PaginationInfo & {
+        evals: EvalRow[];
+    }>;
+    saveResource({ resource }: {
+        resource: StorageResourceType;
+    }): Promise<StorageResourceType>;
+    updateResource({ resourceId, workingMemory, metadata, }: {
+        resourceId: string;
+        workingMemory?: string;
+        metadata?: Record<string, unknown>;
+    }): Promise<StorageResourceType>;
+    getResourceById({ resourceId }: {
+        resourceId: string;
+    }): Promise<StorageResourceType | null>;
+}
+export { MSSQLStore }
+export { MSSQLStore as MSSQLStore_alias_1 }
+
+export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -0,0 +1,213 @@
+import type { EvalRow } from '@mastra/core/storage';
+import type { MastraMessageContentV2 } from '@mastra/core/agent';
+import type { MastraMessageV1 } from '@mastra/core/memory';
+import type { MastraMessageV2 } from '@mastra/core/agent';
+import { MastraStorage } from '@mastra/core/storage';
+import type { PaginationArgs } from '@mastra/core/storage';
+import type { PaginationInfo } from '@mastra/core/storage';
+import sql from 'mssql';
+import type { StorageColumn } from '@mastra/core/storage';
+import type { StorageGetMessagesArg } from '@mastra/core/storage';
+import type { StorageResourceType } from '@mastra/core/storage';
+import type { StorageThreadType } from '@mastra/core/memory';
+import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { WorkflowRun } from '@mastra/core/storage';
+import type { WorkflowRuns } from '@mastra/core/storage';
+import type { WorkflowRunState } from '@mastra/core/workflows';
+
+declare type MastraMessageV2WithTypedContent = Omit<MastraMessageV2, 'content'> & {
+    content: MastraMessageContentV2;
+};
+export { MastraMessageV2WithTypedContent }
+export { MastraMessageV2WithTypedContent as MastraMessageV2WithTypedContent_alias_1 }
+
+declare type MSSQLConfig = MSSQLConfigType;
+export { MSSQLConfig }
+export { MSSQLConfig as MSSQLConfig_alias_1 }
+
+declare type MSSQLConfigType = {
+    schemaName?: string;
+} & ({
+    server: string;
+    port: number;
+    database: string;
+    user: string;
+    password: string;
+    options?: sql.IOptions;
+} | {
+    connectionString: string;
+});
+export { MSSQLConfigType }
+export { MSSQLConfigType as MSSQLConfigType_alias_1 }
+
+declare class MSSQLStore extends MastraStorage {
+    pool: sql.ConnectionPool;
+    private schema?;
+    private setupSchemaPromise;
+    private schemaSetupComplete;
+    private isConnected;
+    constructor(config: MSSQLConfigType);
+    init(): Promise<void>;
+    private _performInitializationAndStore;
+    get supports(): {
+        selectByIncludeResourceScope: boolean;
+        resourceWorkingMemory: boolean;
+    };
+    private getTableName;
+    private getSchemaName;
+    private transformEvalRow;
+    /** @deprecated use getEvals instead */
+    getEvalsByAgentName(agentName: string, type?: 'test' | 'live'): Promise<EvalRow[]>;
+    batchInsert({ tableName, records }: {
+        tableName: TABLE_NAMES;
+        records: Record<string, any>[];
+    }): Promise<void>;
+    /** @deprecated use getTracesPaginated instead*/
+    getTraces(args: {
+        name?: string;
+        scope?: string;
+        attributes?: Record<string, string>;
+        filters?: Record<string, any>;
+        page: number;
+        perPage?: number;
+        fromDate?: Date;
+        toDate?: Date;
+    }): Promise<any[]>;
+    getTracesPaginated(args: {
+        name?: string;
+        scope?: string;
+        attributes?: Record<string, string>;
+        filters?: Record<string, any>;
+    } & PaginationArgs): Promise<PaginationInfo & {
+        traces: any[];
+    }>;
+    private setupSchema;
+    protected getSqlType(type: StorageColumn['type'], isPrimaryKey?: boolean): string;
+    createTable({ tableName, schema, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+    }): Promise<void>;
+    protected getDefaultValue(type: StorageColumn['type']): string;
+    alterTable({ tableName, schema, ifNotExists, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+        ifNotExists: string[];
+    }): Promise<void>;
+    clearTable({ tableName }: {
+        tableName: TABLE_NAMES;
+    }): Promise<void>;
+    insert({ tableName, record }: {
+        tableName: TABLE_NAMES;
+        record: Record<string, any>;
+    }): Promise<void>;
+    load<R>({ tableName, keys }: {
+        tableName: TABLE_NAMES;
+        keys: Record<string, string>;
+    }): Promise<R | null>;
+    getThreadById({ threadId }: {
+        threadId: string;
+    }): Promise<StorageThreadType | null>;
+    getThreadsByResourceIdPaginated(args: {
+        resourceId: string;
+    } & PaginationArgs): Promise<PaginationInfo & {
+        threads: StorageThreadType[];
+    }>;
+    saveThread({ thread }: {
+        thread: StorageThreadType;
+    }): Promise<StorageThreadType>;
+    /**
+     * @deprecated use getThreadsByResourceIdPaginated instead
+     */
+    getThreadsByResourceId(args: {
+        resourceId: string;
+    }): Promise<StorageThreadType[]>;
+    /**
+     * Updates a thread's title and metadata, merging with existing metadata. Returns the updated thread.
+     */
+    updateThread({ id, title, metadata, }: {
+        id: string;
+        title: string;
+        metadata: Record<string, unknown>;
+    }): Promise<StorageThreadType>;
+    deleteThread({ threadId }: {
+        threadId: string;
+    }): Promise<void>;
+    private _getIncludedMessages;
+    /**
+     * @deprecated use getMessagesPaginated instead
+     */
+    getMessages(args: StorageGetMessagesArg & {
+        format?: 'v1';
+    }): Promise<MastraMessageV1[]>;
+    getMessages(args: StorageGetMessagesArg & {
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    getMessagesPaginated(args: StorageGetMessagesArg & {
+        format?: 'v1' | 'v2';
+    }): Promise<PaginationInfo & {
+        messages: MastraMessageV1[] | MastraMessageV2[];
+    }>;
+    private _parseAndFormatMessages;
+    saveMessages(args: {
+        messages: MastraMessageV1[];
+        format?: undefined | 'v1';
+    }): Promise<MastraMessageV1[]>;
+    saveMessages(args: {
+        messages: MastraMessageV2[];
+        format: 'v2';
+    }): Promise<MastraMessageV2[]>;
+    persistWorkflowSnapshot({ workflowName, runId, snapshot, }: {
+        workflowName: string;
+        runId: string;
+        snapshot: WorkflowRunState;
+    }): Promise<void>;
+    loadWorkflowSnapshot({ workflowName, runId, }: {
+        workflowName: string;
+        runId: string;
+    }): Promise<WorkflowRunState | null>;
+    private hasColumn;
+    private parseWorkflowRun;
+    getWorkflowRuns({ workflowName, fromDate, toDate, limit, offset, resourceId, }?: {
+        workflowName?: string;
+        fromDate?: Date;
+        toDate?: Date;
+        limit?: number;
+        offset?: number;
+        resourceId?: string;
+    }): Promise<WorkflowRuns>;
+    getWorkflowRunById({ runId, workflowName, }: {
+        runId: string;
+        workflowName?: string;
+    }): Promise<WorkflowRun | null>;
+    updateMessages({ messages, }: {
+        messages: (Partial<Omit<MastraMessageV2, 'createdAt'>> & {
+            id: string;
+            content?: {
+                metadata?: MastraMessageContentV2['metadata'];
+                content?: MastraMessageContentV2['content'];
+            };
+        })[];
+    }): Promise<MastraMessageV2[]>;
+    close(): Promise<void>;
+    getEvals(options?: {
+        agentName?: string;
+        type?: 'test' | 'live';
+    } & PaginationArgs): Promise<PaginationInfo & {
+        evals: EvalRow[];
+    }>;
+    saveResource({ resource }: {
+        resource: StorageResourceType;
+    }): Promise<StorageResourceType>;
+    updateResource({ resourceId, workingMemory, metadata, }: {
+        resourceId: string;
+        workingMemory?: string;
+        metadata?: Record<string, unknown>;
+    }): Promise<StorageResourceType>;
+    getResourceById({ resourceId }: {
+        resourceId: string;
+    }): Promise<StorageResourceType | null>;
+}
+export { MSSQLStore }
+export { MSSQLStore as MSSQLStore_alias_1 }
+
+export { }