mdb-reader/lib/node/MDBReader.js

JavaScript library to read data from Access databases

import { Database } from "./Database.js";
import { PageType, assertPageType } from "./PageType.js";
import { isSysObjectType, isSystemObject, SysObjectTypes } from "./SysObject.js";
import { Table } from "./Table.js";
import { getMSysObjectsTable } from "./systemTables.js";
import { maskTableId } from "./util.js";
export default class MDBReader {
    #buffer;
    #sysObjects;
    #database;
    /**
     * @param buffer Buffer of the database.
     */
    constructor(buffer, { password } = {}) {
        this.#buffer = buffer;
        assertPageType(this.#buffer, PageType.DatabaseDefinitionPage);
        this.#database = new Database(this.#buffer, password ?? "");
        const mSysObjectsTable = getMSysObjectsTable(this.#database).getData({
            columns: ["Id", "Name", "Type", "Flags"],
        });
        this.#sysObjects = mSysObjectsTable.map((mSysObject) => {
            const objectType = mSysObject.Type & 0x7f;
            return {
                objectName: mSysObject.Name,
                objectType: isSysObjectType(objectType) ? objectType : null,
                tablePage: maskTableId(mSysObject.Id),
                flags: mSysObject.Flags,
            };
        });
    }
    /**
     * Date when the database was created
     */
    getCreationDate() {
        return this.#database.getCreationDate();
    }
    /**
     * Database password
     */
    getPassword() {
        return this.#database.getPassword();
    }
    /**
     * Default sort order
     */
    getDefaultSortOrder() {
        return this.#database.getDefaultSortOrder();
    }
    /**
     * Returns an array of table names.
     *
     * @param normalTables Includes user tables. Default true.
     * @param systemTables Includes system tables. Default false.
     * @param linkedTables Includes linked tables. Default false.
     */
    getTableNames({ normalTables = true, systemTables = false, linkedTables = false, } = {}) {
        const filteredSysObjects = [];
        for (const sysObject of this.#sysObjects) {
            if (sysObject.objectType === SysObjectTypes.Table) {
                if (!isSystemObject(sysObject)) {
                    if (normalTables) {
                        filteredSysObjects.push(sysObject);
                    }
                }
                else if (systemTables) {
                    filteredSysObjects.push(sysObject);
                }
            }
            else if (sysObject.objectType === SysObjectTypes.LinkedTable && linkedTables) {
                filteredSysObjects.push(sysObject);
            }
        }
        return filteredSysObjects.map((o) => o.objectName);
    }
    /**
     * Returns a table by its name.
     *
     * @param name Name of the table. Case sensitive.
     */
    getTable(name) {
        const sysObject = this.#sysObjects
            .filter((o) => o.objectType === SysObjectTypes.Table)
            .find((o) => o.objectName === name);
        if (!sysObject) {
            throw new Error(`Could not find table with name ${name}`);
        }
        return new Table(name, this.#database, sysObject.tablePage);
    }
}