`@codesoul-co/hypha-storage` / `index`

模块用法

聚合 @codesoul-co/hypha-storage 的公共入口导出；应用应从包入口导入这些 Symbol，不应依赖内部文件路径。

从包入口导入

import {
  storageCapabilitySchema,
  storageConnectionSpecSchema,
  storageDeploymentModeSchema,
  storageEngineSchema,
  storageProviderKindSchema,
  storageProviderProfileDefinition,
  storageProviderProfileExample,
  storageProviderProfileJsonSchema,
} from '@codesoul-co/hypha-storage';

import type {
  ResolvedStorageConnection,
  StorageConnectionSpec,
  StorageProviderProfile,
  StorageSecretRef,
  StorageTopologySpec,
  EnvSource,
  StorageCapability,
  StorageDeploymentMode,
} from '@codesoul-co/hypha-storage';

// 完整导出列表见下方。

使用要点

12 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
17 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。
17 个常量/枚举提供稳定值、Schema、Definition 或默认配置；应复用这些导出，避免在应用中复制内部值。

运行时校验示例

import { storageCapabilitySchema } from '@codesoul-co/hypha-storage';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = storageCapabilitySchema.parse(input);

配置、网络请求或持久化数据等不可信输入应先通过 Runtime Schema，再传给只接受已校验契约的函数或类。

公共导出

