@nshiab/simple-data-analysis 5.20.7 → 5.20.9

package/script/deps/jsr.io/@nshiab/simple-data-analysis-core/0.1.5/src/class/SimpleDB.js

@@ -1,811 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const node_api_1 = require("@duckdb/node-api");
-const runQuery_js_1 = __importDefault(require("../helpers/runQuery.js"));
-const SimpleTable_js_1 = __importDefault(require("./SimpleTable.js"));
-const cleanCache_js_1 = __importDefault(require("../helpers/cleanCache.js"));
-const createDirectory_js_1 = __importDefault(require("../helpers/createDirectory.js"));
-const prettyDuration_js_1 = __importDefault(require("../helpers/prettyDuration.js"));
-const Simple_js_1 = __importDefault(require("./Simple.js"));
-const queryDB_js_1 = __importDefault(require("../helpers/queryDB.js"));
-const mergeOptions_js_1 = __importDefault(require("../helpers/mergeOptions.js"));
-const getTableNames_js_1 = __importDefault(require("../methods/getTableNames.js"));
-const cleanPath_js_1 = __importDefault(require("../helpers/cleanPath.js"));
-const getExtension_js_1 = __importDefault(require("../helpers/getExtension.js"));
-const node_fs_1 = require("node:fs");
-const checkVssIndexes_js_1 = __importDefault(require("../helpers/checkVssIndexes.js"));
-const setDbProps_js_1 = __importDefault(require("../helpers/setDbProps.js"));
-const writeIndexes_js_1 = __importDefault(require("../helpers/writeIndexes.js"));
-const getName_js_1 = __importDefault(require("../helpers/getName.js"));
-const node_fs_2 = require("node:fs");
-/**
- * Manages a DuckDB database instance, providing a simplified interface for database operations.
- *
- * @example
- * ```ts
- * // Create an in-memory database instance
- * const sdb = new SimpleDB();
- * // Create a new table named "employees"
- * const employees = sdb.newTable("employees");
- * // Load data from a CSV file into the "employees" table
- * await employees.loadData("./employees.csv");
- * // Log the first few rows of the "employees" table to the console
- * await employees.logTable();
- * // Close the database connection and clean up resources
- * await sdb.done();
- * ```
- *
- * @example
- * ```ts
- * // Create a persistent database instance, saving data to a file
- * // To load an existing database, use the `loadDB` method instead
- * const sdb = new SimpleDB({ file: "./my_database.db" });
- * // Perform database operations...
- * // Close the database connection, which saves changes to the specified file
- * await sdb.done();
- * ```
- *
- * @example
- * ```ts
- * // Create a database instance with custom options
- * const sdb = new SimpleDB({
- *   debug: true, // Enable debugging output
- *   nbRowsToLog: 20 // Set the number of rows to log by default
- * });
- * ```
- */
-class SimpleDB extends Simple_js_1.default {
-    /**
-     * Creates a new SimpleDB instance.
-     *
-     * @param options - Configuration options for the SimpleDB instance.
-     * @param options.file - The path to the database file. If not provided, an in-memory database is used.
-     * @param options.overwrite - A flag indicating whether to overwrite the database file if it already exists.
-     * @param options.logDuration - A flag indicating whether to log the total execution duration.
-     * @param options.nbRowsToLog - The number of rows to display when logging a table.
-     * @param options.nbCharactersToLog - The maximum number of characters to display for text-based cells.
-     * @param options.types - A flag indicating whether to include data types when logging a table.
-     * @param options.cacheVerbose - A flag indicating whether to log verbose cache-related messages.
-     * @param options.debug - A flag indicating whether to log debugging information.
-     * @param options.duckDbCache - A flag indicating whether to use DuckDB's external file cache.
-     * @param options.progressBar - A flag indicating whether to display a progress bar for long-running operations.
-     * @category Constructor
-     */
-    constructor(options = {}) {
-        super(options);
-        /**
-         * An array of paths to the data sources used in the cache.
-         *
-         * @defaultValue `[]`
-         * @category Properties
-         */
-        Object.defineProperty(this, "cacheSourcesUsed", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * A timestamp marking the start of a duration measurement.
-         *
-         * @defaultValue `undefined`
-         * @category Properties
-         */
-        Object.defineProperty(this, "durationStart", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * A counter for incrementing default table names.
-         *
-         * @defaultValue `1`
-         * @category Properties
-         */
-        Object.defineProperty(this, "tableIncrement", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * A flag indicating whether to log the total execution duration.
-         *
-         * @defaultValue `false`
-         * @category Properties
-         */
-        Object.defineProperty(this, "logDuration", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * An array of table instances associated with this database.
-         *
-         * @defaultValue `[]`
-         * @category Properties
-         */
-        Object.defineProperty(this, "tables", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * A flag indicating whether to log verbose cache-related messages.
-         *
-         * @defaultValue `false`
-         * @category Properties
-         */
-        Object.defineProperty(this, "cacheVerbose", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The total time saved by using the cache, in milliseconds.
-         *
-         * @defaultValue `0`
-         * @category Properties
-         */
-        Object.defineProperty(this, "cacheTimeSaved", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The total time spent writing to the cache, in milliseconds.
-         *
-         * @defaultValue `0`
-         * @category Properties
-         */
-        Object.defineProperty(this, "cacheTimeWriting", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * A flag indicating whether to display a progress bar for long-running operations.
-         *
-         * @defaultValue `false`
-         * @category Properties
-         */
-        Object.defineProperty(this, "progressBar", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * A flag indicating whether to use DuckDB's external file cache.
-         *
-         * @defaultValue `false`
-         * @category Properties
-         */
-        Object.defineProperty(this, "duckDbCache", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The path to the database file. If not provided, an in-memory database is used.
-         *
-         * @defaultValue `:memory:`
-         * @category Properties
-         */
-        Object.defineProperty(this, "file", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * A flag indicating whether to overwrite the database file if it already exists.
-         *
-         * @defaultValue `false`
-         * @category Properties
-         */
-        Object.defineProperty(this, "overwrite", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * The class used to create table instances. Defaults to `SimpleTable`.
-         * Override this property when subclassing to ensure all table-creating
-         * methods (e.g., `newTable()`, `cloneTable()`) return instances of your
-         * custom table class.
-         *
-         * @defaultValue `SimpleTable`
-         * @category Properties
-         *
-         * @example
-         * ```ts
-         * class MyTable extends SimpleTable {
-         *   customMethod() { return "hello"; }
-         * }
-         *
-         * class MyDB extends SimpleDB {
-         *   constructor(options?: SimpleDBOptions) {
-         *     super(options);
-         *     this.tableClass = MyTable;
-         *   }
-         * }
-         *
-         * const db = new MyDB();
-         * const table = db.newTable("myTable");
-         * console.log(table.customMethod()); // "hello"
-         * ```
-         */
-        Object.defineProperty(this, "tableClass", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: SimpleTable_js_1.default
-        });
-        this.file = options.file ?? ":memory:";
-        this.overwrite = options.overwrite ?? false;
-        this.logDuration = options.logDuration ?? false;
-        this.tableIncrement = 1;
-        this.tables = [];
-        this.cacheSourcesUsed = [];
-        this.cacheVerbose = options.cacheVerbose ?? false;
-        this.cacheTimeSaved = 0;
-        this.cacheTimeWriting = 0;
-        this.progressBar = options.progressBar ?? false;
-        this.duckDbCache = options.duckDbCache === undefined
-            ? false
-            : options.duckDbCache;
-        this.runQuery = runQuery_js_1.default;
-        if (this.cacheVerbose || this.logDuration) {
-            this.durationStart = Date.now();
-        }
-    }
-    /**
-     * Initializes the DuckDB database instance and connection.
-     *
-     * @returns A promise that resolves to the SimpleDB instance after initialization.
-     * @internal
-     * @category Lifecycle
-     */
-    async start() {
-        if (this.db === undefined || this.connection === undefined) {
-            if (this.file !== ":memory:") {
-                if ((0, getExtension_js_1.default)(this.file) !== "db") {
-                    throw new Error(`The file extension must be .db. The current file is ${this.file}.`);
-                }
-                if ((0, node_fs_1.existsSync)(this.file) && this.overwrite === false) {
-                    throw new Error(`The file ${this.file} already exists. Set the overwrite option to true to overwrite it. Otherwise, use the loadDB() method to load an existing database with more options.`);
-                }
-                else if ((0, node_fs_1.existsSync)(this.file) && this.overwrite === true) {
-                    (0, node_fs_1.rmSync)(this.file);
-                }
-            }
-            this.db = await node_api_1.DuckDBInstance.create(this.file);
-            this.connection = await this.db.connect();
-            // By default, DuckDB does not compress in-memory databases, so we enable it here.
-            if (this.file === ":memory:") {
-                await this.customQuery("ATTACH OR REPLACE ':memory:' AS memory (COMPRESS);");
-            }
-            if (this.duckDbCache === true) {
-                await this.customQuery("SET enable_external_file_cache=true;");
-            }
-            else if (this.duckDbCache === false) {
-                await this.customQuery("SET enable_external_file_cache=false;");
-            }
-            if (this.progressBar) {
-                await this.customQuery(`SET enable_progress_bar = TRUE; SET progress_bar_time = 0;`);
-            }
-        }
-        return this;
-    }
-    /**
-     * Adds a SimpleTable instance to the internal list of tables.
-     *
-     * @param table - The SimpleTable instance to add.
-     * @internal
-     * @category Table Management
-     */
-    pushTable(table) {
-        const TableClass = this.tableClass;
-        if (!(table instanceof TableClass)) {
-            throw new Error(`The table must be an instance of ${TableClass.name}.`);
-        }
-        if (this.tables.map((t) => t.name).includes(table.name)) {
-            throw new Error(`Table ${table.name} already exists.`);
-        }
-        this.tables.push(table);
-    }
-    /**
-     * Creates a new SimpleTable instance within the database.
-     *
-     * @param name - The name of the new table. If not provided, a default name is generated (e.g., "table1").
-     * @returns A new table instance.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Create a table with a default name (e.g., "table1", "table2", etc.)
-     * const dataTable = sdb.newTable();
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Create a table with a specific name
-     * const employees = sdb.newTable("employees");
-     * ```
-     */
-    newTable(name) {
-        const TableClass = this.tableClass;
-        // SHOULD MATCH cloneTable
-        let table;
-        if (typeof name === "string") {
-            table = new TableClass(name, this, {
-                debug: this.debug,
-                nbRowsToLog: this.nbRowsToLog,
-                nbCharactersToLog: this.nbCharactersToLog,
-                types: this.types,
-            });
-            table.defaultTableName = false;
-        }
-        else {
-            table = new TableClass(`table${this.tableIncrement}`, this, {
-                debug: this.debug,
-                nbRowsToLog: this.nbRowsToLog,
-                nbCharactersToLog: this.nbCharactersToLog,
-                types: this.types,
-            });
-            table.defaultTableName = true;
-            this.tableIncrement += 1;
-        }
-        this.pushTable(table);
-        return table;
-    }
-    /**
-     * Retrieves an existing SimpleTable instance from the database.
-     *
-     * @param name - The name of the table to retrieve.
-     * @returns A promise that resolves to the SimpleTable instance if found.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Retrieve the "employees" table
-     * const employees = await sdb.getTable("employees");
-     * ```
-     */
-    async getTable(name) {
-        const table = this.tables.find((t) => t.name === name);
-        if (table) {
-            return await table;
-        }
-        else {
-            throw new Error(`Table ${name} not found.`);
-        }
-    }
-    /**
-     * Removes one or more tables from the database.
-     *
-     * @param tables - A single table or an array of tables to remove, specified by name or as SimpleTable instances.
-     * @returns A promise that resolves when the tables have been removed.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Remove a single table by name
-     * await sdb.removeTables("employees");
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Remove multiple tables by name
-     * await sdb.removeTables(["customers", "products"]);
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Remove a single table using a SimpleTable instance
-     * const employeesTable = sdb.newTable("employees");
-     * // ... load data ...
-     * await sdb.removeTables(employeesTable);
-     * ```
-     */
-    async removeTables(tables) {
-        const tablesToBeRemoved = Array.isArray(tables) ? tables : [tables];
-        await (0, queryDB_js_1.default)(this, tablesToBeRemoved.map((d) => `DROP TABLE "${d instanceof SimpleTable_js_1.default ? d.name : d}";`).join("\n"), (0, mergeOptions_js_1.default)(this, {
-            table: null,
-            method: "removeTable()",
-            parameters: {},
-        }));
-        const tablesNamesToBeRemoved = tablesToBeRemoved.map((t) => t instanceof SimpleTable_js_1.default ? t.name : t);
-        this.tables = this.tables.filter((t) => !tablesNamesToBeRemoved.includes(t.name));
-    }
-    /**
-     * Selects one or more tables to keep in the database, removing all others.
-     *
-     * @param tables - A single table or an array of tables to select, specified by name or as SimpleTable instances.
-     * @returns A promise that resolves when the tables have been selected.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Select a single table by name, removing all other tables
-     * await sdb.selectTables("employees");
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Select multiple tables by name, removing all other tables
-     * await sdb.selectTables(["customers", "products"]);
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Select a single table using a SimpleTable instance
-     * const employeesTable = sdb.newTable("employees");
-     * // ... load data ...
-     * await sdb.selectTables(employeesTable);
-     * ```
-     */
-    async selectTables(tables) {
-        const tablesToBeSelected = (Array.isArray(tables) ? tables : [tables]).map((t) => t instanceof SimpleTable_js_1.default ? t.name : t);
-        for (const table of tablesToBeSelected) {
-            if (!(await this.hasTable(table))) {
-                throw new Error(`Table ${table} not found.`);
-            }
-        }
-        const tablesToBeRemoved = this.tables.filter((t) => !tablesToBeSelected.includes(t.name));
-        await (0, queryDB_js_1.default)(this, tablesToBeRemoved.map((d) => `DROP TABLE "${d instanceof SimpleTable_js_1.default ? d.name : d}";`).join("\n"), (0, mergeOptions_js_1.default)(this, {
-            table: null,
-            method: "removeTable()",
-            parameters: {},
-        }));
-        const tablesNamesToBeRemoved = tablesToBeRemoved.map((t) => t instanceof SimpleTable_js_1.default ? t.name : t);
-        this.tables = this.tables.filter((t) => !tablesNamesToBeRemoved.includes(t.name));
-    }
-    /**
-     * Returns an array of all table names in the database, sorted alphabetically.
-     *
-     * @returns A promise that resolves to an array of table names.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Get all table names
-     * const tableNames = await sdb.getTableNames();
-     * console.log(tableNames); // Output: ["employees", "customers"]
-     * ```
-     */
-    async getTableNames() {
-        return await (0, getTableNames_js_1.default)(this);
-    }
-    /**
-     * Logs the names of all tables in the database to the console, sorted alphabetically.
-     *
-     * @returns A promise that resolves when the table names have been logged.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Log all table names to the console
-     * await sdb.logTableNames();
-     * // Example output: SimpleDB - Tables:  ["employees","customers"]
-     * ```
-     */
-    async logTableNames() {
-        const tables = await this.getTableNames();
-        if (tables.length > 0) {
-            console.log(`\nSimpleDB - Tables:  ${JSON.stringify(tables)}`);
-        }
-        else {
-            console.log(`\nSimpleDB - No tables found.`);
-        }
-    }
-    /**
-     * Returns an array of all SimpleTable instances in the database.
-     *
-     * @returns A promise that resolves to an array of SimpleTable instances.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Get all SimpleTable instances
-     * const tables = await sdb.getTables();
-     * ```
-     */
-    async getTables() {
-        return await this.tables;
-    }
-    /**
-     * Checks if a table exists in the database.
-     *
-     * @param table - The name of the table or a SimpleTable instance.
-     * @returns A promise that resolves to `true` if the table exists, `false` otherwise.
-     * @category Table Management
-     *
-     * @example
-     * ```ts
-     * // Check if a table named "employees" exists
-     * const exists = await sdb.hasTable("employees");
-     * console.log(exists); // Output: true or false
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Check if a SimpleTable instance exists in the database
-     * const myTable = sdb.newTable("my_data");
-     * const existsInstance = await sdb.hasTable(myTable);
-     * console.log(existsInstance); // Output: true or false
-     * ```
-     */
-    async hasTable(table) {
-        const tableName = typeof table === "string" ? table : table.name;
-        const result = (await this.getTableNames()).includes(tableName);
-        return result;
-    }
-    /**
-     * Returns a list of installed DuckDB extensions.
-     *
-     * @returns A promise that resolves to an array of objects, each representing an installed extension.
-     * @category DuckDB
-     *
-     * @example
-     * ```ts
-     * // Get a list of all installed extensions
-     * const extensions = await sdb.getExtensions();
-     * console.log(extensions); // Output: [{ extension_name: "spatial", loaded: true, ... }]
-     * ```
-     */
-    async getExtensions() {
-        return (await (0, queryDB_js_1.default)(this, `FROM duckdb_extensions();`, (0, mergeOptions_js_1.default)(this, {
-            returnDataFrom: "query",
-            table: null,
-            method: "getExtensions()",
-            parameters: {},
-        })));
-    }
-    /**
-     * Executes a custom SQL query directly against the DuckDB instance.
-     *
-     * If you want to force the returned data to match the types of the columns, you can use the `types` option.
-     *
-     * @param query - The SQL query string to execute.
-     * @param options - Configuration options for the query.
-     * @param options.returnDataFrom - Specifies whether to return data from the query. Can be `"query"` to return data or `"none"` (default) to not return data.
-     * @param options.table - The name of the table associated with the query, primarily used for debugging and logging.
-     * @param options.types - An optional object specifying data types for the query parameters.
-     * @returns A promise that resolves to the query result as an array of objects if `returnDataFrom` is `"query"`, otherwise `null`.
-     * @category DuckDB
-     *
-     * @example
-     * ```ts
-     * // Execute a query without returning data
-     * await sdb.customQuery("CREATE TABLE young_employees AS SELECT * FROM employees WHERE age > 30");
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Execute a query and return the results
-     * const youngEmployees = await sdb.customQuery(
-     *   "SELECT * FROM employees WHERE age < 30",
-     *   { returnDataFrom: "query" }
-     * );
-     * console.log(youngEmployees);
-     * ```
-     */
-    async customQuery(query, options = {}) {
-        return await (0, queryDB_js_1.default)(this, query, (0, mergeOptions_js_1.default)(this, {
-            returnDataFrom: options.returnDataFrom,
-            table: options.table ?? null,
-            method: "customQuery()",
-            parameters: { query, options },
-            types: options.types,
-        }));
-    }
-    /**
-     * Loads a database from a specified file into the current SimpleDB instance.
-     * Supported file types are `.db` (DuckDB) and `.sqlite` (SQLite).
-     *
-     * @param file - The absolute path to the database file (e.g., "./my_database.db").
-     * @param options - Configuration options for loading the database.
-     * @param options.name - The name to assign to the loaded database within the DuckDB instance. Defaults to the file name without extension.
-     * @param options.detach - If `true` (default), the database is detached after loading its contents into memory. If `false`, the database remains attached.
-     * @returns A promise that resolves when the database has been loaded.
-     * @category File Operations
-     *
-     * @example
-     * ```ts
-     * // Load a DuckDB database file
-     * await sdb.loadDB("./my_database.db");
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Load a SQLite database file and keep it attached
-     * await sdb.loadDB("./my_database.sqlite", { detach: false });
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Load a database with a custom name
-     * await sdb.loadDB("./archive.db", { name: "archive_db" });
-     * ```
-     */
-    async loadDB(file, options = {}) {
-        const name = options.name ?? "my_database";
-        const detach = options.detach ?? true;
-        if (!(0, node_fs_1.existsSync)(file)) {
-            throw new Error(`The file ${file} does not exist.`);
-        }
-        const extension = (0, getExtension_js_1.default)(file);
-        const allIndexesFile = `${file.replace(`.${extension}`, "")}_indexes.json`;
-        const vssIndex = (0, checkVssIndexes_js_1.default)(allIndexesFile);
-        if (vssIndex) {
-            await this.customQuery(`INSTALL vss; LOAD vss;`);
-        }
-        if (extension === "db") {
-            if (detach) {
-                await (0, queryDB_js_1.default)(this, `ATTACH '${(0, cleanPath_js_1.default)(file)}' AS ${name};
-COPY FROM DATABASE ${name} TO memory;
-DETACH ${name};`, (0, mergeOptions_js_1.default)(this, {
-                    returnDataFrom: "none",
-                    table: null,
-                    method: "loadDB()",
-                    parameters: {},
-                }));
-            }
-            else {
-                await (0, queryDB_js_1.default)(this, `ATTACH '${(0, cleanPath_js_1.default)(file)}' AS ${name};
-          USE ${name};`, (0, mergeOptions_js_1.default)(this, {
-                    returnDataFrom: "none",
-                    table: null,
-                    method: "loadDB()",
-                    parameters: {},
-                }));
-            }
-        }
-        else if (extension === "sqlite") {
-            if (detach) {
-                await (0, queryDB_js_1.default)(this, `INSTALL sqlite; LOAD sqlite;
-        ATTACH '${(0, cleanPath_js_1.default)(file)}' AS ${name} (TYPE SQLITE);
-COPY FROM DATABASE ${name} TO memory;
-DETACH ${name};`, (0, mergeOptions_js_1.default)(this, {
-                    returnDataFrom: "none",
-                    table: null,
-                    method: "loadDB()",
-                    parameters: {},
-                }));
-            }
-            else {
-                await (0, queryDB_js_1.default)(this, `INSTALL sqlite; LOAD sqlite;
-        ATTACH '${(0, cleanPath_js_1.default)(file)}' AS ${name} (TYPE SQLITE);
-        USE ${name};`, (0, mergeOptions_js_1.default)(this, {
-                    returnDataFrom: "none",
-                    table: null,
-                    method: "loadDB()",
-                    parameters: {},
-                }));
-            }
-        }
-        else {
-            throw new Error(`The extension ${extension} is not supported. Please use .db or .sqlite instead.`);
-        }
-        await (0, setDbProps_js_1.default)(this, allIndexesFile);
-    }
-    /**
-     * Writes the current state of the database to a specified file.
-     * Supported output file types are `.db` (DuckDB) and `.sqlite` (SQLite).
-     *
-     * @param file - The absolute path to the output file (e.g., "./my_exported_database.db").
-     * @param options - Configuration options for writing the database.
-     * @param options.noMetaData - If `true`, metadata files (indexes) are not created alongside the database file. Defaults to `false`.
-     * @returns A promise that resolves when the database has been written to the file.
-     * @category File Operations
-     *
-     * @example
-     * ```ts
-     * // Write the current database to a DuckDB file
-     * await sdb.writeDB("./my_exported_database.db");
-     * ```
-     *
-     * @example
-     * ```ts
-     * // Write the current database to a SQLite file without metadata
-     * await sdb.writeDB("./my_exported_database.sqlite", { noMetaData: true });
-     * ```
-     */
-    async writeDB(file, options = {}) {
-        const noMetaData = options.noMetaData ?? false;
-        if ((0, node_fs_1.existsSync)(file)) {
-            (0, node_fs_1.rmSync)(file);
-        }
-        (0, createDirectory_js_1.default)(file);
-        const extension = (0, getExtension_js_1.default)(file);
-        if (!noMetaData) {
-            (0, writeIndexes_js_1.default)(this, extension, file);
-        }
-        const name = (0, getName_js_1.default)(file);
-        if (extension === "db") {
-            await (0, queryDB_js_1.default)(this, `ATTACH '${(0, cleanPath_js_1.default)(file)}' AS ${name};
-COPY FROM DATABASE ${(0, getName_js_1.default)(this.file)} TO ${name};
-DETACH ${name};`, (0, mergeOptions_js_1.default)(this, {
-                returnDataFrom: "none",
-                table: null,
-                method: "writeDB()",
-                parameters: {},
-            }));
-        }
-        else if (extension === "sqlite") {
-            await (0, queryDB_js_1.default)(this, `INSTALL sqlite; LOAD sqlite;
-        ATTACH '${(0, cleanPath_js_1.default)(file)}' AS ${name} (TYPE SQLITE);
-COPY FROM DATABASE ${(0, getName_js_1.default)(this.file)} TO ${name};
-DETACH ${name};`, (0, mergeOptions_js_1.default)(this, {
-                returnDataFrom: "none",
-                table: null,
-                method: "writeDB()",
-                parameters: {},
-            }));
-        }
-        else {
-            throw new Error(`The extension ${extension} is not supported. Please use .db or .sqlite instead.`);
-        }
-    }
-    /**
-     * Frees up memory by closing the database connection and instance, and cleans up the cache.
-     * If the database is file-based, it also compacts the database file to optimize storage.
-     *
-     * @returns A promise that resolves to the SimpleDB instance after cleanup.
-     * @category Lifecycle
-     *
-     * @example
-     * ```ts
-     * // Close the database and clean up resources
-     * await sdb.done();
-     * ```
-     */
-    async done() {
-        if (this.file !== ":memory:") {
-            await this.customQuery("CHECKPOINT;");
-            // To make sure the files will have the proper names.
-            (0, writeIndexes_js_1.default)(this, (0, getExtension_js_1.default)(this.file), this.file);
-            await this.writeDB(this.file.replace(".db", "_compacted.db"), {
-                noMetaData: true,
-            });
-            (0, node_fs_1.rmSync)(this.file);
-            (0, node_fs_2.renameSync)(this.file.replace(".db", "_compacted.db"), this.file);
-        }
-        if (this.db instanceof node_api_1.DuckDBInstance) {
-            this.connection.closeSync();
-            this.db.closeSync();
-        }
-        (0, cleanCache_js_1.default)(this);
-        if (typeof this.durationStart === "number") {
-            let string = (0, prettyDuration_js_1.default)(this.durationStart, {
-                prefix: "\n\nSimpleDB - Done in ",
-            });
-            if (this.cacheTimeSaved > 0) {
-                string += ` / ${(0, prettyDuration_js_1.default)(0, {
-                    end: this.cacheTimeSaved,
-                })} saved by using the cache`;
-            }
-            if (this.cacheTimeWriting > 0) {
-                string += ` / ${(0, prettyDuration_js_1.default)(0, {
-                    end: this.cacheTimeWriting,
-                })} spent writing the cache`;
-            }
-            console.log(`${string}\n`);
-        }
-        return await this;
-    }
-}
-exports.default = SimpleDB;