Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add drizzle psg #3403

Draft
wants to merge 2 commits into
base: v2-develop
Choose a base branch
from

Conversation

0xbbjoker
Copy link

@0xbbjoker 0xbbjoker commented Feb 9, 2025

Database Adapter Implementation with Drizzle ORM

Pull Request Overview

Relates to

Issue: Database Adapter Implementation with Drizzle ORM

Risks

Risk Level: Medium

  • Database schema changes requiring careful migration handling
  • Embedding configuration needs to be set before initialization
  • Potential impact on existing RAGKnowledge functionality
  • Multiple provider support needs careful consideration

Background

What does this PR do?

  • Implements a new database adapter using Drizzle ORM
  • Introduces a more structured approach to database schema management
  • Adds support for vector operations and embedding configurations
  • Implements robust error handling and connection management
  • Provides transaction support and retry mechanisms

Type of Change

  • Features (non-breaking change which adds functionality)
  • Updates (new versions of included code)

Key Discussion Points

1. Embedding Configuration

The embedding.ts file has been removed but embedding configuration is still needed. Current implementation relies on getEmbeddingConfig() which needs to be set before initialization.

Proposal: Configuration Injection Pattern

interface DatabaseAdapterConfig {
  connection: ConnectionConfig;
  embedding: EmbeddingConfig;
}

class DrizzleDatabaseAdapter {
  constructor(config: DatabaseAdapterConfig) {
    this.embeddingConfig = config.embedding;
    // Initialize connection
  }
}

2. Multiple Driver Support

Current implementation is PostgreSQL-specific. Need to discuss strategy for supporting multiple database drivers.

3. RAGKnowledge Compatibility

RAGKnowledge functionality appears to be removed in v2-develop.

Discussion Points:

  • How should we handle embedding configuration injection?
  • What's the best approach for supporting multiple database drivers with Drizzle?
  • Should we consider a factory pattern for driver initialization?

Implementation Details

Database Schema

The implementation includes several key tables:

  • accounts
  • memories
  • rooms
  • goals
  • logs
  • participants
  • relationships
  • knowledge
  • cache

Vector Operations

Supports vector operations through PostgreSQL extensions:

But needs proper setup for embedding settings.

CREATE EXTENSION IF NOT EXISTS vector;
CREATE EXTENSION IF NOT EXISTS fuzzystrmatch;

Embedding Provider Configuration

Current implementation:

private async setEmbeddingProviderSettings(): Promise<void> {
    const embeddingConfig = getEmbeddingConfig();
    const providers = ["openai", "ollama", "gaianet"] as const;

    try {
        await this.db.transaction(async (tx) => {
            // Set provider configurations
            // ...
        });
    } catch (error) {
        elizaLogger.error("Failed to configure database embedding provider settings:", {
            error: error instanceof Error ? error.message : String(error),
        });
        throw error;
    }
}

Reference Implementations

Drizzle ORM Implementation (v1 develop)

Branch: https://github.com/0xbbjoker/eliza/tree/0xbbjoker/drizzle-orm

  • Complete test coverage for the database adapter
  • Includes vector operations and embedding configuration
  • RAGKnowledge implementation reference

Experimental Bun SQL Implementation

Branch: https://github.com/0xbbjoker/eliza/tree/bbopar/test-bun-sql

  • Alternative approach using Bun's SQL capabilities
  • Potential reference point for multi-driver support discussion

Contact

Discord: .0xbbjoker

Copy link
Contributor

coderabbitai bot commented Feb 9, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@lalalune
Copy link
Member

lalalune commented Feb 9, 2025

This is great.

Some thoughts

-> Let's get rid of RAGKnowledge. Thinking longterm, Knowledge is already RAG. Knowledge should be memories, and if there are special search functions or things that RAGKnowledge is doing that memories aren't, we should think of that as being a dynamically injected context provider, I think, not part of core. Like you should be able to add a custom knowledge system if you want, but that should be using the primitives we offer.

-> Database schema change. IMO we can ship without this, then make an import/export script

Gonna pull this into v2-develop

@0xbbjoker
Copy link
Author

I've removed the knowledge-related code from index.ts. Two questions:

Should we also remove it from schema.sql and init.sql? I notice it's still present in SQLite.

For merging to v2-develop: we'll need to configure both the connection and embedding settings.

@odilitime odilitime added the V2 Eliza 0.2.0 label Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V2 Eliza 0.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants