oven-sh/bun

Automatically create directories for the path passed to `new Database`

Open

#3,888 opened on Jul 30, 2023

View on GitHub
 (10 comments) (0 reactions) (0 assignees)Rust (90,348 stars) (4,486 forks)batch import
bun.jsbun:sqliteenhancementgood first issue

Description

What version of Bun is running?

0.7.1

What platform is your computer?

Darwin 21.6.0 x86_64 i386

What steps can reproduce the bug?

  • create a directory called src

  • create a file called a.ts with this contents

    import { Database } from 'bun:sqlite';
const db = new Database('./i-dont-exist/data.db');

  • bun run ./a.ts

  • error should show

What is the expected behavior?

The directory to be created and then the new database file to be created.

What do you see instead?

This error.

➜  paas git:(main) ✗ bun run src/service-registry.ts
136 |     if (anonymous && (flags & constants.SQLITE_OPEN_READONLY) !== 0)
137 |       throw new Error("Cannot open an anonymous database in read-only mode.");
138 |     if (!SQL)
139 |       _SQL = SQL = lazy("sqlite");
140 | 
141 |     this.#handle = SQL.open(anonymous ? ":memory:" : filename, flags), this.filename = filename;
                      ^
error: unable to open database file
      at new Database (bun:sqlite:141:19)
      at /Users/xo/code/ImLunaHey/paas/src/service-registry.ts:3:11

Additional information

No response

Contributor guide

Tech stack
typescriptjavascriptrust
Domain
backenddatabase
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Bun's runtime and SQLite bindingsFamiliarity with Node.js file system operations
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Investigate the bun:sqlite implementation in the bun repository, likely in `src/bun.js/api/sqlite.cpp`. The goal is to add logic to automatically create parent directories of the database file path when calling `new Database(filename)` if they do not exist. Review comments in the issue to understand concerns (e.g., error handling, permissions, race conditions). Consider using a cross platform method like `mkdirp` (Node.js `fs.mkdirSync` with `{ recursive: true }`) or the Rust equivalent. Look at how other similar features in bun handle file creation. Ensure the change is consistent with bun's existing error handling patterns.
Automatically create directories for the path passed to `new Database` · oven-sh/bun#3888 | Good First Issue