IDatabaseAdapter.md

@ai16z/eliza v0.1.4-alpha.3 / IDatabaseAdapter

Interface: IDatabaseAdapter

Interface for database operations

Properties

db

db: any

Database instance

Defined in

packages/core/src/types.ts:740

Methods

init()

init(): Promise<void>

Optional initialization

Returns

Promise<void>

Defined in

packages/core/src/types.ts:743

---

close()

close(): Promise<void>

Close database connection

Returns

Promise<void>

Defined in

packages/core/src/types.ts:746

---

getAccountById()

getAccountById(userId): Promise<Account>

Get account by ID

Parameters

• userId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<Account>

Defined in

packages/core/src/types.ts:749

---

createAccount()

createAccount(account): Promise<boolean>

Create new account

Parameters

• account: Account

Returns

Promise<boolean>

Defined in

packages/core/src/types.ts:752

---

getMemories()

getMemories(params): Promise<Memory[]>

Get memories matching criteria

Parameters

• params

• params.roomId: `${string}-${string}-${string}-${string}-${string}`

• params.count?: number

• params.unique?: boolean

• params.tableName: string

• params.agentId: `${string}-${string}-${string}-${string}-${string}`

• params.start?: number

• params.end?: number

Returns

Promise<Memory[]>

Defined in

packages/core/src/types.ts:755

---

getMemoryById()

getMemoryById(id): Promise<Memory>

Parameters

• id: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<Memory>

Defined in

packages/core/src/types.ts:765

---

getMemoriesByRoomIds()

getMemoriesByRoomIds(params): Promise<Memory[]>

Parameters

• params

• params.tableName: string

• params.agentId: `${string}-${string}-${string}-${string}-${string}`

• params.roomIds: `${string}-${string}-${string}-${string}-${string}`[]

Returns

Promise<Memory[]>

Defined in

packages/core/src/types.ts:767

---

getCachedEmbeddings()

getCachedEmbeddings(params): Promise<object[]>

Parameters

• params

• params.query_table_name: string

• params.query_threshold: number

• params.query_input: string

• params.query_field_name: string

• params.query_field_sub_name: string

• params.query_match_count: number

Returns

Promise<object[]>

Defined in

packages/core/src/types.ts:773

---

log()

log(params): Promise<void>

Parameters

• params

• params.body

• params.userId: `${string}-${string}-${string}-${string}-${string}`

• params.roomId: `${string}-${string}-${string}-${string}-${string}`

• params.type: string

Returns

Promise<void>

Defined in

packages/core/src/types.ts:782

---

getActorDetails()

getActorDetails(params): Promise<Actor[]>

Parameters

• params

• params.roomId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<Actor[]>

Defined in

packages/core/src/types.ts:789

---

searchMemories()

searchMemories(params): Promise<Memory[]>

Parameters

• params

• params.tableName: string

• params.agentId: `${string}-${string}-${string}-${string}-${string}`

• params.roomId: `${string}-${string}-${string}-${string}-${string}`

• params.embedding: number[]

• params.match_threshold: number

• params.match_count: number

• params.unique: boolean

Returns

Promise<Memory[]>

Defined in

packages/core/src/types.ts:791

---

updateGoalStatus()

updateGoalStatus(params): Promise<void>

Parameters

• params

• params.goalId: `${string}-${string}-${string}-${string}-${string}`

• params.status: GoalStatus

Returns

Promise<void>

Defined in

packages/core/src/types.ts:801

---

searchMemoriesByEmbedding()

searchMemoriesByEmbedding(embedding, params): Promise<Memory[]>

Parameters

• embedding: number[]

• params

• params.match_threshold?: number

• params.count?: number

• params.roomId?: `${string}-${string}-${string}-${string}-${string}`

• params.agentId?: `${string}-${string}-${string}-${string}-${string}`

• params.unique?: boolean

• params.tableName: string

Returns

Promise<Memory[]>

Defined in

packages/core/src/types.ts:806

---

createMemory()

createMemory(memory, tableName, unique?): Promise<void>

Parameters

• memory: Memory

• tableName: string

• unique?: boolean

Returns

Promise<void>

Defined in

packages/core/src/types.ts:818

---

removeMemory()

removeMemory(memoryId, tableName): Promise<void>

Parameters

• memoryId: `${string}-${string}-${string}-${string}-${string}`

• tableName: string

Returns

Promise<void>

Defined in

packages/core/src/types.ts:824

---

removeAllMemories()

removeAllMemories(roomId, tableName): Promise<void>

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

• tableName: string

Returns

Promise<void>

Defined in

packages/core/src/types.ts:826

---

countMemories()

countMemories(roomId, unique?, tableName?): Promise<number>

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

