From 30df3929f18deb246386b7b2eb1bb9fb7d10df98 Mon Sep 17 00:00:00 2001 From: Huakun Shen Date: Fri, 21 Mar 2025 00:24:59 -0400 Subject: [PATCH] docs(sql): enhance examples for database connection with detailed comments on SQLite usage --- plugins/sql/guest-js/index.ts | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/plugins/sql/guest-js/index.ts b/plugins/sql/guest-js/index.ts index cba9928e..51f7c014 100644 --- a/plugins/sql/guest-js/index.ts +++ b/plugins/sql/guest-js/index.ts @@ -42,17 +42,17 @@ export default class Database { * * @example * ```ts - * // Basic connection + * // Basic connection to a SQLite database * const db = await Database.load("sqlite:test.db"); * - * // With encryption key + * // Connecting with an encryption key for added security * const db = await Database.load("sqlite:encrypted.db", { - * pragmas: { "key": "encryption_key" } + * sqlite: { pragmas: { "key": "encryption_key" } } * }); * - * // With pragmas + * // Connecting with specific pragmas for configuration * const db = await Database.load("sqlite:test.db", { - * pragmas: { "journal_mode": "WAL", "foreign_keys": "ON" } + * sqlite: { pragmas: { "journal_mode": "WAL", "foreign_keys": "ON" } } * }); * ``` */