gormbulk

README

Gorm Bulk Insert

Gorm Bulk Insert is a library to implement bulk insert using gorm. Execute bulk insert just by passing a slice of struct, as if you were using a gorm regularly.

Purpose

When saving a large number of records in database, inserting at once - instead of inserting one by one - leads to significant performance improvement. This is widely known as bulk insert.

Gorm is one of the most popular ORM and contains very developer-friendly features, but bulk insert is not provided.

This library is aimed to solve the bulk insert problem.

Installation

$ go get github.com/t-tiger/gorm-bulk-insert

This library depends on gorm, following command is also necessary unless you've installed gorm.

$ go get github.com/jinzhu/gorm

Usage

Dependency: It depends on 1.9.3 or later version of Gorm. If you've installed earlier version, please update gorm.

gormbulk.BulkInsert(db, sliceValue, 3000)

Third argument specifies the maximum number of records to bulk insert at once. This is because inserting a large number of records and embedding variable at once will exceed the limit of prepared statement.

Depending on the number of variables included, 2000 to 3000 is recommended.

gormbulk.BulkInsert(db, sliceValue, 3000, "Name", "Email")

Basically, inserting struct values are automatically chosen. However if you want to exclude some columns explicitly, you can specify as argument.

In the above pattern Name and Email fields are excluded.

Feature

• Just pass a slice of struct as using gorm normally, records will be created.
  • NOTE: passing value must be a slice of struct. Map or other values are not compatible.
• CreatedAt and UpdatedAt are automatically set to the current time.
• Fields of relation such as belongsTo and hasMany are automatically excluded, but foreignKey is subject to Insert.

Example

package main

import (
	"fmt"
	"github.com/jinzhu/gorm"
	"github.com/t-tiger/gorm-bulk-insert"
	"log"
	"time"
	_ "github.com/jinzhu/gorm/dialects/mysql"
)

type fakeTable struct {
	ID        int
	Name      string
	Email     string
	CreatedAt time.Time
	UpdatedAt time.Time
}

func main() {
	db, err := gorm.Open("mysql", "mydb")
	if err != nil {
		log.Fatal(err)
	}

	var insertRecords []interface{}
	for i := 0; i < 10; i++ {
		insertRecords = append(insertRecords,
			fakeTable{
				Name:  fmt.Sprintf("name%d", i),
				Email: fmt.Sprintf("test%d@test.com", i),
				// you don't need to set CreatedAt, UpdatedAt
			},
		)
	}

	err := gormbulk.BulkInsert(db, insertRecords, 3000)
	if err != nil {
		// do something
	}

	// columns you want to exclude from Insert, specify as an argument
	err = gormbulk.BulkInsert(db, insertRecords, 3000, "Email")
        if err != nil {
            // do something
        }
}

License

This project is under Apache 2.0 License. See the LICENSE file for the full license text.

Documentation

Index

• func BulkInsert(db *gorm.DB, objects []interface{}, chunkSize int, excludeColumns ...string) error

Functions

func BulkInsert

func BulkInsert(db *gorm.DB, objects []interface{}, chunkSize int, excludeColumns ...string) error

Insert multiple records at once [objects] Must be a slice of struct [chunkSize] Number of records to insert at once.

Embedding a large number of variables at once will raise an error beyond the limit of prepared statement.
Larger size will normally lead the better performance, but 2000 to 3000 is reasonable.

[excludeColumns] Columns you want to exclude from insert. You can omit if there is no column you want to exclude.