Symbol	种类	签名	说明
`storageCapabilitySchema`	常量	`const storageCapabilitySchema: z.ZodEnum<["structured", "transactions", "events", "cache", "queue", "pubsub", "streams", "vector_search", "metadata_filter", "artifact_bytes", "managed_backup", "tls", "multi_region"]>`	Storage Capability 的运行时 Schema。
`storageConnectionSpecSchema`	常量	`const storageConnectionSpecSchema: z.ZodObject<{ uri: z.ZodOptional<z.ZodString>; uriEnv: z.ZodOptional<z.ZodString>; host: z.ZodOptional<z.ZodString>; port: z.ZodOptional<z.ZodNumber>; database: z.ZodOptional<z.ZodString>; username: z.ZodOptional<z.ZodString>; usernameEnv: z.ZodOptional<z.ZodString>; passwordEnv: z.ZodOptional<z.ZodString>; tls: z.ZodOptional<z.ZodBoolean>; region: z.ZodOptional<z.ZodString>; opt...`	Storage Connection Spec 的运行时 Schema。
`storageDeploymentModeSchema`	常量	`const storageDeploymentModeSchema: z.ZodEnum<["local", "self_hosted", "managed", "cloud"]>`	Storage Deployment Mode 的运行时 Schema。
`storageEngineSchema`	常量	`const storageEngineSchema: z.ZodEnum<["sqlite", "postgres", "mysql", "mongodb", "redis", "kafka", "local-vector", "pgvector", "qdrant", "milvus", "chroma", "pinecone", "weaviate", "file-artifact", "s3", "gcs", "azure-blob", "json"]>`	Storage Engine 的运行时 Schema。
`storageProviderKindSchema`	常量	`const storageProviderKindSchema: z.ZodEnum<["relational", "document", "messaging", "cache", "vector", "object", "event", "hybrid"]>`	Storage Provider Kind 的运行时 Schema。
`storageProviderProfileDefinition`	常量	`const storageProviderProfileDefinition: SpecSchemaDefinition<StorageProviderProfile>`	由 `index` 模块导出的 Storage Provider Profile Definition 常量。
`storageProviderProfileExample`	常量	`const storageProviderProfileExample: StorageProviderProfile`	Storage Provider Profile 的有效示例值。
`storageProviderProfileJsonSchema`	常量	`const storageProviderProfileJsonSchema: JsonSchema`	Storage Provider Profile 的 JSON Schema。
`storageProviderProfileSchema`	常量	`const storageProviderProfileSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { kind: z.ZodEnum<["relational", "document", "messaging", "cache", "vector",...`	Storage Provider Profile 的运行时 Schema。
`storageRoleSchema`	常量	`const storageRoleSchema: z.ZodEnum<["source_of_truth", "event_log", "semantic_index", "cache", "message_queue", "artifact_store", "document_store", "hybrid_memory"]>`	Storage Role 的运行时 Schema。
`storageSecretRefSchema`	常量	`const storageSecretRefSchema: z.ZodObject<{ env: z.ZodOptional<z.ZodString>; secretRef: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { env?: string \| undefined; secretRef?: string \| undefined; }, { env?: string \| undefined; secretRef?: string \| undefined; }>`	Storage Secret Ref 的运行时 Schema。
`storageSpecDefinitions`	常量	`const storageSpecDefinitions: readonly [SpecSchemaDefinition<StorageProviderProfile>, SpecSchemaDefinition<StorageTopologySpec>]`	由 `index` 模块导出的 Storage Spec Definitions 常量。
`storageSpecJsonSchemas`	常量	`const storageSpecJsonSchemas: Record<string, JsonSchema>`	由 `index` 模块导出的 Storage Spec JSON Schemas 常量。
`storageTopologySpecDefinition`	常量	`const storageTopologySpecDefinition: SpecSchemaDefinition<StorageTopologySpec>`	Storage Topology Spec 的运行时校验入口，组合 Parser、Example 与 JSON Schema。
`storageTopologySpecExample`	常量	`const storageTopologySpecExample: StorageTopologySpec`	Storage Topology Spec 的有效示例值。
`storageTopologySpecJsonSchema`	常量	`const storageTopologySpecJsonSchema: JsonSchema`	Storage Topology Spec 的 JSON Schema。
`storageTopologySpecSchema`	常量	`const storageTopologySpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { providers: z.ZodArray<z.ZodObject<{ id: z.ZodString; version: z.ZodString; } ...`	Storage Topology Spec 的运行时 Schema。
`assertStorageCapability`	函数	`assertStorageCapability(profile: StorageProviderProfile, capability: StorageCapability): void`	Assert Storage Capability 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createChromaStorageProfile`	函数	`createChromaStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile`	Create Chroma Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createFileArtifactStorageProfile`	函数	`createFileArtifactStorageProfile(input?: { id?: string; uri?: string; rootPath?: string; }): StorageProviderProfile`	Create File Artifact Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createKafkaStorageProfile`	函数	`createKafkaStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; tls?: boolean; region?: string; }): StorageProviderProfile`	Create Kafka Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createLocalVectorStorageProfile`	函数	`createLocalVectorStorageProfile(input?: { id?: string; uri?: string; database?: string; }): StorageProviderProfile`	Create Local Vector Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createMongoStorageProfile`	函数	`createMongoStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile`	Create Mongo Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createPineconeStorageProfile`	函数	`createPineconeStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile`	Create Pinecone Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createQdrantStorageProfile`	函数	`createQdrantStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile`	Create Qdrant Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createRedisStorageProfile`	函数	`createRedisStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile`	Create Redis Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createSQLiteStorageProfile`	函数	`createSQLiteStorageProfile(input?: { id?: string; role?: Extract<StorageRole, "source_of_truth" \| "event_log">; uri?: string; database?: string; }): StorageProviderProfile`	Create SQLite Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createVectorStorageProfile`	函数	`createVectorStorageProfile(input: { engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }): StorageProviderProfile`	Create Vector Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`createWeaviateStorageProfile`	函数	`createWeaviateStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile`	Create Weaviate Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`inferStorageDeployment`	函数	`inferStorageDeployment(profile: StorageProviderProfile, uri?: string): StorageDeploymentMode`	Infer Storage Deployment 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`redactStorageConnection`	函数	`redactStorageConnection(connection: ResolvedStorageConnection): ResolvedStorageConnection`	Redact Storage Connection 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`resolveStorageConnection`	函数	`resolveStorageConnection(profile: StorageProviderProfile, env?: EnvSource): ResolvedStorageConnection`	Resolve Storage Connection 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`validateStorageProviderProfile`	函数	`validateStorageProviderProfile(input: unknown): StorageProviderProfile`	Validate Storage Provider Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`validateStorageTopologySpec`	函数	`validateStorageTopologySpec(input: unknown): StorageTopologySpec`	Validate Storage Topology Spec 函数，提供 1 个公开调用签名；参数与返回类型见下表。
`ResolvedStorageConnection`	接口	`interface ResolvedStorageConnection`	Resolved Storage Connection 接口，共包含 12 个公开字段或方法。
`StorageConnectionSpec`	接口	`interface StorageConnectionSpec`	Storage Connection Spec 接口，共包含 11 个公开字段或方法。
`StorageProviderProfile`	接口	`interface StorageProviderProfile extends VersionedSpec, SpecMetadata`	Storage Provider Profile 接口，共包含 17 个公开字段或方法。
`StorageSecretRef`	接口	`interface StorageSecretRef`	Storage Secret Ref 接口，共包含 2 个公开字段或方法。
`StorageTopologySpec`	接口	`interface StorageTopologySpec extends VersionedSpec, SpecMetadata`	Storage Topology Spec 接口，共包含 10 个公开字段或方法。
`EnvSource`	类型	`type EnvSource = Record<string, string \| undefined>`	Env Source 公共类型别名；完整类型表达式见声明。
`StorageCapability`	类型	`type StorageCapability = 'structured' \| 'transactions' \| 'events' \| 'cache' \| 'queue' \| 'pubsub' \| 'streams' \| 'vector_search' \| 'metadata_filter' \| 'artifact_bytes' \| 'managed_backup' \| 'tls' \| 'multi_region'`	Storage Capability 公共类型别名；完整类型表达式见声明。
`StorageDeploymentMode`	类型	`type StorageDeploymentMode = 'local' \| 'self_hosted' \| 'managed' \| 'cloud'`	Storage Deployment Mode 公共类型别名；完整类型表达式见声明。
`StorageEngine`	类型	`type StorageEngine = 'sqlite' \| 'postgres' \| 'mysql' \| 'mongodb' \| 'redis' \| 'kafka' \| 'local-vector' \| 'pgvector' \| 'qdrant' \| 'milvus' \| 'chroma' \| 'pinecone' \| 'weaviate' \| 'file-artifact' \| 's3' \| 'gcs' \| 'azure-blob' \| 'json'`	Storage Engine 公共类型别名；完整类型表达式见声明。
`StorageProviderKind`	类型	`type StorageProviderKind = 'relational' \| 'document' \| 'messaging' \| 'cache' \| 'vector' \| 'object' \| 'event' \| 'hybrid'`	Storage Provider Kind 公共类型别名；完整类型表达式见声明。
`StorageRole`	类型	`type StorageRole = 'source_of_truth' \| 'event_log' \| 'semantic_index' \| 'cache' \| 'message_queue' \| 'artifact_store' \| 'document_store' \| 'hybrid_memory'`	Storage Role 公共类型别名；完整类型表达式见声明。
`VectorStorageEngine`	类型	`type VectorStorageEngine = Extract<StorageEngine, 'pgvector' \| 'qdrant' \| 'milvus' \| 'chroma' \| 'pinecone' \| 'weaviate'>`	Vector Storage Engine 公共类型别名；完整类型表达式见声明。

