Skip to content

feat(db): integrate DuckDB connection and create projects table#2

Merged
DaxServer merged 1 commit intomainfrom
duckdb-projects
Jun 6, 2025
Merged

feat(db): integrate DuckDB connection and create projects table#2
DaxServer merged 1 commit intomainfrom
duckdb-projects

Conversation

@DaxServer
Copy link
Owner

No description provided.

@coderabbitai
Copy link

coderabbitai bot commented Jun 6, 2025

📝 Walkthrough

Summary by CodeRabbit

  • New Features
    • Added backend support for project metadata storage and retrieval using a new database and API endpoint.
    • Introduced a new API route to fetch all projects with their details.
  • Chores
    • Updated backend dependencies to include DuckDB support.
    • Improved backend database initialization and lifecycle management.
    • Enhanced .gitignore to exclude database files.
  • Tests
    • Added comprehensive tests for project API handlers and database management.
  • Documentation
    • Added TypeScript declarations for auto-imported frontend APIs to streamline development.

Walkthrough

This update introduces a DuckDB-backed project metadata store to the backend, including database initialization, connection management, and schema setup. New API endpoints and handler logic for retrieving project metadata are added, along with corresponding tests. The frontend receives auto-imported TypeScript declarations for common Vue and Pinia APIs, and project-related files are now ignored in .gitignore.

Changes

File(s) Change Summary
.gitignore Added openrefine.db* pattern to ignore DuckDB database files.
backend/package.json Added dependency: @duckdb/node-api@^1.3.0-alpha.21.
backend/src/db.ts New module for DuckDB connection lifecycle: initializeDb, getDb, closeDb.
backend/src/sql/create_projects_table.sql New SQL schema file creating _meta_projects table with metadata fields and JSON config.
backend/src/api/project/handlers.ts Added getAllProjects async function to fetch all projects from the database.
backend/src/api/project/routes.ts New Elysia route module with /project prefix and GET / endpoint using getAllProjects.
backend/src/api/project/index.ts New module re-exporting all from routes and handlers.
backend/src/index.ts Integrated initializeDb and registered projectRoutes in the main backend entrypoint.
backend/test/api/project/handlers.test.ts New test suite for getAllProjects, covering empty and populated project scenarios.
backend/test/db.test.ts New tests for database connection management: initialization, retrieval, closure, and error handling.
frontend/auto-imports.d.ts New auto-generated TypeScript declarations for globally available Vue, Pinia, and router APIs and types.

Sequence Diagram(s)

sequenceDiagram
    participant App as Backend App
    participant DB as DuckDB (via db.ts)
    participant SQL as SQL Schema File
    participant API as Client/API Consumer

    Note over App,DB: Startup
    App->>DB: initializeDb()
    DB->>SQL: Load create_projects_table.sql
    DB->>DB: Create _meta_projects table if not exists
    DB-->>App: Return DB connection

    Note over API,App: Fetch all projects
    API->>App: GET /project/
    App->>DB: getDb()
    App->>DB: SELECT * FROM _meta_projects ORDER BY created_at DESC
    DB-->>App: Projects as JSON
    App-->>API: { data: [...] }
Loading
sequenceDiagram
    participant Test as Test Suite
    participant DB as DuckDB (db.ts)
    participant SQL as SQL Schema File

    Test->>DB: initializeDb(':memory:')
    DB->>SQL: Load create_projects_table.sql
    DB->>DB: Create _meta_projects table
    Test->>DB: getDb()
    Test->>DB: Insert project (optional)
    Test->>DB: Query projects
    DB-->>Test: Project data
    Test->>DB: closeDb()
    DB-->>Test: Connection closed
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between f93f50b and 43b6f63.

⛔ Files ignored due to path filters (1)
  • bun.lock is excluded by !**/*.lock
📒 Files selected for processing (11)
  • .gitignore (1 hunks)
  • backend/package.json (1 hunks)
  • backend/src/api/project/handlers.ts (1 hunks)
  • backend/src/api/project/index.ts (1 hunks)
  • backend/src/api/project/routes.ts (1 hunks)
  • backend/src/db.ts (1 hunks)
  • backend/src/index.ts (2 hunks)
  • backend/src/sql/create_projects_table.sql (1 hunks)
  • backend/test/api/project/handlers.test.ts (1 hunks)
  • backend/test/db.test.ts (1 hunks)
  • frontend/auto-imports.d.ts (1 hunks)

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

@DaxServer DaxServer merged commit c5de7f0 into main Jun 6, 2025
1 check passed
@DaxServer DaxServer deleted the duckdb-projects branch June 6, 2025 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant