PineconeRepository

A Mantle VectorRepository<T> implementation backed by a Pinecone vector index.

Records are stored as Pinecone vectors. The idField value is the Pinecone record ID; all other fields are stored in the vector metadata. Call upsertVector to attach a real embedding — save / saveAll insert a zero vector placeholder that is later replaced.

Type Parameters

T

T extends Record<string, unknown>

The entity shape. Must extend Record<string, unknown>.

D

D = Partial<T>

The write shape (defaults to Partial<T>).

Implements

VectorRepository<T, D>

Constructors

Constructor

new PineconeRepository<T, D>(app): PineconeRepository<T, D>

Defined in: pinecone-repository.ts:51

Parameters

app

MantleApplication

Returns

PineconeRepository<T, D>

Properties

client

protected readonly client: Pinecone

Defined in: pinecone-repository.ts:25

createdAtField

readonly createdAtField: string = "createdAt"

Defined in: pinecone-repository.ts:39

Metadata key written for auto-managed creation timestamps.

Default

"createdAt"

fieldMap

readonly fieldMap: Record<string, string> = {}

Defined in: pinecone-repository.ts:47

Entity-field-to-metadata-key overrides, for an index whose metadata keys don’t match the entity (e.g. a brownfield index using snake_case). Does not apply to idField — the record id is never stored in metadata.

Default

{}

idField

readonly idField: string = "id"

Defined in: pinecone-repository.ts:35

The metadata key that holds the record id.

Default

"id"

indexName

abstract readonly indexName: string

Defined in: pinecone-repository.ts:28

The Pinecone index name to target.

namespace

abstract readonly namespace: string

Defined in: pinecone-repository.ts:30

The namespace within the index.

timestamps

readonly timestamps: boolean = true

Defined in: pinecone-repository.ts:37

When true, save / saveAll / updateById / patchById write ISO-8601 timestamps.

Default

true

updatedAtField

readonly updatedAtField: string = "updatedAt"

Defined in: pinecone-repository.ts:41

Metadata key written for auto-managed update timestamps.

Default

"updatedAt"

vectorDimension

abstract readonly vectorDimension: number

Defined in: pinecone-repository.ts:32

The number of dimensions in the index — required for zero-vector placeholders.

Accessors

index

Get Signature

get protected index(): Index

Defined in: pinecone-repository.ts:56

Lazily resolved namespace-scoped Pinecone Index instance.

Returns

Index

Methods

count()

count(params?): Promise<number>

Defined in: pinecone-repository.ts:292

Parameters

params?

QueryParams

Returns

Promise<number>

Implementation of

VectorRepository.count

deleteById()

deleteById(id): Promise<T>

Defined in: pinecone-repository.ts:280

Parameters

id

Id

Returns

Promise<T>

Implementation of

VectorRepository.deleteById

deleteVector()

deleteVector(id): Promise<T>

Defined in: pinecone-repository.ts:108

Delete a vector and its associated record

Parameters

id

Id

Returns

Promise<T>

Implementation of

VectorRepository.deleteVector

describe()

describe(): RepositoryCapabilities

Defined in: pinecone-repository.ts:63

Optional capability introspection. All

Returns

RepositoryCapabilities

Mantlejs

adapters implement it; user repositories may omit it.

Implementation of

VectorRepository.describe

findAll()

findAll(params?): Promise<T[]>

Defined in: pinecone-repository.ts:114

Parameters

params?

QueryParams

Returns

Promise<T[]>

Implementation of

VectorRepository.findAll

findById()

findById(id): Promise<T | null>

Defined in: pinecone-repository.ts:202

Parameters

id

Id

Returns

Promise<T | null>

Implementation of

VectorRepository.findById

findPage()

findPage(params?): Promise<CursorPage<T>>

Defined in: pinecone-repository.ts:163

Fetch one page of records using Pinecone’s native list pagination. The returned cursor is Pinecone’s opaque paginationToken; pass it back as params.cursor for the next page. where, skip, and sort are rejected — Pinecone’s list API enumerates IDs only and cannot filter or order.