Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/go-gorm/clickhouse
GORM clickhouse driver
https://github.com/go-gorm/clickhouse
Last synced: 15 days ago
JSON representation
GORM clickhouse driver
- Host: GitHub
- URL: https://github.com/go-gorm/clickhouse
- Owner: go-gorm
- License: mit
- Fork: true (danielkurniadi/clickhouse)
- Created: 2020-09-24T02:25:43.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T10:25:27.000Z (28 days ago)
- Last Synced: 2024-10-20T10:20:39.403Z (25 days ago)
- Language: Go
- Size: 208 KB
- Stars: 247
- Watchers: 6
- Forks: 72
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# GORM ClickHouse Driver
Clickhouse support for GORM
[](https://github.com/go-gorm/clickhouse/actions)
## Quick Start
You can simply test your connection to your database with the following:
```go
package main
import (
"gorm.io/driver/clickhouse"
"gorm.io/gorm"
)
type User struct {
Name string
Age int
}
func main() {
dsn := "clickhouse://gorm:gorm@localhost:9942/gorm?dial_timeout=10s&read_timeout=20s"
db, err := gorm.Open(clickhouse.Open(dsn), &gorm.Config{})
if err != nil {
panic("failed to connect database")
}
// Auto Migrate
db.AutoMigrate(&User{})
// Set table options
db.Set("gorm:table_options", "ENGINE=Distributed(cluster, default, hits)").AutoMigrate(&User{})
// Set table cluster options
db.Set("gorm:table_cluster_options", "on cluster default").AutoMigrate(&User{})
// Insert
db.Create(&User{Name: "Angeliz", Age: 18})
// Select
db.Find(&User{}, "name = ?", "Angeliz")
// Batch Insert
user1 := User{Age: 12, Name: "Bruce Lee"}
user2 := User{Age: 13, Name: "Feynman"}
user3 := User{Age: 14, Name: "Angeliz"}
var users = []User{user1, user2, user3}
db.Create(&users)
// ...
}
```
## Advanced Configuration
```go
package main
import (
std_ck "github.com/ClickHouse/clickhouse-go/v2"
"gorm.io/driver/clickhouse"
"gorm.io/gorm"
)
sqlDB, err := std_ck.OpenDB(&std_ck.Options{
Addr: []string{"127.0.0.1:9999"},
Auth: std_ck.Auth{
Database: "default",
Username: "default",
Password: "",
},
TLS: &tls.Config{
InsecureSkipVerify: true,
},
Settings: std_ck.Settings{
"max_execution_time": 60,
},
DialTimeout: 5 * time.Second,
Compression: &std_ck.Compression{
std_ck.CompressionLZ4,
},
Debug: true,
})
func main() {
db, err := gorm.Open(clickhouse.New(click.Config{
Conn: sqlDB, // initialize with existing database conn
})
}
```
```go
package main
import (
"gorm.io/driver/clickhouse"
"gorm.io/gorm"
)
// refer to https://github.com/ClickHouse/clickhouse-go
var dsn = "clickhouse://username:password@host1:9000,host2:9000/database?dial_timeout=200ms&max_execution_time=60"
func main() {
db, err := gorm.Open(clickhouse.New(click.Config{
DSN: dsn,
Conn: conn, // initialize with existing database conn
DisableDatetimePrecision: true, // disable datetime64 precision, not supported before clickhouse 20.4
DontSupportRenameColumn: true, // rename column not supported before clickhouse 20.4
DontSupportEmptyDefaultValue: false, // do not consider empty strings as valid default values
SkipInitializeWithVersion: false, // smart configure based on used version
DefaultGranularity: 3, // 1 granule = 8192 rows
DefaultCompression: "LZ4", // default compression algorithm. LZ4 is lossless
DefaultIndexType: "minmax", // index stores extremes of the expression
DefaultTableEngineOpts: "ENGINE=MergeTree() ORDER BY tuple()",
}), &gorm.Config{})
}
```
Checkout [https://gorm.io](https://gorm.io) for details.