go-pg is a Golang ORM for PostgreSQL.

CRUD operations

Learn how to establish a connection to a YugabyteDB database and begin basic CRUD operations using the steps in the Build an application page.

The following sections break down the example to demonstrate how to perform common tasks required for Go application development using go-pg.

Step 1: Import the ORM package

Import the PG packages by adding the following import statement in your Go code.

import (
  "github.com/go-pg/pg/v10"
  "github.com/go-pg/pg/v10/orm"
)

Step 2: Set up the database connection

Use the pg.Connect() function to establish a connection to the YugabyteDB database. This can then can be used to read and write data to the database.

url := fmt.Sprintf("postgres://%s:%s@%s:%d/%s%s",
                  user, password, host, port, dbname, sslMode)
opt, errors := pg.ParseURL(url)
if errors != nil {
    log.Fatal(errors)
}

db := pg.Connect(opt)
Parameter Description Default
user user for connecting to the database yugabyte
password password for connecting to the database yugabyte
host hostname of the YugabyteDB instance localhost
port Listen port for YSQL 5433
dbname database name yugabyte
sslMode SSL mode require

Step 3: Create tables

Define a struct which maps to the table schema and use AutoMigrate() to create the table.

type Employee struct {
    Id        int64
    Name      string
    Age       int64
    Language  []string
}
    ...
    model := (*Employee)(nil)
    err = db.Model(model).CreateTable(&orm.CreateTableOptions{
        Temp: false,
    })
    if err != nil {
        log.Fatal(err)
    }

Read more on designing Database schemas and tables.

Step 4: Read and write data

To write data to YugabyteDB, use the Insert() function.

// Insert into the table.
employee1 := &Employee{
    Name:   "John",
    Age:    35,
    Language: []string{"Go"},
}
_, err = db.Model(employee1).Insert()
if err != nil {
    log.Fatal(err)
}

To query data from YugabyteDB tables, execute the Select() function.

// Read from the table.
emp := new(Employee)
err = db.Model(emp).
    Where("employee.id = ?", employee1.Id).
    Select()
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Query for id=1 returned: ");
fmt.Println(emp)

Next steps

Explore Scaling Go Applications with YugabyteDB.