Skip to content

@codesoul-co/hypha-adapters-local / sqlite-artifact-record-repository

模块用法

用于持久化并读取该边界的数据。Sqlite artifact record repository 模块公开 1 类、1 接口。

从包入口导入

ts
import {
  SQLiteArtifactRecordRepository,
} from '@codesoul-co/hypha-adapters-local';

import type {
  SQLiteArtifactRecordRepositoryOptions,
} from '@codesoul-co/hypha-adapters-local';

使用要点

  • 1 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。
  • 1 个类提供可实例化的运行时实现;构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol种类签名说明
SQLiteArtifactRecordRepositorynew SQLiteArtifactRecordRepository(options: SQLiteArtifactRecordRepositoryOptions): SQLiteArtifactRecordRepositorySQLite Artifact Record Repository 类,共公开 14 个构造函数或成员;精确签名见本条目的声明与成员表。
SQLiteArtifactRecordRepositoryOptions接口interface SQLiteArtifactRecordRepositoryOptionsSQLite Artifact Record Repository Options 接口,共包含 5 个公开字段或方法。

SQLiteArtifactRecordRepository

SQLite Artifact Record Repository 类,共公开 14 个构造函数或成员;精确签名见本条目的声明与成员表。

声明

text
export declare class SQLiteArtifactRecordRepository implements ArtifactRecordRepository {
    readonly id: string;
    readonly filename: string;
    constructor(options: SQLiteArtifactRecordRepositoryOptions);
    get(artifactId: string, versionId?: string): Promise<StoredArtifactRecord | null>;
    getByVersionId(versionId: string): Promise<StoredArtifactRecord | null>;
    list(): Promise<StoredArtifactRecord[]>;
    findIdempotency(operationId: string, idempotencyKey: string): Promise<StoredArtifactRecord | null>;
    commit(request: ArtifactRecordCommitRequest): Promise<void>;
    listGarbageCollectionCandidates(request: ArtifactGarbageCollectionScanRequest): Promise<ArtifactGarbageCollectionCandidate[]>;
    claimGarbageCollection(request: ArtifactGarbageCollectionClaimRequest): Promise<boolean>;
    completeGarbageCollection(claimId: string, completedAt: string): Promise<void>;
    releaseGarbageCollection(claimId: string): Promise<void>;
    health(): Promise<ProviderHealth>;
    close(): Promise<void>;
}

公开成员

成员种类签名说明
claimGarbageCollection方法claimGarbageCollection(request: ArtifactGarbageCollectionClaimRequest): Promise<boolean>公开方法;参数与返回类型以签名列为准。
close方法close(): Promise<void>公开方法;参数与返回类型以签名列为准。
commit方法commit(request: ArtifactRecordCommitRequest): Promise<void>公开方法;参数与返回类型以签名列为准。
completeGarbageCollection方法completeGarbageCollection(claimId: string, completedAt: string): Promise<void>公开方法;参数与返回类型以签名列为准。
constructor构造函数(options: SQLiteArtifactRecordRepositoryOptions): SQLiteArtifactRecordRepository创建该类的实例。
filename属性readonly filename: string公开属性;类型、只读和可选状态以签名列为准。
findIdempotency方法findIdempotency(operationId: string, idempotencyKey: string): Promise<StoredArtifactRecord | null>公开方法;参数与返回类型以签名列为准。
get方法get(artifactId: string, versionId?: string): Promise<StoredArtifactRecord | null>公开方法;参数与返回类型以签名列为准。
getByVersionId方法getByVersionId(versionId: string): Promise<StoredArtifactRecord | null>公开方法;参数与返回类型以签名列为准。
health方法health(): Promise<ProviderHealth>公开方法;参数与返回类型以签名列为准。
id属性readonly id: string公开属性;类型、只读和可选状态以签名列为准。
list方法list(): Promise<StoredArtifactRecord[]>公开方法;参数与返回类型以签名列为准。
listGarbageCollectionCandidates方法listGarbageCollectionCandidates(request: ArtifactGarbageCollectionScanRequest): Promise<ArtifactGarbageCollectionCandidate[]>公开方法;参数与返回类型以签名列为准。
releaseGarbageCollection方法releaseGarbageCollection(claimId: string): Promise<void>公开方法;参数与返回类型以签名列为准。

SQLiteArtifactRecordRepositoryOptions

SQLite Artifact Record Repository Options 接口,共包含 5 个公开字段或方法。

声明

text
export interface SQLiteArtifactRecordRepositoryOptions {
    rootPath: string;
    filename?: string;
    id?: string;
    busyTimeoutMs?: number;
    now?: () => string;
}

契约成员

成员种类签名说明
busyTimeoutMs属性busyTimeoutMs?: number公开属性;类型、只读和可选状态以签名列为准。
filename属性filename?: string公开属性;类型、只读和可选状态以签名列为准。
id属性id?: string公开属性;类型、只读和可选状态以签名列为准。
now方法now?(): string公开方法;参数与返回类型以签名列为准。
rootPath属性rootPath: string公开属性;类型、只读和可选状态以签名列为准。