https://github.com/travishorn/duckydb

https://github.com/travishorn/duckydb

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/travishorn/duckydb
• Owner: travishorn
• License: mit
• Created: 2024-09-05T20:01:54.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-05T20:01:56.000Z (4 months ago)
• Last Synced: 2024-10-08T21:04:35.723Z (3 months ago)
• Language: JavaScript
• Size: 40 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# DuckyDB

A wrapper class for DuckDB with promise-based queries and named parameters support.

## Installation

```bash

npm install duckydb

```

## Usage

```javascript

// Import the library

import Duckydb from "duckydb";

// Create/connect to a database

const db = new Duckydb("test.duckdb");

// Query the database

const result = await db.query("SELECT * FROM users WHERE name = :name", {

  name: "John",

});

// Log the result

console.log(result);

// Close the database

await db.close();

```

Despite the name, `query()` can be used for any SQL command, not just `SELECT`.

Parameters can be passed in using an object of named parameters as shown above. Or they can be passed in using an array of positional parameters.

```javascript

const result = await db.query("SELECT * FROM users WHERE name = ?", ["John"]);

```

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

If you modify the code, make sure to update the tests and documentation accordingly.

After modifying the code, make sure to run...

- `npm run format` to ensure consistency across the codebase.

- `npm run lint` to ensure there are no linting errors.

- `npm run test` to ensure all the tests pass.

## License

The MIT License (MIT)

Copyright 2024 Travis Horn

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the “Software”), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

the Software, and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.