GO SDK Getting Started

Use the SQLite Cloud SDK in your Go code

  1. Import the package in your Go source code:

    import sqlitecloud "github.com/sqlitecloud/sqlitecloud-go"
  2. Download the package, and run the go mod tidy command to synchronize your module’s dependencies:

    $ go mod tidy 
    go: downloading github.com/sqlitecloud/sqlitecloud-go v1.0.0
  3. Connect to a SQLite Cloud database with a valid connection string:

    db, err := sqlitecloud.Connect("sqlitecloud://user:pass@host.sqlite.cloud:port/dbname")
  4. Execute queries using a method defined on the SQCloud struct, for example Select:

    result, _ := db.Select("SELECT * FROM table1;")

The following example shows how to print the content of the table table1:

package main

import (
    "fmt"
    "strings"

    sqlitecloud "github.com/sqlitecloud/sqlitecloud-go"
)

const connectionString = "sqlitecloud://admin:password@host.sqlite.cloud:8860/dbname.sqlite"

func main() {
    db, err := sqlitecloud.Connect(connectionString)
    if err != nil {
        fmt.Println("Connect error: ", err)
    }

    tables, _ := db.ListTables()
    fmt.Printf("Tables:\n\t%s\n", strings.Join(tables, "\n\t"))

    fmt.Printf("Table1:\n")
    result, _ := db.Select("SELECT * FROM t1;")
    for r := uint64(0); r < result.GetNumberOfRows(); r++ {
        id, _ := result.GetInt64Value(r, 0)
        value, _ := result.GetStringValue(r, 1)
        fmt.Printf("\t%d: %s\n", id, value)
    }
}

Get a connection string

You can connect to any cloud database using a special connection string in the form:

sqlitecloud://user:pass@host.com:port/dbname?timeout=10&key2=value2&key3=value3

To get a valid connection string, follow these instructions:

  • Get a SQLite Cloud account. See the documentation for details.
  • Create a SQLite Cloud project
  • Create a SQLite Cloud database
  • Get the connection string by clicking on the node address in the Dashboard Nodes section. A valid connection string will be copied to your clipboard.
  • Add the database name to your connection string.

API Documentation

The complete documentation is available at: https://pkg.go.dev/github.com/sqlitecloud/sqlitecloud-go

Test and QA codecov GitHub Tag GitHub go.mod Go version

SQLite Cloud for Go is a powerful package that allows you to interact with the SQLite Cloud database seamlessly. It provides methods for various database operations. This package is designed to simplify database operations in Go applications, making it easier than ever to work with SQLite Cloud. In addition to the standard SQLite statements, several other commands are supported.