Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tony133/nestjs-postgres
Postgres module for Nest framework (node.js) 😻
https://github.com/tony133/nestjs-postgres
javascript nest nestjs nestjs-postgres nestjs-postgresql postgres postgresql typescript
Last synced: 12 days ago
JSON representation
Postgres module for Nest framework (node.js) 😻
- Host: GitHub
- URL: https://github.com/tony133/nestjs-postgres
- Owner: Tony133
- License: mit
- Created: 2022-06-23T20:03:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-17T18:32:17.000Z (about 2 months ago)
- Last Synced: 2024-09-18T22:14:04.424Z (about 2 months ago)
- Topics: javascript, nest, nestjs, nestjs-postgres, nestjs-postgresql, postgres, postgresql, typescript
- Language: TypeScript
- Homepage:
- Size: 2.06 MB
- Stars: 18
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
PostgreSQL module for Nest framework (node.js) 😻
## Installation
First install the module via `yarn` or `npm` or `pnpm` and do not forget to install the driver package as well:
```bash
$ npm i --save nest-postgres pg
```
or
```bash
$ yarn add nest-postgres pg
```
or
```bash
$ pnpm add nest-postgres pg
```
## Table of Contents
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [PostgresModule](#postgresmodule)
- [MultiConnectionsDatabase](#multi-connections-database)
- [ExampleOfUse](#example-of-use)
## Usage
### PostgresModule
PostgresModule is the primary entry point for this package and can be used synchronously
```typescript
@Module({
imports: [
PostgresModule.forRoot({
connectionString: 'postgresql://[user]:[password]@[host]/[nameDb]',
// or
// host: 'localhost',
// database: [:databaseName],
// password: [:passwordDb],
// user: [:userDb],
// port: 5432,
}),
],
})
```
or asynchronously
```typescript
@Module({
imports: [
PostgresModule.forRootAsync({
useFactory: () => ({
connectionString: 'postgresql://[user]:[password]@[host]/[nameDb]',
// or
// host: 'localhost',
// database: [:databaseName],
// password: [:passwordDb],
// user: [:userDb],
// port: 5432,
}),
}),
],
})
```
## Example of use
UsersService:
```typescript
import { Client } from 'pg';
import { InjectClient } from 'nest-postgres';
@Injectable()
export class UsersService {
constructor(@InjectClient() private readonly pg: Client) {}
public async findAll(): Promise {
const users = await this.pg.query('SELECT * FROM users');
return users.rows;
}
}
```
UsersController:
```typescript
import { Controller, Get } from '@nestjs/common';
import { UsersService } from './users.service';
@Controller()
export class UsersController {
constructor(private readonly usersService: UsersService) {}
@Get()
async getAllUsers(): Promise {
return await this.usersService.findAll();
}
}
```
## Multi Connections Database
```typescript
@Module({
imports: [
PostgresModule.forRoot(
{
connectionString: 'postgresql://postgres:pass123@localhost:5432/nest1',
// or
// host: 'localhost',
// database: [:databaseName],
// password: [:passwordDb],
// user: [:userDb],
// port: 5432,
},
'db1Connection',
),
PostgresModule.forRoot(
{
connectionString: 'postgresql://postgres:pass123@localhost:5434/nest2',
},
'db2Connection',
),
],
controllers: [],
providers: [],
})
export class AppModule {}
```
Usage example with Multi Connection
PostService:
```typescript
import { Client } from 'pg';
import { InjectConnection } from 'nest-postgres';
import { CreatePostDto } from './dto/create-post.dto';
import { Post } from './interfaces/post.interface';
@Injectable()
export class PostService {
constructor(
@InjectConnection('db2Connection')
private dbConnection: Client,
) {}
public async findAll(): Promise {
const users = await this.dbConnection.query('SELECT * FROM posts');
return users.rows;
}
public async create(createPostDto: CreatePostDto): Promise {
try {
const user = await this.dbConnection.query(
'INSERT INTO posts (title, description) VALUES ($1, $2) RETURNING *',
[createPostDto.title, createPostDto.description],
);
return user.rows;
} catch (err) {
throw new HttpException(err, HttpStatus.BAD_REQUEST);
}
}
}
```
UsersService:
```typescript
import { Client } from 'pg';
import { InjectConnection } from 'nest-postgres';
import { CreateUserDto } from './dto/create-user.dto';
import { User } from './interfaces/user.interface';
@Injectable()
export class UsersService {
constructor(
@InjectConnection('db1Connection')
private dbConnection: Client,
) {}
public async findAll(): Promise {
const users = await this.dbConnection.query('SELECT * FROM users');
return users.rows;
}
public async create(createUserDto: CreateUserDto): Promise {
try {
const user = await this.dbConnection.query(
'INSERT INTO users (firstName, lastName) VALUES ($1, $2) RETURNING *',
[createUserDto.firstName, createUserDto.lastName],
);
return user.rows;
} catch (err) {
throw new HttpException(err, HttpStatus.BAD_REQUEST);
}
}
}
```
For more information on `node-postgres` for Nodejs see [here](https://node-postgres.com/)
## Contribute
Feel free to help this library, I'm quite busy with also another Nestjs packages, but the community will appreciate the effort of improving this library. Make sure you follow the guidelines
## Stay in touch
- Author - [Tony133](https://github.com/Tony133)
- Framework - [https://nestjs.com](https://nestjs.com/)
## License
[MIT licensed](LICENSE)