https://github.com/shiny/adonis-clickhouse
clickhouse-client wrapper for AdonisJS v6
https://github.com/shiny/adonis-clickhouse
Last synced: 2 months ago
JSON representation
clickhouse-client wrapper for AdonisJS v6
- Host: GitHub
- URL: https://github.com/shiny/adonis-clickhouse
- Owner: shiny
- License: mit
- Created: 2024-03-07T07:30:52.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-07T20:14:26.000Z (about 1 year ago)
- Last Synced: 2025-04-01T22:04:15.121Z (2 months ago)
- Language: TypeScript
- Size: 16.6 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ClickHouse for AdonisJS v6
A third-party wrapper for `@clickhouse/client` in AdonisJS v6.
> [!CAUTION]
> This package is not compatible with AdonisJS v5.
Copied a lot from Inspired a lot by [@adonijs/redis](https://github.com/adonisjs/redis/).
## Installation
```bash
node ace add adonis-clickhouse
```
## Configuration
You can change it in `config/clickhouse.ts`, it's all same with `createClient` Configuration.
here is the details: https://clickhouse.com/docs/en/integrations/language-clients/javascript#configuration
## Environment Variables
|Variable|Description|Default Value|
|---|---|---|
|`CLICKHOUSE_DB`|Database Name|`default`|
|`CLICKHOUSE_USER`| User|`default`|
|`CLICKHOUSE_PASSWORD`| Password|empty string `''`|
|`CLICKHOUSE_HOST`| Clickhouse connect url|`http://localhost:8123`|
|`CLICKHOUSE_REQUEST_TIMEOUT`|The request timeout in milliseconds.|`30000`(30s)|
|`CLICKHOUSE_COMPRESSION_REQUEST`| Enables compression on the client request body|`false`|
|`CLICKHOUSE_COMPRESSION_RESPONSE`| Instructs ClickHouse server to respond with compressed response body. |`true`|
## How to import
As it is a container service, you can init it by
```typescript
await app.container.make('clickhouse')
```
or
```typescript
import clickhouse from 'adonis-clickhouse/services/main'
```
The way same as `@adonisjs/redis`.
### Query
The imported clickhouse actully is a instance of `@clickhouse/client` Client, hence those codes are equal:
An example of `adonis-clickhouse`
```typescript
import clickhouse from 'adonis-clickhouse/services/main'
await clickhouse.query({
/* QueryParams */
})
```
Equaled offical library example
```typescript
import { createClient } from '@clickhouse/client'
const client = createClient({
/* configuration */
})
await client.query({
/* QueryParams */
})
```
## Multi Database Instances
You can config the multi databases and use `manager` to connect it.
```typescript
import { manager } from 'adonis-clickhouse/services/main'
// Change main to the name you defined.
const client = manager.connect('main')
await client.query({
/* QueryParams */
})
```
## Documentation
See [Offical ClickHouse JS Library](https://clickhouse.com/docs/en/integrations/language-clients/javascript)
## Who's Using
[Create an issue](https://github.com/shiny/adonis-clickhouse/issues/new) to submit your project.
## Contributors
This project is contributed by u301 team for giving back to the AdonisJS community.
If you are looking for a queue solution for AdonisJS, take a look at [adonis-resque](https://github.com/shiny/adonis-resque).
## Lisence
the MIT
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fshiny%2Fadonis-clickhouse?ref=badge_large)