your-data-patner
v1.0.3
Published
Your Data Partner is a Node.js client library for interacting with YourDB, a cloud-based NoSQL database service. It provides an easy-to-use interface for performing CRUD operations, querying data, and managing your database resources.
Downloads
424
Maintainers
Readme
Your Data Partner
Your Data Partner is a lightweight Node.js client library for interacting with YourDB, a cloud-based NoSQL database service. It provides a clean API for performing CRUD operations, defining schemas, and managing database models with minimal setup.
Installation
Install the package using npm:
npm install your-data-patner
Getting Started Importing the Library const { connect, Schema, model } = require("your-data-patner");
Connecting to YourDB const db = connect("YOUR_DB_URL", { auth: "YOUR_SECRET_KEY" });
YOUR_DB_URLThe base URL of your YourDB instance.
auth Your API token or secret key.
Defining a Schema
Schemas help structure your data and define the expected fields.
const userSchema = new Schema({
name: String,
age: Number,
email: String
});Creating a Model const User = model("users", userSchema, db);
Arguments:
Collection name ("users")Schema
Database connection
CRUD Operations Insert a Document const createdUser = await User.insert({ name: "hi", age: 19, email: "[email protected]" });
Find Documents const users = await User.find({ age: 19 });
Update a Document const updatedUser = await User.update( { name: "hi" }, { age: 20 } );
Delete a Document const result = await User.delete({ name: "hi" });
