Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusufshakeel/yacrud
Yet Another Create Read Update and Delete project.
https://github.com/yusufshakeel/yacrud
Last synced: 2 days ago
JSON representation
Yet Another Create Read Update and Delete project.
- Host: GitHub
- URL: https://github.com/yusufshakeel/yacrud
- Owner: yusufshakeel
- License: mit
- Created: 2023-07-03T11:10:56.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-04T06:48:06.000Z (about 1 year ago)
- Last Synced: 2024-11-21T08:30:32.837Z (2 months ago)
- Language: JavaScript
- Size: 1.34 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# yacrud
Yet Another Create Read Update and Delete project.
Quickly run CRUD ops and more on databases like PostgreSQL and MySQL locally and in the Cloud.
[](https://github.com/yusufshakeel/yacrud)
[](https://www.npmjs.com/package/yacrud)
[](https://www.npmjs.com/package/yacrud)
> ```shell
> npm i -g yacrud
> ```
## Use case
This package is for development and testing purposes.
We can use this to create a test database and some tables and then fill them with fake values.
## Table of Contents
- [yacrud](#yacrud)
- [Use case](#use-case)
- [Table of Contents](#table-of-contents)
- [Prerequisite](#prerequisite)
- [Localhost](#localhost)
- [Getting started](#getting-started)
- [Commands](#commands)
- [License](#license)
- [Donate](#donate)
## Prerequisite
* Node (v14 or higher)
* NPM (v6 or higher)
* Database (any of the following supported database)
* PostgreSQL (v11 or higher)
* MySQL (v5 or higher)
* MariaDB (v9 or higher)
* DBeaver (Optional)
* MySQL Workbench (Optional)
#### Localhost
Start the database server and then use `yacrud`.
## Getting started
Install this package globally.
```shell
npm i -g yacrud
```
## Commands
```
Usage: yacrud --help
Usage: yacrud command [-option=value]
Usage: yacrud command --help
Default database: PostgreSQL
Supported: PostgreSQL, MySQL, MariaDB
Commands:
=========================================
version Print the version.
init Initialise yacrud.
all [Re]create the default database, tables and fill it with fake values.
create-database Create the default database 'yacrud'.
recreate-database Recreate the default database 'yacrud'.
drop-database Drop the default database 'yacrud'.
create-tables Create the default tables.
recreate-tables Recreate the default tables.
fill-tables Fill the default tables with fake values.
list-tables List all the tables.
read Read rows from a table.
Configuration file:
=========================================
Run the following command to setup configuration file.
➜ yacrud init
The init command creates the .yacrudrc file in the home directory.
Database flags:
=========================================
Following are the flags that can be used with the above commands.
Note! Inline database flags overrides the .yacrudrc flags.
+------+---------------+---------------+
| Flag | Default Value | Note |
|------|---------------|---------------|
| -d | yacrud | Database name |
| -h | localhost | Hostname |
| -p | 5432 | Port |
| -U | | Username |
| -P | | Password |
| -C | pg | Client name |
+------+---------------+---------------+
The database name (-d flag) is always converted to lowercase.
Values for -C flag.
pg PostgreSQL
mysql MySQL/MariaDB
Example:
➜ yacrud init -C=pg -h=localhost -p=5432 -d=yacrud -U=yusufshakeel -P=root1234
➜ yacrud init -C=mysql -h=localhost -p=3306 -d=yacrud -U=yusufshakeel -P=root1234
```
## License
It's free :smiley:
[MIT License](https://github.com/yusufshakeel/yacrud/blob/main/LICENSE) Copyright (c) 2023 Yusuf Shakeel
### Donate
Feeling generous :smiley: [Donate via PayPal](https://www.paypal.me/yusufshakeel)