README
¶
GORM DuckDB Driver
Quick Start
import (
"github.com/hauntedness/duckdb/v2"
"gorm.io/gorm"
)
type Product struct {
ID uint `gorm:"primarykey"`
Code string
Price uint
CreatedAt time.Time
UpdatedAt time.Time
}
func main() {
db, err := gorm.Open(duckdb.Open("duckdb.ddb"), &gorm.Config{})
if err != nil {
panic("failed to connect database")
}
db.AutoMigrate(&Product{})
// Create
db.Create(&Product{Code: "D42", Price: 100})
// Read
var product Product
db.First(&product, 1)
db.First(&product, "code = ?", "D42")
// Update
db.Model(&product).Update("Price", 200)
db.Model(&product).Updates(Product{Price: 200, Code: "F42"})
// Delete
db.Delete(&product, 1)
}
Checkout https://gorm.io for details.
Limitations
deleted_at field
Do not use gorm.Model - use custom struct with ID, CreatedAt, UpdatedAt fields instead.
DuckDB's ART indexes have limitations with soft deletes. When GORM performs db.Delete(), it updates the deleted_at field instead of actually deleting the record, which can cause primary key constraint violations due to how DuckDB handles transactions and indexes.
See DuckDB documentation for details.
Contributing
Any contributions you make are greatly appreciated.
License
This project is licensed under the Apache License 2.0.
Documentation
¶
Index ¶
- Constants
- Variables
- func New(config Config) gorm.Dialector
- func Open(dsn string) gorm.Dialector
- type BuildIndexOptionsInterface
- type Config
- type Dialector
- func (dialector Dialector) BindVarTo(writer clause.Writer, stmt *gorm.Statement, v any)
- func (dialector Dialector) ClauseBuilders() map[string]clause.ClauseBuilder
- func (dialector Dialector) DataTypeOf(field *schema.Field) string
- func (dialector Dialector) DefaultValueOf(field *schema.Field) clause.Expression
- func (dialector Dialector) Explain(sql string, vars ...any) string
- func (dialector Dialector) Initialize(db *gorm.DB) (err error)
- func (dialector Dialector) Migrator(db *gorm.DB) gorm.Migrator
- func (dialector Dialector) Name() string
- func (dialector Dialector) QuoteTo(writer clause.Writer, str string)
- func (dialectopr Dialector) RollbackTo(tx *gorm.DB, name string) error
- func (dialectopr Dialector) SavePoint(tx *gorm.DB, name string) error
- func (dialector Dialector) SupportReturning() bool
- type Migrator
- func (m Migrator) CreateIndex(value any, name string) error
- func (m Migrator) CreateTable(values ...any) (err error)
- func (m Migrator) CreateView(name string, option gorm.ViewOption) error
- func (m Migrator) CurrentDatabase() (name string)
- func (m Migrator) CurrentSchema(stmt *gorm.Statement, table string) (any, any)
- func (m Migrator) DropColumn(dst any, field string) error
- func (m Migrator) DropConstraint(dst any, name string) error
- func (m Migrator) DropIndex(value any, name string) error
- func (m Migrator) DropTable(values ...any) error
- func (m Migrator) DropView(name string) error
- func (m Migrator) FullDataTypeOf(field *schema.Field) clause.Expr
- func (m Migrator) GetTables() (tableList []string, err error)
- func (m Migrator) GetTypeAliases(databaseTypeName string) []string
- func (m Migrator) HasColumn(value any, field string) bool
- func (m Migrator) HasConstraint(value any, name string) bool
- func (m Migrator) HasIndex(value any, name string) bool
- func (m Migrator) HasTable(value any) bool
- func (m Migrator) MigrateColumn(value any, field *schema.Field, columnType gorm.ColumnType) error
- func (m Migrator) RenameColumn(dst any, oldName, field string) error
- func (m Migrator) RenameIndex(dst any, oldName, newName string) error
- func (m Migrator) RenameTable(oldName, newName any) (err error)
Constants ¶
View Source
const DriverName = "duckdb"
Variables ¶
View Source
var ErrDuckDBNotSupported = errors.New("DuckDB are not supported this operation")
View Source
var ErrInvalidAssert = errors.New("Invalid type assertion")
Functions ¶
Types ¶
type BuildIndexOptionsInterface ¶
type BuildIndexOptionsInterface interface {
BuildIndexOptions([]schema.IndexOption, *gorm.Statement) []any
}
type Dialector ¶
type Dialector struct {
*Config
}
func (Dialector) ClauseBuilders ¶
func (dialector Dialector) ClauseBuilders() map[string]clause.ClauseBuilder
func (Dialector) DefaultValueOf ¶
func (dialector Dialector) DefaultValueOf(field *schema.Field) clause.Expression
func (Dialector) RollbackTo ¶
func (Dialector) SupportReturning ¶
type Migrator ¶
func (Migrator) CreateTable ¶
func (Migrator) CreateView ¶
func (m Migrator) CreateView(name string, option gorm.ViewOption) error
Views.
func (Migrator) CurrentDatabase ¶
func (Migrator) CurrentSchema ¶
func (Migrator) DropConstraint ¶
func (Migrator) GetTypeAliases ¶
func (Migrator) MigrateColumn ¶
func (Migrator) RenameTable ¶
Source Files
Click to show internal directories.
Click to hide internal directories.