{"_id":"@ahagandev/mdb-reader","_rev":"1-d7d739826c628c019d86b4e10a5b439a","name":"@ahagandev/mdb-reader","dist-tags":{"latest":"2.2.5"},"versions":{"2.2.5":{"name":"@ahagandev/mdb-reader","version":"2.2.5","description":"JavaScript library to read data from Access databases","main":"lib/node/index.js","browser":"lib/browser/index.js","types":"lib/types/index.d.ts","sideEffects":false,"type":"module","repository":{"type":"git","url":"git+https://github.com/ahaganDEV/mdb-reader.git"},"keywords":["mdb","microsoft","access","database"],"author":{"name":"Andi Pätzold","email":"github@andipaetzold.com","url":"https://github.com/andipaetzold"},"license":"MIT","bugs":{"url":"https://github.com/andipaetzold/mdb-reader/issues"},"homepage":"https://github.com/andipaetzold/mdb-reader#readme","dependencies":{"browserify-aes":"^1.0.0","create-hash":"^1.0.0","fast-xml-parser":"^4.0.0"},"devDependencies":{"@semantic-release/changelog":"6.0.1","@semantic-release/git":"10.0.1","@tsconfig/node14":"^1.0.1","@types/jest":"27.5.0","@types/node":"14.18.16","@typescript-eslint/eslint-plugin":"5.22.0","@typescript-eslint/parser":"5.22.0","eslint":"8.14.0","jest":"28.1.0","rimraf":"3.0.2","semantic-release":"19.0.2","ts-jest":"28.0.1","ttypescript":"1.5.13","typescript":"4.4.4","typescript-transform-extensions":"1.0.1"},"scripts":{"prepublishOnly":"npm run build","prebuild":"rimraf lib","prepare:node":"cp src/environment/node.ts src/environment/index.ts","prepare:browser":"cp src/environment/browser.ts src/environment/index.ts","build":"npm run build:node && npm run build:browser","build:node":"npm run prepare:node && ttsc -P tsconfig.json","build:browser":"npm run prepare:browser && ttsc -P tsconfig.browser.json","test":"npm run test:unit && npm run test:esm","test:unit":"npm run test:unit:node && npm run test:unit:browser","test:unit:node":"npm run prepare:node && jest","test:unit:browser":"npm run prepare:browser && jest","test:esm":"npm run test:esm:node && npm run test:esm:browser","test:esm:node":"node --input-type=module -e \"import MDBReader from './lib/node/index.js';\"","test:esm:browser":"node --input-type=module -e \"import MDBReader from './lib/browser/index.js';\"","lint":"eslint . --ext .ts","semantic-release":"semantic-release"},"publishConfig":{"access":"public"},"gitHead":"e4e74afb8dbc68a158ce2d99e768e4b08a54b040","_id":"@ahagandev/mdb-reader@2.2.5","_nodeVersion":"14.19.2","_npmVersion":"8.3.1","dist":{"integrity":"sha512-q0FY0tiU2dV/9TbmDX0hCb6L88BM6WYJ2J/V5mIJ7TuDH23N/j6CJDZ/Pz7LEKj3S/WwmMQSixT1393EkY1+Fw==","shasum":"771fb99bad66045e5c5d734928a6a64f437f22fa","tarball":"https://registry.npmjs.org/@ahagandev/mdb-reader/-/mdb-reader-2.2.5.tgz","fileCount":189,"unpackedSize":167893,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC2084MJnWyt7wCFV7qszGsXTtPhmncQQBnwKtY/kr+JAIhAJKK3ewZy5O+LJtqnZbVAhXUoG1nJpaPvVOrBvEiT5mK"}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJihl80ACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmp1mA//f0uae49JwvihUXyq2t1fBhSxfCrboR/cM59EWLNLyW1FNG5p\r\ngOTMsA5WM1E/cA7hPu+xmy1Z1ACrIjYHInMeV3WKymANPw7BCkOVHRrjp7/m\r\nArfAPPZbMzRe2tAy7A/c0r0BqJuwq9BD4flVu5v4+xGVfROIMYLjcRbhFIWl\r\n0mw9mZvwpdf02dYTQ3tekCtYNAjvEbGooCEQgEQ3YLt8b7rgmtx5T6kLVMFQ\r\nX4P6X+Mfiwx8KplmE1WJymWPnmMRTsf7E5uT31vcQnKWS61N9uz4gl74Iupg\r\n7bCqvVg0i9DWj/fMdlxPngoQL2XE2p3vHG4Gov+foQZBeex6HwzzzV33XlHh\r\n4GvDJdDbzN9JGdHdYHfHsP5vKa9cTc0CT03ZNUFC9P9SV2WkOeyRvk5XJmS3\r\noOoYxHxe2UqNsEZApW+apm5Cc8+qGGds0E7rbjWmXqwoUzuOeL/Qq73yqEnB\r\noESYBil81C3Y6pVW/J/n18PNr+1jLbXVwQhtFri7fYB4eHeVYp3RHzpq+K+A\r\n9sPrcuVHxHDGlHEircTvOS8ut7kdA/2ItwAKyfAnVA1bipjaYOVFsvQz/Esm\r\nwKMrcqgGxFpwdwMg5IFt/XI1aWVpuBSL5tNz9dkddVOCmoIXZ7SO+yMeYM8S\r\niB70zOj6acbdvdVxk2VHXSKBTAqNYbd1ddA=\r\n=C1Dq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"ahagandev","email":"ahagan@opus2.com"},"directories":{},"maintainers":[{"name":"ahagandev","email":"ahagan@opus2.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mdb-reader_2.2.5_1652973364275_0.6951144084979437"},"_hasShrinkwrap":false,"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2022-05-19T15:16:04.185Z","2.2.5":"2022-05-19T15:16:04.408Z","modified":"2022-07-19T07:42:22.909Z"},"maintainers":[{"name":"ahagandev","email":"ahagan@opus2.com"}],"description":"JavaScript library to read data from Access databases","homepage":"https://github.com/andipaetzold/mdb-reader#readme","keywords":["mdb","microsoft","access","database"],"repository":{"type":"git","url":"git+https://github.com/ahaganDEV/mdb-reader.git"},"author":{"name":"Andi Pätzold","email":"github@andipaetzold.com","url":"https://github.com/andipaetzold"},"bugs":{"url":"https://github.com/andipaetzold/mdb-reader/issues"},"license":"MIT","readme":"[![npm](https://img.shields.io/npm/v/mdb-reader)](https://www.npmjs.com/package/mdb-reader)\n[![tests](https://github.com/andipaetzold/mdb-reader/actions/workflows/build-release.yml/badge.svg?branch=main)](https://github.com/andipaetzold/mdb-reader/actions/workflows/build-release.yml?query=branch%3Amain)\n[![downloads](https://img.shields.io/npm/dm/mdb-reader)](https://www.npmjs.com/package/mdb-reader)\n[![license](https://img.shields.io/github/license/andipaetzold/mdb-reader)](https://github.com/andipaetzold/mdb-reader/blob/main/LICENSE)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n\n# Note\n\nThis is a forked version of the mdb-reader library.\nIt mainly adds the missing parameters to the buffer functions.\n\n`npm install @ahaganDEV/mdb-reader`\n\n# MDB Reader\n\nJavaScript library to read data from Access databases.\n\n## Installation\n\n```sh\nnpm install mdb-reader\n```\n\nor\n\n```sh\nyarn add mdb-reader\n```\n\n## Compatibility\n\n### Node / JavaScript\n\n-   Node 14 and 16\n-   Works in the browser with [buffer](https://www.npmjs.com/package/buffer) ([Example](https://github.com/andipaetzold/mdb-reader/tree/main/examples/browser))\n\n### Access Database versions\n\n-   Access 97 (Jet 3)\n-   Access 2000, XP and 2003 (Jet 4)\n-   Access 2010 (ACE14)\n-   Access 2013 (ACE15)\n-   Access 2016 (ACE16)\n-   Access 2019 (ACE17)\n\n### Encryption\n\n-   Jet\n-   Office Agile\n-   Office RC4 Crypto API\n\n## Dependencies\n\nTo decrypt databases, this library requires a few dependencies:\n\n-   [`browserify-aes`](https://www.npmjs.com/browserify-aes): Only imported when running in browser\n-   [`create-hash`](https://www.npmjs.com/create-hash): Only imported when running in browser\n-   [`fast-xml-parser`](https://www.npmjs.com/fast-xml-parser)\n\n## Usage\n\n```javascript\nimport { readFileSync } from \"fs\";\nimport MDBReader from \"mdb-reader\";\n\nconst buffer = readFileSync(\"database.mdb\");\nconst reader = new MDBReader(buffer);\n\nreader.getTableNames(); // ['Cats', 'Dogs', 'Cars']\n\nconst table = reader.getTable(\"Cats\");\ntable.getColumnNames(); // ['id', 'name', 'color']\ntable.getData(); // [{id: 5, name: 'Ashley', color: 'black'}, ...]\n```\n\n## API\n\n### MDBReader\n\n```typescript\nclass MDBReader {\n    /**\n     * @param buffer Buffer of the database.\n     */\n    constructor(\n        buffer: Buffer,\n        options?: {\n            password?: string;\n        }\n    );\n\n    /**\n     * Date when the database was created\n     */\n    getCreationDate(): Date | null;\n\n    /**\n     * Database password\n     */\n    getPassword(): string | null;\n\n    /**\n     * Default sort order\n     */\n    getDefaultSortOrder(): Readonly<SortOrder>;\n\n    /**\n     * Returns an array of table names.\n     *\n     * @param normalTables Includes user tables.\n     * @param systemTables Includes system tables.\n     * @param linkedTables Includes linked tables.\n     */\n    getTableNames({\n        normalTables,\n        systemTables,\n        linkedTables,\n    }?: {\n        normalTables: boolean;\n        systemTables: boolean;\n        linkedTables: boolean;\n    }): string[];\n\n    /**\n     * Returns a table by its name.\n     *\n     * @param name Name of the table. Case sensitive.\n     */\n    getTable(name: string): Table;\n}\n```\n\n### Table\n\n```typescript\nclass Table {\n\n    /**\n     * Name of the table\n     */\n    readonly name: string,\n\n    /**\n     * Number of rows.\n     */\n    readonly rowCount: number;\n\n    /**\n     * Number of columns.\n     */\n    readonly columnCount: number;\n\n    /**\n     * Returns an ordered array of all column definitions.\n     */\n    getColumns(): Column[];\n\n    /**\n     * Returns a column definition by its name.\n     *\n     * @param name Name of the column. Case sensitive.\n     */\n    getColumn(name: string): Column;\n\n    /**\n     * Returns an ordered array of all column names.\n     */\n    getColumnNames(): string[];\n\n    /**\n     * Returns data from the table.\n     *\n     * @param columns Columns to be returned. Defaults to all columns.\n     * @param rowOffset Index of the first row to be returned. 0-based. Defaults to 0.\n     * @param rowLimit Maximum number of rows to be returned. Defaults to Infinity.\n     */\n    getData<TRow extends {\n        [column in TColumn]: Value;\n        TColumn extends string = string;\n    }>(options?: {\n        columns?: ReadonlyArray<TColumn>;\n        rowOffset?: number;\n        rowLimit?: number;\n    }): TRow[];\n}\n```\n\n### Column\n\n```typescript\ninterface Column {\n    /**\n     * Name of the table\n     */\n    name: string;\n\n    /**\n     * Type of the table\n     */\n    type: ColumnType;\n    size: number;\n\n    fixedLength: boolean;\n    nullable: boolean;\n    autoLong: boolean;\n    autoUUID: boolean;\n\n    /**\n     * Only exists if type = 'numeric'\n     */\n    precision?: number;\n\n    /**\n     * Only exists if type = 'numeric'\n     */\n    scale?: number;\n}\n```\n\n## Data Types\n\nThe data types returned by `Table.getData()` depends on the column type. Null values are always returned as `null`.\n\n| Column Type      | JavaScript Type |\n| ---------------- | --------------- |\n| bigint           | `BigInt`        |\n| binary           | `Buffer`        |\n| boolean          | `boolean`       |\n| byte             | `number`        |\n| complex          | `number`        |\n| currency         | `string`        |\n| datetime         | `Date`          |\n| datetimeextended | `string`        |\n| double           | `number`        |\n| float            | `number`        |\n| integer          | `number`        |\n| long             | `number`        |\n| memo             | `string`        |\n| numeric          | `string`        |\n| ole              | `Buffer`        |\n| repid            | `string`        |\n| text             | `string`        |\n\n## Development\n\n### Build\n\nTo build the library, first install the dependencies, then run `npm run build` for a single build or `npm run watch` for automatic rebuilds.\n\n```sh\nnpm install\nnpm run build\n```\n\n### Tests\n\nTo run the tests, first install the dependencies, then run `npm test`. Watch mode can be started with `npm test -- --watch`.\n\n```sh\nnpm install\nnpm test\n```\n\n## Resources\n\n### MDB Tool\n\n[GitHub](https://github.com/brianb/mdbtools)\n\nSet of applications to read and write Access files, written in C. Main source of knowledge about the file structure and algorithms to extract data from it.\n\n### Jackcess\n\n[Jackcess](https://jackcess.sourceforge.io)\n\nJava library to read and write Access files. It inspired the interface of this library. The databases used for testing are copied from the [repository](https://github.com/jahlborn/jackcess).\n\n## The unofficial MDB Guide\n\n[Tech Specs for the JET format used by Access 1997-2010](http://jabakobob.net/mdb/)\n\n## License\n\n[MIT](LICENSE)\n","readmeFilename":"README.md"}