ydb

README

GORM YDB Driver

YDB support for GORM

Quick Start

You can simply test your connection to your database with the following:

package main

import (
	ydb "github.com/ydb-platform/gorm-driver"
	"gorm.io/gorm"
)

type User struct {
	Name string `gorm:"primarykey"`
	Age  int
}

func main() {
	db, err := gorm.Open(ydb.Open("grpc://localhost:2136/local"))
	if err != nil {
		panic("failed to connect database")
	}

	// Auto Migrate
	db.AutoMigrate(&User{})

	// Insert
	db.Create(&User{Name: "Angeliz", Age: 18})

	// Select
	db.Find(&User{}, "name = ?", "Angeliz")

	// Batch Insert
	user1 := User{Name: "Charles", Age: 12}
	user2 := User{Name: "Feynman", Age: 13}
	user3 := User{Name: "Michael", Age: 14}
	users := []User{user1, user2, user3}
	db.Create(&users)

	// ...
}

Documentation

Overview

Example (Query)

package main

import (
	"context"
	"fmt"

	environ "github.com/ydb-platform/ydb-go-sdk-auth-environ"
	"gorm.io/gorm"

	ydb "github.com/ydb-platform/gorm-driver"
)

func main() {
	type Product struct {
		ID    uint `gorm:"primarykey;not null;autoIncrement:false"`
		Code  string
		Price uint `gorm:"index"`
	}

	db, err := gorm.Open(
		ydb.Open("grpc://localhost:2136/local",
			ydb.With(environ.WithEnvironCredentials()),
		),
	)
	if err != nil {
		panic(err)
	}

	db = db.Debug()

	// Migrate the schema
	err = db.AutoMigrate(&Product{})
	if err != nil {
		panic(err)
	}

	// Create
	err = db.Create(&Product{ID: 1, Code: "D42", Price: 100}).Error
	if err != nil {
		panic(err)
	}

	// Scan query
	var products []Product
	err = db.
		WithContext(ydb.WithQueryMode(context.Background(), ydb.ScanQueryMode)).
		Model(&Product{}).
		Scan(&products).
		Error
	if err != nil {
		panic(err)
	}

	// Read
	var product Product
	err = db.First(&product, 1).Error // find product with integer primary key
	if err != nil {
		panic(err)
	}

	fmt.Printf("%+v\n", product)

	err = db.First(&product, "code = ?", "D42").Error // find product with code D42
	if err != nil {
		panic(err)
	}

	fmt.Printf("%+v\n", product)

	// Update - update product's price to 200
	err = db.Model(&product).Update("Price", 200).Error
	if err != nil {
		panic(err)
	}

	// Update - update multiple fields
	err = db.Model(&product).Updates(Product{Price: 200, Code: "F42"}).Error // non-zero fields
	if err != nil {
		panic(err)
	}

	err = db.Model(&product).Updates(map[string]interface{}{"Price": 200, "Code": "F42"}).Error
	if err != nil {
		panic(err)
	}

	// Delete - delete product
	err = db.Delete(&product, 1).Error
	if err != nil {
		panic(err)
	}

	// Drop table
	err = db.Migrator().DropTable(&Product{})
	if err != nil {
		panic(err)
	}
}

Index

• Constants
• func Open(dsn string, opts ...Option) gorm.Dialector
• func WithQueryMode(ctx context.Context, mode QueryMode) context.Context
• type Option
  • func With(opts ...ydb.Option) Option
  • func WithConnMaxIdleTime(d time.Duration) Option
  • func WithMaxIdleConns(n int) Option
  • func WithMaxOpenConns(n int) Option
  • func WithTablePathPrefix(tablePathPrefix string) Option
• type QueryMode

Examples

• Package (Query)

Constants

const (
	DataQueryMode      = ydb.DataQueryMode
	ExplainQueryMode   = ydb.ExplainQueryMode
	ScanQueryMode      = ydb.ScanQueryMode
	SchemeQueryMode    = ydb.SchemeQueryMode
	ScriptingQueryMode = ydb.ScriptingQueryMode
)

Functions

func Open

func Open(dsn string, opts ...Option) gorm.Dialector

func WithQueryMode

func WithQueryMode(ctx context.Context, mode QueryMode) context.Context

Types

type Option

type Option = dialect.Option

func With

func With(opts ...ydb.Option) Option

func WithConnMaxIdleTime

func WithConnMaxIdleTime(d time.Duration) Option

func WithMaxIdleConns

func WithMaxIdleConns(n int) Option

func WithMaxOpenConns

func WithMaxOpenConns(n int) Option

func WithTablePathPrefix

func WithTablePathPrefix(tablePathPrefix string) Option

type QueryMode

type QueryMode = ydb.QueryMode