flyhigh-hifi / nest-clickhouse

Clickhouse client module for nest framework

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

Description

Clickhouse module for Nest based on the official clickhouse package.

Installation

$ npm i --save @nestjs/clickhouse clickhouse

Usage

Import ClickhouseModule:

@Module({
  imports: [ClickhouseModule.register({
    url: 'http://localhost',
    port: 8123,
    debug: false
  })],
  providers: [...],
})
export class AnalyticsModule {}

Inject ClickhouseService:

@Injectable()
export class AnalyticsService {
  constructor(private readonly analyticsService: ClickhouseService) {}
}

API Spec

The ClickhouseService exposes native clickhouse methods and wraps them in the Observable.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

License

Nest is MIT licensed.