https://github.com/daniel-boll/scylla-javascript-driver

A ScyllaDB Driver alternative for Nodejs, Javascript and Typescript written using Node API through Rust bindings
https://github.com/daniel-boll/scylla-javascript-driver

hacktoberfest hacktoberfest-2024 javascript napi-rs nodejs rust rust-lang scylladb scylladb-driver typescript

Last synced: about 17 hours ago
JSON representation

A ScyllaDB Driver alternative for Nodejs, Javascript and Typescript written using Node API through Rust bindings

• Host: GitHub
• URL: https://github.com/daniel-boll/scylla-javascript-driver
• Owner: Daniel-Boll
• License: mit
• Created: 2023-10-14T00:02:09.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-23T18:04:44.000Z (13 days ago)
• Last Synced: 2024-10-24T16:09:42.229Z (12 days ago)
• Topics: hacktoberfest, hacktoberfest-2024, javascript, napi-rs, nodejs, rust, rust-lang, scylladb, scylladb-driver, typescript
• Language: Rust
• Homepage: https://www.scylladb.com/
• Size: 3.35 MB
• Stars: 46
• Watchers: 4
• Forks: 3
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  

[![ScyllaDB Unnoficial Discord Server](https://img.shields.io/badge/ScyllaDB_Developers-Discord_Server-4C388C)](https://discord.gg/CzCT4cyRrr)






  

    

  


  
🚀 ScyllaDB NodeJS Driver 🧪🔧



## ⚠️ Disclaimer ⚠️

This repository and the associated npm package are currently in a 🐣 pre-release state and are being used for testing 🧪 purposes. They are subject to change without notice 📝. Users are encouraged to use this driver with caution ❗ and not in production environments until the official release.

## 🚀 Getting Started 🚀

These instructions will get you a copy of the project up and running 🏃 on your local machine for development and testing purposes.

### 📋 Prerequisites 📋

- Docker: We use Docker 🐳 to run the Scylla database easily without the need for a complex local setup.

- Node.js: Make sure you have Node.js installed on your system to run JavaScript code.

### 🌟 Quickstart 🌟

1. **Start ScyllaDB in Docker:**

   Run a ScyllaDB instance using the following Docker command:

   ```bash

   docker run --name scylladb -d --rm -it -p 9042:9042 scylladb/scylla --smp 2

   ```

   This command pulls the Scylla image if it's not already present on your system, and starts a new 🌟 container with the Scylla database.

2. **Use the JavaScript Driver:**

   Here's a simple script to connect to the database and execute a query:

   ```javascript

   import { Cluster } from "@lambda-group/scylladb";

   const cluster = new Cluster({

     nodes: ["127.0.0.1:9042"],

   });

   const session = await cluster.connect("system_schema");

   const result = await session

     .execute("SELECT * FROM scylla_tables limit ?", [1])

     .catch(console.error);

   console.log(result);

   ```

   This script connects to the ScyllaDB instance running on your machine, performs a query, and logs the result.

### 📥 Installing 📥

To install this package, use the following command:

```bash

npm install @lambda-group/scylladb@latest

```

## 📚 Examples 📚

Reference wise you can guide yourself through the [examples/](https://github.com/Daniel-Boll/scylla-javascript-driver/tree/main/examples) folder in the repo.

## 🙏 Acknowledgments 🙏

- Thanks to the developers of ScyllaDB for creating such a high-performance database.

- Thanks to the Rust community for providing the robust `scylla` crate.

- Thanks to the `napi-rs` project for enabling efficient Rust and Node.js integrations.