Handle single file database change (#13)

* Update kuzu dependency to v0.10.2-dev.12 and modify environment variable for database path

* Bump kuzu dependency to version 0.11.0

Author: mewim

Dockerfile

@@ -38,7 +38,7 @@ EXPOSE 8000
 # Set environment variables
 ENV NODE_ENV=production
 ENV PORT=8000
-ENV KUZU_PATH=/database
+ENV KUZU_DIR=/database
 ENV CROSS_ORIGIN=true
 
 # Run app

README.md

@@ -10,12 +10,13 @@ To access an existing Kùzu database, you can mount its path to the `/database`
 
 ```bash
 docker run -p 8000:8000 \
-           -v path/to/database:/database \
+           -v {path to the directory containing the database file}:/database \
+           -e KUZU_FILE={database file name} \
            --rm kuzudb/api-server:latest
 ```
 
-By mounting local database files to Docker via `-v path/to/database:/database`,
-the changes done through the API server will persist to the local database files after the server is shutdown.
+By mounting local database files to Docker via `-v {path to the directory containing the database file}:/database` and `-e KUZU_FILE={database file name}`,
+the changes done through the API server will persist to the local database files after the server is shutdown. If the directory is mounted but the `KUZU_FILE` environment variable is not set, the API server will look for a file named `database.kz` in the mounted directory or create a new database file named `database.kz` in the mounted directory if it does not exist.
 
 The `--rm` flag tells docker that the container should automatically be removed after we close docker.
 
@@ -36,7 +37,8 @@ By default, the API server is launched in read-write mode, which means that you
 
 ```bash
 docker run -p 8000:8000 \
-           -v path/to/database:/database \
+           -v {path to the directory containing the database file}:/database \
+           -e KUZU_FILE={database file name} \
            -e MODE=READ_ONLY \
            --rm kuzudb/api-server:latest
 ```
@@ -57,7 +59,8 @@ For example, to launch the API server with a buffer pool size of 1GB, you can ru
 
 ```bash
 docker run -p 8000:8000 \
-           -v path/to/database:/database \
+           -v {path to the directory containing the database file}:/database \
+           -e KUZU_FILE={database file name} \
            -e KUZU_BUFFER_POOL_SIZE=1073741824 \
            --rm kuzudb/api-server:latest
 ```
@@ -68,7 +71,8 @@ By default, the API server is launched with CORS enabled for all origins. If you
 
 ```bash
 docker run -p 8000:8000 \
-           -v path/to/database:/database \
+           -v {path to the directory containing the database file}:/database \
+           -e KUZU_FILE={database file name} \
            -e CROSS_ORIGIN=false \
            --rm kuzudb/api-server:latest
 ```
@@ -81,15 +85,17 @@ For example:
 
 ```bash
 podman run -p 8000:8000 \
-           -v path/to/database:/database:U \
+           -v {path to the directory containing the database file}:/database:U \
+           -e KUZU_FILE={database file name} \
            --rm kuzudb/api-server:latest
 ```
 
 or,
 
 ```bash
 podman run -p 8000:8000 \
-           -v path/to/database:/database \
+           -v {path to the directory containing the database file}:/database \
+           -e KUZU_FILE={database file name} \
            --userns=keep-id \
            --rm kuzudb/api-server:latest
 ```

explorer

@@ -12,7 +12,7 @@
   "dependencies": {
     "cors": "^2.8.5",
     "express": "^4.18.2",
-    "kuzu": "0.10.0",
+    "kuzu": "0.11.0",
     "pino": "^8.16.1",
     "pino-pretty": "^10.2.3"
   }