KSQL

About

KSQL is a simple and powerful Golang SQL library based on pgx and database/sql.

Features

• Support for all common relational databases: mysql, sqlite, sqlserver, postgresql, cratedb

• Generic and powerful functions for Querying and Scanning data into structs

• Works on top of existing battle-tested libraries such as database/sql and pgx

• Helper functions for everyday operations, namely: Insert, Patch and Delete

• Supports sql.Scanner and sql.Valuer and also all pgx special types (when using kpgx)

• Every operation returns errors a single time, so its easier to handle them

… and many more.

Synopsis

example.go

package main

import (
    "context"
    "fmt"
    "log"

    "github.com/vingarcia/ksql"
    "github.com/vingarcia/ksql/adapters/kpgx"
)

var SummitsTable = ksql.NewTable("summits")

type Summit struct {
    Mountain  string  `ksql:"mountain"`
    Region    string  `ksql:"region"`
    Height    int     `ksql:"height"`
    Latitude  float32 `ksql:"latitude"`
    Longitude float32 `ksql:"longitude"`
}

func main() {
    ctx := context.Background()

    // Connect to database.
    dbURL := "postgresql://crate:crate@localhost:5432/?sslmode=disable"
    db, err := kpgx.New(ctx, dbURL, ksql.Config{})
    if err != nil {
        log.Fatalf("unable connect to database: %s", err)
    }
    defer db.Close()

    // Invoke query.
    var rows []Summit
    db.Query(ctx, &rows, `
        SELECT
            mountain, region, height,
            LATITUDE(coordinates) AS latitude,
            LONGITUDE(coordinates) AS longitude
        FROM sys.summits
        ORDER BY height DESC
        LIMIT 5`)

    // Display results.
    for _, row := range rows {
        fmt.Printf("- %#v\n", row)
    }
}

SSL connection

Use the sslmode=require parameter, and replace username, password, and hostname with values matching your environment. Also use this variant to connect to CrateDB Cloud.

dbURL := "postgresql://admin:password@testcluster.cratedb.net:5432/?sslmode=require"

Example

Create the file example.go including the synopsis code shared above.

Start CrateDB using Docker or Podman, then invoke the example program.

docker run --rm --publish=5432:5432 docker.io/crate '-Cdiscovery.type=single-node'

go mod init github.com/cratedb-guide/connect/go/ksql
go mod tidy
go run example.go