Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ranjanrak/clickhouse-graphql-go
GraphQL implementation for click house in Go.
https://github.com/ranjanrak/clickhouse-graphql-go
clickhouse golang graphql stream
Last synced: 2 days ago
JSON representation
GraphQL implementation for click house in Go.
- Host: GitHub
- URL: https://github.com/ranjanrak/clickhouse-graphql-go
- Owner: ranjanrak
- License: mit
- Created: 2021-08-24T10:57:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-20T07:52:40.000Z (over 2 years ago)
- Last Synced: 2024-06-20T15:55:02.519Z (5 months ago)
- Topics: clickhouse, golang, graphql, stream
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clickhouse-graphql-go
[](https://github.com/ranjanrak/clickhouse-graphql-go/actions/workflows/go-test.yml)
[](https://pkg.go.dev/github.com/ranjanrak/clickhouse-graphql-go/[email protected])
[](https://goreportcard.com/report/github.com/ranjanrak/clickhouse-graphql-go/v4)
GraphQL implementation for clickhouse in Go.
This package stores real time [streaming websocket data](https://kite.trade/docs/connect/v3/websocket/) in [clickhouse](https://clickhouse.tech/) and uses [GraphQL](https://graphql.org/) to consume the same.
## Installation
```
go get github.com/ranjanrak/clickhouse-graphql-go/v4
```
## Usage
```go
import (
clickhousegraphqlgo "github.com/ranjanrak/clickhouse-graphql-go/v4"
)
// Create new graphql instance
client := clickhousegraphqlgo.New(clickhousegraphqlgo.ClientParam{
DBSource: "tcp://127.0.0.1:9000?debug=true",
ApiKey: "your_api_key",
AccessToken: "your_access_token",
}))
// Dump tick websocket data to clickhouse
// Pass list of instrument token for subscription to websocket feeds
// Nothing will run after this
client.ClickhouseDump([]uint32{779521, 256265, 1893123, 13209858})
// Query
reqQuery := `query {
Tick(instrument_token:779521) {
instrument_token
timestamp
lastprice
volumetraded
oi
}
}`
// Make single object schema graphql Query
singleQueryStruct, err := client.GraphqlQuery(reqQuery)
if err != nil {
log.Fatalf("failed to execute single object graphql query, errors: %+v", err)
}
fmt.Printf("%+v\n", singleQueryStruct)
// Make list of object schema graphqlQuery
listQueryStruct, err := client.GraphqlQueryList(reqQuery)
if err != nil {
log.Fatalf("failed to execute object list graphql query, errors: %+v", err)
}
fmt.Printf("%+v\n", listQueryStruct)
// Run graphql server on clickhouse with single schema
client.GraphqlServer("")
// Run graphql server to fetch list of object schema GraphQL
client.GraphqlServer("List")
```
#### GraphQL request query
1> `GraphqlQuery(reqQuery)`
```
reqQuery := `query {
Tick(instrument_token:779521) {
instrument_token
timestamp
lastprice
volumetraded
oi
}
}`
```
2> `GraphqlQueryList(reqQuery)`
```
reqQuery := `query {
Tick(instrument_token:779521) {
instrument_token
timestamp
lastprice
volumetraded
oi
}
}`
```
3> `GraphqlServer("")`
```
query {
Tick(instrument_token:779521) {
instrument_token
timestamp
lastprice
volumetraded
oi
}
}
```
4> `GraphqlServer("List")`
```
query {
Tick(instrument_token:779521) {
instrument_token
timestamp
lastprice
volumetraded
oi
}
}
```
## Response
1> `GraphqlQuery(reqQuery)`
```
{Output:{InstrumentToken:779521 LastPrice:463.4 OI:0 Timestamp:2022-06-07 17:12:48 +0530 IST
VolumeTraded:7672515}}
```
2> `GraphqlQueryList(reqQuery)`
```
{Output:[{InstrumentToken:779521 LastPrice:463.4 OI:0 Timestamp:2022-06-07 17:12:48 +0530 IST
VolumeTraded:7672515}
{InstrumentToken:779521 LastPrice:463.4 OI:0 Timestamp:2022-06-07 17:12:48 +0530 IST
VolumeTraded:7672515}
{InstrumentToken:779521 LastPrice:463.4 OI:0 Timestamp:2022-06-07 17:12:48 +0530 IST
VolumeTraded:7672515}
....
```
3> `GraphqlServer("")`
```
{
"data": {
"Tick": {
"instrument_token": 1893123,
"lastprice": 74.245,
"oi": 1990638,
"timestamp": "2021-08-24T16:38:39+05:30",
"volumetraded": 1099802
}
}
}
```
4> `GraphqlServer("List")`
```
{
"data": {
"Tick": [
{
"instrument_token": 779521,
"lastprice": 412.65,
"oi": 0,
"timestamp": "2021-08-26T12:19:09+05:30",
"volumetraded": 7619425
},
{
"instrument_token": 779521,
"lastprice": 412.65,
"oi": 0,
"timestamp": "2021-08-26T12:19:09+05:30",
"volumetraded": 7619425
},
......]
}
}
```
#### Sample query on graphiQL UI
1> `GraphqlServer("")`
2> `GraphqlServer("List")`