• unique?: boolean

• tableName?: string

Returns

Promise<number>

Defined in

packages/core/src/types.ts:828

---

getGoals()

getGoals(params): Promise<Goal[]>

Parameters

• params

• params.agentId: `${string}-${string}-${string}-${string}-${string}`

• params.roomId: `${string}-${string}-${string}-${string}-${string}`

• params.userId?: `${string}-${string}-${string}-${string}-${string}`

• params.onlyInProgress?: boolean

• params.count?: number

Returns

Promise<Goal[]>

Defined in

packages/core/src/types.ts:834

---

updateGoal()

updateGoal(goal): Promise<void>

Parameters

• goal: Goal

Returns

Promise<void>

Defined in

packages/core/src/types.ts:842

---

createGoal()

createGoal(goal): Promise<void>

Parameters

• goal: Goal

Returns

Promise<void>

Defined in

packages/core/src/types.ts:844

---

removeGoal()

removeGoal(goalId): Promise<void>

Parameters

• goalId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<void>

Defined in

packages/core/src/types.ts:846

---

removeAllGoals()

removeAllGoals(roomId): Promise<void>

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<void>

Defined in

packages/core/src/types.ts:848

---

getRoom()

getRoom(roomId): Promise<`${string}-${string}-${string}-${string}-${string}`>

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<`${string}-${string}-${string}-${string}-${string}`>

Defined in

packages/core/src/types.ts:850

---

createRoom()

createRoom(roomId?): Promise<`${string}-${string}-${string}-${string}-${string}`>

Parameters

• roomId?: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<`${string}-${string}-${string}-${string}-${string}`>

Defined in

packages/core/src/types.ts:852

---

removeRoom()

removeRoom(roomId): Promise<void>

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<void>

Defined in

packages/core/src/types.ts:854

---

getRoomsForParticipant()

getRoomsForParticipant(userId): Promise<`${string}-${string}-${string}-${string}-${string}`[]>

Parameters

• userId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<`${string}-${string}-${string}-${string}-${string}`[]>

Defined in

packages/core/src/types.ts:856

---

getRoomsForParticipants()

getRoomsForParticipants(userIds): Promise<`${string}-${string}-${string}-${string}-${string}`[]>

Parameters

• userIds: `${string}-${string}-${string}-${string}-${string}`[]

Returns

Promise<`${string}-${string}-${string}-${string}-${string}`[]>

Defined in

packages/core/src/types.ts:858

---

addParticipant()

addParticipant(userId, roomId): Promise<boolean>

Parameters

• userId: `${string}-${string}-${string}-${string}-${string}`

• roomId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<boolean>

Defined in

packages/core/src/types.ts:860

---

removeParticipant()

removeParticipant(userId, roomId): Promise<boolean>

Parameters

• userId: `${string}-${string}-${string}-${string}-${string}`

• roomId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<boolean>

Defined in

packages/core/src/types.ts:862

---

getParticipantsForAccount()

getParticipantsForAccount(userId): Promise<Participant[]>

Parameters

• userId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<Participant[]>

Defined in

packages/core/src/types.ts:864

---

getParticipantsForRoom()

getParticipantsForRoom(roomId): Promise<`${string}-${string}-${string}-${string}-${string}`[]>

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<`${string}-${string}-${string}-${string}-${string}`[]>

Defined in

packages/core/src/types.ts:866

---

getParticipantUserState()

getParticipantUserState(roomId, userId): Promise<"FOLLOWED" | "MUTED">

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

• userId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<"FOLLOWED" | "MUTED">

Defined in

packages/core/src/types.ts:868

---

setParticipantUserState()

setParticipantUserState(roomId, userId, state): Promise<void>

Parameters

• roomId: `${string}-${string}-${string}-${string}-${string}`

• userId: `${string}-${string}-${string}-${string}-${string}`

• state: "FOLLOWED" | "MUTED"

Returns

Promise<void>

Defined in

packages/core/src/types.ts:873

---

createRelationship()

createRelationship(params): Promise<boolean>

Parameters

• params

• params.userA: `${string}-${string}-${string}-${string}-${string}`

• params.userB: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<boolean>

Defined in

packages/core/src/types.ts:879

---

getRelationship()

getRelationship(params): Promise<Relationship>

Parameters

• params

• params.userA: `${string}-${string}-${string}-${string}-${string}`

• params.userB: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<Relationship>

Defined in

packages/core/src/types.ts:881

---

getRelationships()

getRelationships(params): Promise<Relationship[]>

Parameters

• params

• params.userId: `${string}-${string}-${string}-${string}-${string}`

Returns

Promise<Relationship[]>

Defined in

packages/core/src/types.ts:886