Philipp Kunz d957e911de fix(documentation): Remove license badge from README

2025-02-03 14:06:42 +01:00

7.1 KiB

Raw Permalink Blame History

@push.rocks/smartdata

A powerful TypeScript-first MongoDB wrapper that provides advanced features for distributed systems, real-time data synchronization, and easy data management.

Features

Type-Safe MongoDB Integration: Full TypeScript support with decorators for schema definition
EasyStore: Simple key-value storage with automatic persistence and sharing between instances
Distributed Coordination: Built-in support for leader election and distributed task management
Real-time Data Sync: Watchers for real-time data changes and synchronization
Connection Management: Automatic connection handling with connection pooling
Collection Management: Type-safe collection operations with automatic indexing

Requirements

Node.js >= 16.x
MongoDB >= 4.4
TypeScript >= 4.x (for development)

Install

To install @push.rocks/smartdata, use npm:

npm install @push.rocks/smartdata --save

This will add @push.rocks/smartdata to your project's dependencies.

Usage

@push.rocks/smartdata enables efficient data handling and operation management with a focus on using MongoDB. It leverages TypeScript for strong typing and ESM syntax for modern JavaScript usage. Below are various scenarios demonstrating how to utilize this package effectively in a project.

Setting Up and Connecting to the Database

Before interacting with the database, you need to set up and establish a connection. The SmartdataDb class handles connection pooling and automatic reconnection.

import { SmartdataDb } from '@push.rocks/smartdata';

// Create a new instance of SmartdataDb with MongoDB connection details
const db = new SmartdataDb({
  mongoDbUrl: 'mongodb://<USERNAME>:<PASSWORD>@localhost:27017/<DBNAME>',
  mongoDbName: 'your-database-name',
  mongoDbUser: 'your-username',
  mongoDbPass: 'your-password',
});

// Initialize and connect to the database
// This sets up a connection pool with max 100 connections
await db.init();

Defining Data Models

Data models in @push.rocks/smartdata are classes that represent collections and documents in your MongoDB database. Use decorators such as @Collection, @unI, and @svDb to define your data models.

import { SmartDataDbDoc, Collection, unI, svDb } from '@push.rocks/smartdata';

@Collection(() => db)  // Associate this model with the database instance
class User extends SmartDataDbDoc<User, User> {
  @unI()
  public id: string = 'unique-user-id'; // Mark 'id' as a unique index
  
  @svDb()
  public username: string;  // Mark 'username' to be saved in DB
  
  @svDb()
  public email: string;  // Mark 'email' to be saved in DB
  
  constructor(username: string, email: string) {
    super();
    this.username = username;
    this.email = email;
  }
}

Performing CRUD Operations

@push.rocks/smartdata simplifies CRUD operations with intuitive methods on model instances.

Create

const newUser = new User('myUsername', 'myEmail@example.com');
await newUser.save();  // Save the new user to the database

Read

// Fetch a single user by a unique attribute
const user = await User.getInstance({ username: 'myUsername' });

// Fetch multiple users that match criteria
const users = await User.getInstances({ email: 'myEmail@example.com' });

Update

// Assuming 'user' is an instance of User
user.email = 'newEmail@example.com';
await user.save();  // Update the user in the database

Delete

// Assuming 'user' is an instance of User
await user.delete();  // Delete the user from the database

Advanced Features

EasyStore

EasyStore provides a simple key-value storage system with automatic persistence:

// Create an EasyStore instance
const store = await db.createEasyStore<YourDataType>('store-name');

// Write and read data
await store.writeKey('key', value);
const value = await store.readKey('key');

Distributed Coordination

Built-in support for distributed systems with leader election:

// Create a distributed coordinator
const coordinator = new SmartdataDistributedCoordinator(db);

// Start coordination
await coordinator.start();

// Handle leadership changes
coordinator.on('leadershipChange', (isLeader) => {
  if (isLeader) {
    // This instance is now the leader
  }
});

Real-time Data Watching

Watch for changes in your collections:

const watcher = new SmartdataDbWatcher(collection);

watcher.on('change', (change) => {
  console.log('Document changed:', change);
});

await watcher.start();

Conclusion

With its focus on TypeScript, modern JavaScript syntax, and leveraging MongoDB's features, @push.rocks/smartdata offers a powerful toolkit for data handling and operations management in Node.js applications. Its design for ease of use, coupled with advanced features, makes it a versatile choice for developers looking to build efficient and scalable data-driven applications.

For more details on usage and additional features, refer to the official documentation and explore the various classes and methods provided by @push.rocks/smartdata.

Contributing

We welcome contributions to @push.rocks/smartdata! Here's how you can help:

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

Please make sure to update tests as appropriate and follow our coding standards.

License and Legal Information

This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the license file within this repository.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.

7.1 KiB Raw Permalink Blame History