`storageCapabilitySchema`

Storage Capability 的运行时 Schema。

种类: 常量
导入: import { storageCapabilitySchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageCapabilitySchema: z.ZodEnum<["structured", "transactions", "events", "cache", "queue", "pubsub", "streams", "vector_search", "metadata_filter", "artifact_bytes", "managed_backup", "tls", "multi_region"]>;

`storageConnectionSpecSchema`

Storage Connection Spec 的运行时 Schema。

种类: 常量
导入: import { storageConnectionSpecSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageConnectionSpecSchema: z.ZodObject<{ uri: z.ZodOptional<z.ZodString>; uriEnv: z.ZodOptional<z.ZodString>; host: z.ZodOptional<z.ZodString>; port: z.ZodOptional<z.ZodNumber>; database: z.ZodOptional<z.ZodString>; username: z.ZodOptional<z.ZodString>; usernameEnv: z.ZodOptional<z.ZodString>; passwordEnv: z.ZodOptional<z.ZodString>; tls: z.ZodOptional<z.ZodBoolean>; region: z.ZodOptional<z.ZodString>; options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strip", z.ZodTypeAny, { tls?: boolean | undefined; options?: Record<string, unknown> | undefined; uri?: string | undefined; uriEnv?: string | undefined; host?: string | undefined; port?: number | undefined; database?: string | undefined; username?: string | undefined; usernameEnv?: string | undefined; passwordEnv?: string | undefined; region?: string | undefined; }, { tls?: boolean | undefined; options?: Record<string, unknown> | undefined; uri?: string | undefined; uriEnv?: string | undefined; host?: string | undefined; port?: number | undefined; database?: string | undefined; username?: string | undefined; usernameEnv?: string | undefined; passwordEnv?: string | undefined; region?: string | undefined; }>;

`storageDeploymentModeSchema`

Storage Deployment Mode 的运行时 Schema。

种类: 常量
导入: import { storageDeploymentModeSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageDeploymentModeSchema: z.ZodEnum<["local", "self_hosted", "managed", "cloud"]>;

`storageEngineSchema`

Storage Engine 的运行时 Schema。

种类: 常量
导入: import { storageEngineSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageEngineSchema: z.ZodEnum<["sqlite", "postgres", "mysql", "mongodb", "redis", "kafka", "local-vector", "pgvector", "qdrant", "milvus", "chroma", "pinecone", "weaviate", "file-artifact", "s3", "gcs", "azure-blob", "json"]>;

`storageProviderKindSchema`

Storage Provider Kind 的运行时 Schema。

种类: 常量
导入: import { storageProviderKindSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageProviderKindSchema: z.ZodEnum<["relational", "document", "messaging", "cache", "vector", "object", "event", "hybrid"]>;

`storageProviderProfileDefinition`

由 index 模块导出的 Storage Provider Profile Definition 常量。

种类: 常量
导入: import { storageProviderProfileDefinition } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageProviderProfileDefinition: SpecSchemaDefinition<StorageProviderProfile>;

`storageProviderProfileExample`

Storage Provider Profile 的有效示例值。

种类: 常量
导入: import { storageProviderProfileExample } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageProviderProfileExample: StorageProviderProfile;

`storageProviderProfileJsonSchema`

Storage Provider Profile 的 JSON Schema。

种类: 常量
导入: import { storageProviderProfileJsonSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageProviderProfileJsonSchema: JsonSchema;

`storageProviderProfileSchema`

Storage Provider Profile 的运行时 Schema。

种类: 常量
导入: import { storageProviderProfileSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

// 精确类型由包入口解析；完整编译器展开定义见源码链接。
export declare const storageProviderProfileSchema: (typeof import('@codesoul-co/hypha-storage'))['storageProviderProfileSchema'];

该常量的编译器展开类型已压缩；它的公共名称、顶层类型与源码位置仍保留在本条目中。相关输入/输出字段请使用同模块导出的接口、类型或 Runtime Schema。

`storageRoleSchema`

Storage Role 的运行时 Schema。

种类: 常量
导入: import { storageRoleSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageRoleSchema: z.ZodEnum<["source_of_truth", "event_log", "semantic_index", "cache", "message_queue", "artifact_store", "document_store", "hybrid_memory"]>;

`storageSecretRefSchema`

Storage Secret Ref 的运行时 Schema。

种类: 常量
导入: import { storageSecretRefSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageSecretRefSchema: z.ZodObject<{ env: z.ZodOptional<z.ZodString>; secretRef: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { env?: string | undefined; secretRef?: string | undefined; }, { env?: string | undefined; secretRef?: string | undefined; }>;

`storageSpecDefinitions`

由 index 模块导出的 Storage Spec Definitions 常量。

种类: 常量
导入: import { storageSpecDefinitions } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageSpecDefinitions: readonly [SpecSchemaDefinition<StorageProviderProfile>, SpecSchemaDefinition<StorageTopologySpec>];

`storageSpecJsonSchemas`

由 index 模块导出的 Storage Spec JSON Schemas 常量。

种类: 常量
导入: import { storageSpecJsonSchemas } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageSpecJsonSchemas: Record<string, JsonSchema>;

`storageTopologySpecDefinition`

Storage Topology Spec 的运行时校验入口，组合 Parser、Example 与 JSON Schema。

种类: 常量
导入: import { storageTopologySpecDefinition } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageTopologySpecDefinition: SpecSchemaDefinition<StorageTopologySpec>;

`storageTopologySpecExample`

Storage Topology Spec 的有效示例值。

种类: 常量
导入: import { storageTopologySpecExample } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageTopologySpecExample: StorageTopologySpec;

`storageTopologySpecJsonSchema`

Storage Topology Spec 的 JSON Schema。

种类: 常量
导入: import { storageTopologySpecJsonSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare const storageTopologySpecJsonSchema: JsonSchema;

`storageTopologySpecSchema`

Storage Topology Spec 的运行时 Schema。

种类: 常量
导入: import { storageTopologySpecSchema } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

// 精确类型由包入口解析；完整编译器展开定义见源码链接。
export declare const storageTopologySpecSchema: (typeof import('@codesoul-co/hypha-storage'))['storageTopologySpecSchema'];

该常量的编译器展开类型已压缩；它的公共名称、顶层类型与源码位置仍保留在本条目中。相关输入/输出字段请使用同模块导出的接口、类型或 Runtime Schema。

`assertStorageCapability`

Assert Storage Capability 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { assertStorageCapability } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function assertStorageCapability(profile: StorageProviderProfile, capability: StorageCapability): void;

调用签名

text

assertStorageCapability(profile: StorageProviderProfile, capability: StorageCapability): void

参数

参数	类型	必需	说明
`profile`	`StorageProviderProfile`	是	必需参数；接受的值由类型列定义。
`capability`	`StorageCapability`	是	必需参数；接受的值由类型列定义。

返回值

类型: void
说明: 不返回值。

`createChromaStorageProfile`

Create Chroma Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createChromaStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createChromaStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

调用签名

text

createChromaStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createFileArtifactStorageProfile`

Create File Artifact Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createFileArtifactStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createFileArtifactStorageProfile(input?: {
    id?: string;
    uri?: string;
    rootPath?: string;
}): StorageProviderProfile;

调用签名

text

createFileArtifactStorageProfile(input?: { id?: string; uri?: string; rootPath?: string; }): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`{ id?: string; uri?: string; rootPath?: string; }`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createKafkaStorageProfile`

Create Kafka Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createKafkaStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createKafkaStorageProfile(input?: {
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    tls?: boolean;
    region?: string;
}): StorageProviderProfile;

调用签名

text

createKafkaStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; tls?: boolean; region?: string; }): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`{ id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; tls?: boolean; region?: string; }`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createLocalVectorStorageProfile`

Create Local Vector Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createLocalVectorStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createLocalVectorStorageProfile(input?: {
    id?: string;
    uri?: string;
    database?: string;
}): StorageProviderProfile;

调用签名

text

createLocalVectorStorageProfile(input?: { id?: string; uri?: string; database?: string; }): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`{ id?: string; uri?: string; database?: string; }`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createMongoStorageProfile`

Create Mongo Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createMongoStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createMongoStorageProfile(input?: {
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    database?: string;
    tls?: boolean;
}): StorageProviderProfile;

调用签名

text

createMongoStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`{ id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createPineconeStorageProfile`

Create Pinecone Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createPineconeStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createPineconeStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

调用签名

text

createPineconeStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createQdrantStorageProfile`

Create Qdrant Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createQdrantStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createQdrantStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

调用签名

text

createQdrantStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createRedisStorageProfile`

Create Redis Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createRedisStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createRedisStorageProfile(input?: {
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    database?: string;
    tls?: boolean;
}): StorageProviderProfile;

调用签名

text

createRedisStorageProfile(input?: { id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`{ id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; }`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createSQLiteStorageProfile`

Create SQLite Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createSQLiteStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createSQLiteStorageProfile(input?: {
    id?: string;
    role?: Extract<StorageRole, 'source_of_truth' | 'event_log'>;
    uri?: string;
    database?: string;
}): StorageProviderProfile;

调用签名

text

createSQLiteStorageProfile(input?: { id?: string; role?: Extract<StorageRole, "source_of_truth" | "event_log">; uri?: string; database?: string; }): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`{ id?: string; role?: Extract<StorageRole, "source_of_truth" \| "event_log">; uri?: string; database?: string; }`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createVectorStorageProfile`

Create Vector Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createVectorStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createVectorStorageProfile(input: {
    engine: VectorStorageEngine;
    id?: string;
    deployment?: StorageDeploymentMode;
    uriEnv?: string;
    uri?: string;
    host?: string;
    port?: number;
    database?: string;
    tls?: boolean;
    region?: string;
    apiKeyEnv?: string;
    options?: Record<string, unknown>;
}): StorageProviderProfile;

调用签名

text

createVectorStorageProfile(input: { engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }`	是	必需参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`createWeaviateStorageProfile`

Create Weaviate Storage Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { createWeaviateStorageProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function createWeaviateStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], 'engine'>): StorageProviderProfile;

调用签名

text

createWeaviateStorageProfile(input?: Omit<Parameters<typeof createVectorStorageProfile>[0], "engine">): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`Omit<{ engine: VectorStorageEngine; id?: string; deployment?: StorageDeploymentMode; uriEnv?: string; uri?: string; host?: string; port?: number; database?: string; tls?: boolean; region?: string; apiKeyEnv?: string; options?: Record<string, unknown>; }, "engine">`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`inferStorageDeployment`

Infer Storage Deployment 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { inferStorageDeployment } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function inferStorageDeployment(profile: StorageProviderProfile, uri?: string): StorageDeploymentMode;

调用签名

text

inferStorageDeployment(profile: StorageProviderProfile, uri?: string): StorageDeploymentMode

参数

参数	类型	必需	说明
`profile`	`StorageProviderProfile`	是	必需参数；接受的值由类型列定义。
`uri`	`string`	否	可选参数；接受的值由类型列定义。

返回值

类型: StorageDeploymentMode
说明: 返回值契约由上述类型定义。

`redactStorageConnection`

Redact Storage Connection 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { redactStorageConnection } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function redactStorageConnection(connection: ResolvedStorageConnection): ResolvedStorageConnection;

调用签名

text

redactStorageConnection(connection: ResolvedStorageConnection): ResolvedStorageConnection

参数

参数	类型	必需	说明
`connection`	`ResolvedStorageConnection`	是	必需参数；接受的值由类型列定义。

返回值

类型: ResolvedStorageConnection
说明: 返回值契约由上述类型定义。

`resolveStorageConnection`

Resolve Storage Connection 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { resolveStorageConnection } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function resolveStorageConnection(profile: StorageProviderProfile, env?: EnvSource): ResolvedStorageConnection;

调用签名

text

resolveStorageConnection(profile: StorageProviderProfile, env?: EnvSource): ResolvedStorageConnection

参数

参数	类型	必需	说明
`profile`	`StorageProviderProfile`	是	必需参数；接受的值由类型列定义。
`env`	`EnvSource`	否	可选参数；接受的值由类型列定义。

返回值

类型: ResolvedStorageConnection
说明: 返回值契约由上述类型定义。

`validateStorageProviderProfile`

Validate Storage Provider Profile 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { validateStorageProviderProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function validateStorageProviderProfile(input: unknown): StorageProviderProfile;

调用签名

text

validateStorageProviderProfile(input: unknown): StorageProviderProfile

参数

参数	类型	必需	说明
`input`	`unknown`	是	必需参数；接受的值由类型列定义。

返回值

类型: StorageProviderProfile
说明: 返回值契约由上述类型定义。

`validateStorageTopologySpec`

Validate Storage Topology Spec 函数，提供 1 个公开调用签名；参数与返回类型见下表。

种类: 函数
导入: import { validateStorageTopologySpec } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export declare function validateStorageTopologySpec(input: unknown): StorageTopologySpec;

调用签名

text

validateStorageTopologySpec(input: unknown): StorageTopologySpec

参数

参数	类型	必需	说明
`input`	`unknown`	是	必需参数；接受的值由类型列定义。

返回值

类型: StorageTopologySpec
说明: 返回值契约由上述类型定义。

`ResolvedStorageConnection`

Resolved Storage Connection 接口，共包含 12 个公开字段或方法。

种类: 接口
导入: import type { ResolvedStorageConnection } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export interface ResolvedStorageConnection {
    profileId: string;
    engine: StorageEngine;
    deployment: StorageDeploymentMode;
    uri?: string;
    uriSource?: 'env' | 'inline' | 'composed';
    host?: string;
    port?: number;
    database?: string;
    username?: string;
    tls?: boolean;
    region?: string;
    options?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`database`	属性	`database?: string`	公开属性；类型、只读和可选状态以签名列为准。
`deployment`	属性	`deployment: StorageDeploymentMode`	公开属性；类型、只读和可选状态以签名列为准。
`engine`	属性	`engine: StorageEngine`	公开属性；类型、只读和可选状态以签名列为准。
`host`	属性	`host?: string`	公开属性；类型、只读和可选状态以签名列为准。
`options`	属性	`options?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`port`	属性	`port?: number`	公开属性；类型、只读和可选状态以签名列为准。
`profileId`	属性	`profileId: string`	公开属性；类型、只读和可选状态以签名列为准。
`region`	属性	`region?: string`	公开属性；类型、只读和可选状态以签名列为准。
`tls`	属性	`tls?: boolean`	公开属性；类型、只读和可选状态以签名列为准。
`uri`	属性	`uri?: string`	公开属性；类型、只读和可选状态以签名列为准。
`uriSource`	属性	`uriSource?: "env" \| "inline" \| "composed"`	公开属性；类型、只读和可选状态以签名列为准。
`username`	属性	`username?: string`	公开属性；类型、只读和可选状态以签名列为准。

`StorageConnectionSpec`

Storage Connection Spec 接口，共包含 11 个公开字段或方法。

种类: 接口
导入: import type { StorageConnectionSpec } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export interface StorageConnectionSpec {
    uri?: string;
    uriEnv?: string;
    host?: string;
    port?: number;
    database?: string;
    username?: string;
    usernameEnv?: string;
    passwordEnv?: string;
    tls?: boolean;
    region?: string;
    options?: Record<string, unknown>;
}

契约成员

成员	种类	签名	说明
`database`	属性	`database?: string`	公开属性；类型、只读和可选状态以签名列为准。
`host`	属性	`host?: string`	公开属性；类型、只读和可选状态以签名列为准。
`options`	属性	`options?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`passwordEnv`	属性	`passwordEnv?: string`	公开属性；类型、只读和可选状态以签名列为准。
`port`	属性	`port?: number`	公开属性；类型、只读和可选状态以签名列为准。
`region`	属性	`region?: string`	公开属性；类型、只读和可选状态以签名列为准。
`tls`	属性	`tls?: boolean`	公开属性；类型、只读和可选状态以签名列为准。
`uri`	属性	`uri?: string`	公开属性；类型、只读和可选状态以签名列为准。
`uriEnv`	属性	`uriEnv?: string`	公开属性；类型、只读和可选状态以签名列为准。
`username`	属性	`username?: string`	公开属性；类型、只读和可选状态以签名列为准。
`usernameEnv`	属性	`usernameEnv?: string`	公开属性；类型、只读和可选状态以签名列为准。

`StorageProviderProfile`

Storage Provider Profile 接口，共包含 17 个公开字段或方法。

种类: 接口
导入: import type { StorageProviderProfile } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export interface StorageProviderProfile extends VersionedSpec, SpecMetadata {
    kind: StorageProviderKind;
    engine: StorageEngine;
    deployment: StorageDeploymentMode;
    role: StorageRole;
    connection?: StorageConnectionSpec;
    capabilities?: StorageCapability[];
    consistency?: 'strong' | 'eventual';
    secrets?: {
        apiKey?: StorageSecretRef;
        username?: StorageSecretRef;
        password?: StorageSecretRef;
        token?: StorageSecretRef;
    };
    configSchema?: JsonSchema;
}

契约成员

成员	种类	签名	说明
`capabilities`	属性	`capabilities?: StorageCapability[]`	公开属性；类型、只读和可选状态以签名列为准。
`configSchema`	属性	`configSchema?: JsonSchema`	公开属性；类型、只读和可选状态以签名列为准。
`connection`	属性	`connection?: StorageConnectionSpec`	公开属性；类型、只读和可选状态以签名列为准。
`consistency`	属性	`consistency?: "strong" \| "eventual"`	公开属性；类型、只读和可选状态以签名列为准。
`createdAt`	属性	`createdAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`deployment`	属性	`deployment: StorageDeploymentMode`	公开属性；类型、只读和可选状态以签名列为准。
`description`	属性	`description?: string`	公开属性；类型、只读和可选状态以签名列为准。
`engine`	属性	`engine: StorageEngine`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`kind`	属性	`kind: StorageProviderKind`	公开属性；类型、只读和可选状态以签名列为准。
`name`	属性	`name?: string`	公开属性；类型、只读和可选状态以签名列为准。
`owner`	属性	`owner?: string`	公开属性；类型、只读和可选状态以签名列为准。
`role`	属性	`role: StorageRole`	公开属性；类型、只读和可选状态以签名列为准。
`secrets`	属性	`secrets?: { apiKey?: StorageSecretRef; username?: StorageSecretRef; password?: StorageSecretRef; token?: StorageSecretRef; }`	公开属性；类型、只读和可选状态以签名列为准。
`tags`	属性	`tags?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`updatedAt`	属性	`updatedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`version`	属性	`version: string`	公开属性；类型、只读和可选状态以签名列为准。

`StorageSecretRef`

Storage Secret Ref 接口，共包含 2 个公开字段或方法。

种类: 接口
导入: import type { StorageSecretRef } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export interface StorageSecretRef {
    env?: string;
    secretRef?: string;
}

契约成员

成员	种类	签名	说明
`env`	属性	`env?: string`	公开属性；类型、只读和可选状态以签名列为准。
`secretRef`	属性	`secretRef?: string`	公开属性；类型、只读和可选状态以签名列为准。

`StorageTopologySpec`

Storage Topology Spec 接口，共包含 10 个公开字段或方法。

种类: 接口
导入: import type { StorageTopologySpec } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export interface StorageTopologySpec extends VersionedSpec, SpecMetadata {
    providers: StorageProviderProfile[];
    defaults: {
        relationalRef?: SpecRef;
        documentRef?: SpecRef;
        messagingRef?: SpecRef;
        cacheRef?: SpecRef;
        vectorRef?: SpecRef;
        artifactRef?: SpecRef;
        eventRef?: SpecRef;
        memoryRef?: SpecRef;
    };
}

契约成员

成员	种类	签名	说明
`createdAt`	属性	`createdAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`defaults`	属性	`defaults: { relationalRef?: SpecRef; documentRef?: SpecRef; messagingRef?: SpecRef; cacheRef?: SpecRef; vectorRef?: SpecRef; artifactRef?: SpecRef; eventRef?: SpecRef; memoryRef?: SpecRef; }`	公开属性；类型、只读和可选状态以签名列为准。
`description`	属性	`description?: string`	公开属性；类型、只读和可选状态以签名列为准。
`id`	属性	`id: string`	公开属性；类型、只读和可选状态以签名列为准。
`name`	属性	`name?: string`	公开属性；类型、只读和可选状态以签名列为准。
`owner`	属性	`owner?: string`	公开属性；类型、只读和可选状态以签名列为准。
`providers`	属性	`providers: StorageProviderProfile[]`	公开属性；类型、只读和可选状态以签名列为准。
`tags`	属性	`tags?: string[]`	公开属性；类型、只读和可选状态以签名列为准。
`updatedAt`	属性	`updatedAt?: string`	公开属性；类型、只读和可选状态以签名列为准。
`version`	属性	`version: string`	公开属性；类型、只读和可选状态以签名列为准。

`EnvSource`

Env Source 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { EnvSource } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export type EnvSource = Record<string, string | undefined>;

`StorageCapability`

Storage Capability 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { StorageCapability } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export type StorageCapability = 'structured' | 'transactions' | 'events' | 'cache' | 'queue' | 'pubsub' | 'streams' | 'vector_search' | 'metadata_filter' | 'artifact_bytes' | 'managed_backup' | 'tls' | 'multi_region';

`StorageDeploymentMode`

Storage Deployment Mode 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { StorageDeploymentMode } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export type StorageDeploymentMode = 'local' | 'self_hosted' | 'managed' | 'cloud';

`StorageEngine`

Storage Engine 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { StorageEngine } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export type StorageEngine = 'sqlite' | 'postgres' | 'mysql' | 'mongodb' | 'redis' | 'kafka' | 'local-vector' | 'pgvector' | 'qdrant' | 'milvus' | 'chroma' | 'pinecone' | 'weaviate' | 'file-artifact' | 's3' | 'gcs' | 'azure-blob' | 'json';

`StorageProviderKind`

Storage Provider Kind 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { StorageProviderKind } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export type StorageProviderKind = 'relational' | 'document' | 'messaging' | 'cache' | 'vector' | 'object' | 'event' | 'hybrid';

`StorageRole`

Storage Role 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { StorageRole } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export type StorageRole = 'source_of_truth' | 'event_log' | 'semantic_index' | 'cache' | 'message_queue' | 'artifact_store' | 'document_store' | 'hybrid_memory';

`VectorStorageEngine`

Vector Storage Engine 公共类型别名；完整类型表达式见声明。

种类: 类型
导入: import type { VectorStorageEngine } from '@codesoul-co/hypha-storage';
源码模块: index

声明

text

export type VectorStorageEngine = Extract<StorageEngine, 'pgvector' | 'qdrant' | 'milvus' | 'chroma' | 'pinecone' | 'weaviate'>;

@codesoul-co/hypha-storage / index ​

模块用法 ​

从包入口导入 ​

使用要点 ​

运行时校验示例 ​

公共导出 ​

storageCapabilitySchema ​

声明 ​

storageConnectionSpecSchema ​

声明 ​

storageDeploymentModeSchema ​

声明 ​

storageEngineSchema ​

声明 ​

storageProviderKindSchema ​

声明 ​

storageProviderProfileDefinition ​

声明 ​

storageProviderProfileExample ​

声明 ​

storageProviderProfileJsonSchema ​

声明 ​

storageProviderProfileSchema ​

声明 ​

storageRoleSchema ​

声明 ​

storageSecretRefSchema ​

声明 ​

storageSpecDefinitions ​

声明 ​

storageSpecJsonSchemas ​

声明 ​

storageTopologySpecDefinition ​

声明 ​

storageTopologySpecExample ​

声明 ​

storageTopologySpecJsonSchema ​

声明 ​

storageTopologySpecSchema ​

声明 ​

assertStorageCapability ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createChromaStorageProfile ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createFileArtifactStorageProfile ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createKafkaStorageProfile ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createLocalVectorStorageProfile ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createMongoStorageProfile ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createPineconeStorageProfile ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

createQdrantStorageProfile ​

声明 ​

调用签名 ​

参数 ​

返回值 ​

`@codesoul-co/hypha-storage` / `index`

模块用法

从包入口导入

使用要点

运行时校验示例

公共导出

`storageCapabilitySchema`

声明

`storageConnectionSpecSchema`

声明

`storageDeploymentModeSchema`

声明

`storageEngineSchema`

声明

`storageProviderKindSchema`

声明

`storageProviderProfileDefinition`

声明

`storageProviderProfileExample`

声明

`storageProviderProfileJsonSchema`

声明

`storageProviderProfileSchema`

声明

`storageRoleSchema`

声明

`storageSecretRefSchema`

声明

`storageSpecDefinitions`

声明

`storageSpecJsonSchemas`

声明

`storageTopologySpecDefinition`

声明

`storageTopologySpecExample`

声明

`storageTopologySpecJsonSchema`

声明

`storageTopologySpecSchema`

声明

`assertStorageCapability`

声明

调用签名

参数

返回值

`createChromaStorageProfile`

声明

调用签名

参数

返回值

`createFileArtifactStorageProfile`

声明

调用签名

参数

返回值

`createKafkaStorageProfile`

声明

调用签名

参数

返回值

`createLocalVectorStorageProfile`

声明

调用签名

参数

返回值

`createMongoStorageProfile`

声明

调用签名

参数

返回值

`createPineconeStorageProfile`

声明

调用签名

参数

返回值

`createQdrantStorageProfile`

声明

调用签名

参数

返回值