https://github.com/deepakb/database-hub

Connect to multiple types of databases including MySQL, PostgreSQL, MongoDB, CosmosDB, and Couchbase with a single, easy-to-use interface.
https://github.com/deepakb/database-hub

Last synced: about 1 year ago
JSON representation

Connect to multiple types of databases including MySQL, PostgreSQL, MongoDB, CosmosDB, and Couchbase with a single, easy-to-use interface.

• Host: GitHub
• URL: https://github.com/deepakb/database-hub
• Owner: deepakb
• License: mit
• Created: 2023-01-03T13:20:01.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T12:26:17.000Z (over 3 years ago)
• Last Synced: 2025-02-05T18:06:12.646Z (over 1 year ago)
• Language: TypeScript
• Size: 46.9 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# database-hub

Connect to multiple types of databases including MySQL, PostgreSQL, MongoDB, CosmosDB, and Couchbase with a single, easy-to-use interface.

## Installation

To install `database-hub`, run the following command:

![image](https://user-images.githubusercontent.com/1321311/210366631-7f9f2bff-b345-4365-80ac-9095db744f74.png)

## Usage

To use `database-hub`, import the desired database functions and pass the necessary options.

![image](https://user-images.githubusercontent.com/1321311/210366782-211f3855-beea-44d9-bbdc-933b7012fd31.png)

## Options

### MySQL

- `host`: The hostname of the MySQL server. (required)

- `user`: The username to connect to the MySQL server. (required)

- `password`: The password for the user. (required)

- `database`: The database to connect to. (required)

### PostgreSQL

- `host`: The hostname of the PostgreSQL server. (required)

- `user`: The username to connect to the PostgreSQL server. (required)

- `password`: The password for the user. (required)

- `database`: The database to connect to. (required)

### MongoDB

- `url`: The URL of the MongoDB server. (required)

### CosmosDB

- `endpoint`: The endpoint URL of the CosmosDB account. (required)

- `auth`: An object containing the authentication options. (required)

  - `masterKey`: The master key for the CosmosDB account. (required)

### Couchbase

- `url`: The URL of the Couchbase cluster. (required)

## License

`database-hub` is licensed under the MIT License. See the [LICENSE](LICENSE) file for more information.