crud-some
TypeScript icon, indicating that this package has built-in type declarations

1.0.11 • Public • Published

CRUD-Some Database Interaction Library Documentation

CRUD-Some is a database interaction library that provides functions to perform CRUD (Create, Read, Update, Delete) operations on different types of databases including PostgreSQL, MySQL, and SQLite.

Table of Contents

Getting Started

To use CRUD-Some, install the library using npm:

npm install crud-some

Supported Databases

The crud-some package supports the following databases:

  • PostgreSQL
  • MySQL
  • SQLite

Functions

connectDatabase(databaseType, config)

This function establishes a connection to the specified database.

  • databaseType (string): The type of the database (postgres, mysql, or sqlite).
  • config (object): Configuration options for connecting to the database.
import { connectDatabase } from 'crud-some';

const databaseType = 'postgres'; // Replace with your desired database type
const config = {
    // use the IConfigDB Interface for help
};

const db = await connectDatabase(databaseType, config);

createSome(db, tableName, data)

Use this function to insert a new record into the specified table with the provided data.

  • db (DatabaseConnection): The database connection.
  • tableName (string): The name of the table.
  • data (object): The data to be inserted.
import { createSome } from 'crud-some';

const newData = { name: 'John', age: 30 };
await createSome(db, 'users', newData);

getAll(db, tableName)

Retrieve all records from the specified table.

  • db (DatabaseConnection): The database connection.
  • tableName (string): The name of the table.
import { getAll } from 'crud-some';

const allRecords = await getAll(db, 'users');

getWhere(db, where)

Retrieve records from the specified table based on the provided conditions.

  • db (DatabaseConnection): The database connection.
  • where (object): The conditions for filtering records.
import { getWhere } from 'crud-some';

const whereConditions = { users: { age: 30 } };
const filteredRecords = await getWhere(db, whereConditions);

getFirst(db, where, orderBy)

Retrieve the first record from the specified table based on the provided conditions.

  • db (DatabaseConnection): The database connection.
  • where (object): The conditions for filtering records.
  • orderBy (string, optional): The order of the results (ASC or DESC).
import { getFirst } from 'crud-some';

const whereConditions = { users: { name: 'John' } };
const firstRecord = await getFirst(db, whereConditions, 'ASC');

updateSome(db, where, data)

Update records in the specified table based on the provided conditions with the new data.

  • db (DatabaseConnection): The database connection.
  • where (object): The conditions for filtering records to be updated.
  • data (object): The new data to update the records with.
import { updateSome } from 'crud-some';

const updateConditions = { users: { name: 'John' } };
const updatedData = { age: 31 };
await updateSome(db, updateConditions, updatedData);

deleteSome(db, tableName)

Delete all records from the specified table.

  • db (DatabaseConnection): The database connection.
  • tableName (string): The name of the table.
import { deleteSome } from 'crud-some';

await deleteSome(db, 'users');

For more information and examples, please visit the GitHub repository.

Readme

Keywords

none

Package Sidebar

Install

npm i crud-some

Weekly Downloads

2

Version

1.0.11

License

ISC

Unpacked Size

26.9 kB

Total Files

8

Last publish

Collaborators

  • izaananwar