@mastra/clickhouse 0.2.7-alpha.1

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+> @mastra/clickhouse@0.2.7-alpha.1 build /home/runner/work/mastra/mastra/stores/clickhouse
+> 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.4.0
+TSC Build start
+TSC ⚡️ Build success in 8308ms
+DTS Build start
+CLI Target: es2022
+Analysis will use the bundled TypeScript version 5.8.2
+Writing package typings: /home/runner/work/mastra/mastra/stores/clickhouse/dist/_tsup-dts-rollup.d.ts
+Analysis will use the bundled TypeScript version 5.8.2
+Writing package typings: /home/runner/work/mastra/mastra/stores/clickhouse/dist/_tsup-dts-rollup.d.cts
+DTS ⚡️ Build success in 10391ms
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+ESM dist/index.js 19.85 KB
+ESM ⚡️ Build success in 754ms
+CJS dist/index.cjs 19.95 KB
+CJS ⚡️ Build success in 752ms

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @mastra/clickhouse
+
+## 0.2.7-alpha.1
+
+### Patch Changes
+
+- dbbbf80: Added clickhouse storage
+- Updated dependencies [56c31b7]
+- Updated dependencies [dbbbf80]
+- Updated dependencies [99d43b9]
+  - @mastra/core@0.8.0-alpha.2

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,122 @@
+# @mastra/clickhouse
+
+Clickhouse implementation for Mastra, providing efficient storage capabilities with support for threads, messages, and workflow snapshots.
+
+## Installation
+
+```bash
+npm install @mastra/clickhouse
+```
+
+## Prerequisites
+
+- Clickhouse server (version 21.8 or higher recommended)
+- Node.js 16 or higher
+
+## Usage
+
+```typescript
+import { ClickhouseStore } from '@mastra/clickhouse';
+
+const store = new ClickhouseStore({
+  url: 'http://localhost:8123',
+  username: 'default',
+  password: 'password',
+});
+
+// Create a thread
+await store.saveThread({
+  id: 'thread-123',
+  resourceId: 'resource-456',
+  title: 'My Thread',
+  metadata: { key: 'value' },
+  createdAt: new Date(),
+  updatedAt: new Date(),
+});
+
+// Add messages to thread
+await store.saveMessages([
+  {
+    id: 'msg-789',
+    threadId: 'thread-123',
+    role: 'user',
+    type: 'text',
+    content: [{ type: 'text', text: 'Hello' }],
+    createdAt: new Date(),
+  },
+]);
+
+// Query threads and messages
+const savedThread = await store.getThreadById({ threadId: 'thread-123' });
+const messages = await store.getMessages({ threadId: 'thread-123' });
+
+// Clean up
+await store.close();
+```
+
+## Configuration
+
+The Clickhouse store can be initialized with the following configuration:
+
+```typescript
+type ClickhouseConfig = {
+  url: string; // Clickhouse HTTP interface URL
+  username: string; // Database username
+  password: string; // Database password
+};
+```
+
+## Features
+
+### Storage Features
+
+- Thread and message storage with JSON support
+- Efficient batch operations
+- Rich metadata support
+- Timestamp tracking
+- Workflow snapshot persistence
+- Optimized for high-volume data ingestion
+- Uses Clickhouse's MergeTree and ReplacingMergeTree engines for optimal performance
+
+### Table Engines
+
+The store uses different table engines for different types of data:
+
+- `MergeTree()`: Used for messages, traces, and evals
+- `ReplacingMergeTree()`: Used for threads and workflow snapshots
+
+## Storage Methods
+
+### Thread Operations
+
+- `saveThread(thread)`: Create or update a thread
+- `getThreadById({ threadId })`: Get a thread by ID
+- `updateThread({ id, title, metadata })`: Update thread title and metadata
+- `deleteThread({ threadId })`: Delete a thread and its messages
+
+### Message Operations
+
+- `saveMessages(messages)`: Save multiple messages
+- `getMessages({ threadId, selectBy? })`: Get messages for a thread with optional filtering
+- `deleteMessages(messageIds)`: Delete specific messages
+
+### Workflow Operations
+
+- `persistWorkflowSnapshot({ workflowName, runId, snapshot })`: Save workflow state
+- `loadWorkflowSnapshot({ workflowName, runId })`: Load workflow state
+
+## Data Types
+
+The store supports the following data types:
+
+- `text`: String
+- `timestamp`: DateTime64(3)
+- `uuid`: String
+- `jsonb`: String (JSON serialized)
+- `integer`: Int64
+- `bigint`: Int64
+
+## Related Links
+
+- [Clickhouse Documentation](https://clickhouse.com/docs)
+- [Clickhouse Node.js Client](https://github.com/clickhouse/clickhouse-js)

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

@@ -0,0 +1,83 @@
+import type { EvalRow } from '@mastra/core/storage';
+import { MastraStorage } from '@mastra/core/storage';
+import type { MessageType } from '@mastra/core/memory';
+import type { StorageColumn } from '@mastra/core/storage';
+import type { StorageGetMessagesArg } from '@mastra/core/storage';
+import type { StorageThreadType } from '@mastra/core/memory';
+import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { WorkflowRunState } from '@mastra/core/workflows';
+
+declare type ClickhouseConfig = {
+    url: string;
+    username: string;
+    password: string;
+};
+export { ClickhouseConfig }
+export { ClickhouseConfig as ClickhouseConfig_alias_1 }
+
+declare class ClickhouseStore extends MastraStorage {
+    private db;
+    constructor(config: ClickhouseConfig);
+    getEvalsByAgentName(_agentName: string, _type?: 'test' | 'live'): Promise<EvalRow[]>;
+    batchInsert({ tableName, records }: {
+        tableName: TABLE_NAMES;
+        records: Record<string, any>[];
+    }): Promise<void>;
+    getTraces({ name, scope, page, perPage, attributes, }: {
+        name?: string;
+        scope?: string;
+        page: number;
+        perPage: number;
+        attributes?: Record<string, string>;
+    }): Promise<any[]>;
+    createTable({ tableName, schema, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+    }): 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>;
+    getThreadsByResourceId({ resourceId }: {
+        resourceId: string;
+    }): Promise<StorageThreadType[]>;
+    saveThread({ thread }: {
+        thread: StorageThreadType;
+    }): Promise<StorageThreadType>;
+    updateThread({ id, title, metadata, }: {
+        id: string;
+        title: string;
+        metadata: Record<string, unknown>;
+    }): Promise<StorageThreadType>;
+    deleteThread({ threadId }: {
+        threadId: string;
+    }): Promise<void>;
+    getMessages<T = unknown>({ threadId, selectBy }: StorageGetMessagesArg): Promise<T>;
+    saveMessages({ messages }: {
+        messages: MessageType[];
+    }): Promise<MessageType[]>;
+    persistWorkflowSnapshot({ workflowName, runId, snapshot, }: {
+        workflowName: string;
+        runId: string;
+        snapshot: WorkflowRunState;
+    }): Promise<void>;
+    loadWorkflowSnapshot({ workflowName, runId, }: {
+        workflowName: string;
+        runId: string;
+    }): Promise<WorkflowRunState | null>;
+    close(): Promise<void>;
+}
+export { ClickhouseStore }
+export { ClickhouseStore as ClickhouseStore_alias_1 }
+
+export { }

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

@@ -0,0 +1,83 @@
+import type { EvalRow } from '@mastra/core/storage';
+import { MastraStorage } from '@mastra/core/storage';
+import type { MessageType } from '@mastra/core/memory';
+import type { StorageColumn } from '@mastra/core/storage';
+import type { StorageGetMessagesArg } from '@mastra/core/storage';
+import type { StorageThreadType } from '@mastra/core/memory';
+import type { TABLE_NAMES } from '@mastra/core/storage';
+import type { WorkflowRunState } from '@mastra/core/workflows';
+
+declare type ClickhouseConfig = {
+    url: string;
+    username: string;
+    password: string;
+};
+export { ClickhouseConfig }
+export { ClickhouseConfig as ClickhouseConfig_alias_1 }
+
+declare class ClickhouseStore extends MastraStorage {
+    private db;
+    constructor(config: ClickhouseConfig);
+    getEvalsByAgentName(_agentName: string, _type?: 'test' | 'live'): Promise<EvalRow[]>;
+    batchInsert({ tableName, records }: {
+        tableName: TABLE_NAMES;
+        records: Record<string, any>[];
+    }): Promise<void>;
+    getTraces({ name, scope, page, perPage, attributes, }: {
+        name?: string;
+        scope?: string;
+        page: number;
+        perPage: number;
+        attributes?: Record<string, string>;
+    }): Promise<any[]>;
+    createTable({ tableName, schema, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+    }): 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>;
+    getThreadsByResourceId({ resourceId }: {
+        resourceId: string;
+    }): Promise<StorageThreadType[]>;
+    saveThread({ thread }: {
+        thread: StorageThreadType;
+    }): Promise<StorageThreadType>;
+    updateThread({ id, title, metadata, }: {
+        id: string;
+        title: string;
+        metadata: Record<string, unknown>;
+    }): Promise<StorageThreadType>;
+    deleteThread({ threadId }: {
+        threadId: string;
+    }): Promise<void>;
+    getMessages<T = unknown>({ threadId, selectBy }: StorageGetMessagesArg): Promise<T>;
+    saveMessages({ messages }: {
+        messages: MessageType[];
+    }): Promise<MessageType[]>;
+    persistWorkflowSnapshot({ workflowName, runId, snapshot, }: {
+        workflowName: string;
+        runId: string;
+        snapshot: WorkflowRunState;
+    }): Promise<void>;
+    loadWorkflowSnapshot({ workflowName, runId, }: {
+        workflowName: string;
+        runId: string;
+    }): Promise<WorkflowRunState | null>;
+    close(): Promise<void>;
+}
+export { ClickhouseStore }
+export { ClickhouseStore as ClickhouseStore_alias_1 }
+
+export { }