Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Go support. #16

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,44 @@ console.log(version);

See [`deno/sqlite-vss/README.md`](./deno/README.md) for more details.

### Go

For Go developers, use the [Go](./go) module:

```go
package main

import (
"fmt"
"log"

vss "github.com/asg017/sqlite-vss/go"
)

func main() {
// /usr/local/lib/sqlite/ext/sqlite-vss is where vss0 and vector0 are stored.
db, err := vss.Open("vss-example.db", "/usr/local/lib/sqlite/ext/sqlite-vss")
if err != nil {
log.Fatal()
}
defer db.Close()

r := db.QueryRow("select vss_version();")
if err := r.Err(); err != nil {
log.Fatal(err)
}

var versions any
if err := r.Scan(&versions); err != nil {
log.Fatal(err)
}

fmt.Println(versions)
}
```

See [`go/README.md`](./go/README.md) for more details.

### Datasette

And for [Datasette](https://datasette.io/), install the [`datasette-sqlite-vss` plugin](https://datasette.io/plugins/datasette-sqlite-vss) with:
Expand Down
43 changes: 43 additions & 0 deletions go/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# sqlite-vss Go package


This package wraps the [go-sqlite3](https://github.com/mattn/go-sqlite3) driver and automatically loads extensions when opening a database connection.

```go
package main

import (
"fmt"
"log"

vss "github.com/asg017/sqlite-vss/go"
)

func main() {
// /usr/local/lib/sqlite/ext/sqlite-vss is where vss0 and vector0 are stored.
db, err := vss.Open("vss-example.db", "/usr/local/lib/sqlite/ext/sqlite-vss")
if err != nil {
log.Fatal()
}
defer db.Close()

r := db.QueryRow("select vss_version();")
if err := r.Err(); err != nil {
log.Fatal(err)
}

var versions any
if err := r.Scan(&versions); err != nil {
log.Fatal(err)
}

fmt.Println(versions)
}
```

## Installing


```bash
go get github.com/asg017/sqlite-vss/go
```
29 changes: 29 additions & 0 deletions go/example/main.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package main

import (
"fmt"
"log"

vss "github.com/asg017/sqlite-vss/go"
)

func main() {
// /usr/local/lib/sqlite/ext/sqlite-vss is where vss0 and vector0 are stored.
db, err := vss.Open("vss-example.db", "/usr/local/lib/sqlite/ext/sqlite-vss")
if err != nil {
log.Fatal()
}
defer db.Close()

r := db.QueryRow("select vss_version();")
if err := r.Err(); err != nil {
log.Fatal(err)
}

var versions any
if err := r.Scan(&versions); err != nil {
log.Fatal(err)
}

fmt.Println(versions)
}
5 changes: 5 additions & 0 deletions go/go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module github.com/asg017/sqlite-vss/go

go 1.20

require github.com/mattn/go-sqlite3 v1.14.16 // indirect
2 changes: 2 additions & 0 deletions go/go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github.com/mattn/go-sqlite3 v1.14.16 h1:yOQRA0RpS5PFz/oikGwBEqvAWhWg5ufRz4ETLjwpU1Y=
github.com/mattn/go-sqlite3 v1.14.16/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
20 changes: 20 additions & 0 deletions go/vss.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package vss

import (
"database/sql"
"path"

"github.com/mattn/go-sqlite3"
)

// Open returns a sql.DB pre-configured with sqlite-vss extensions,
// to work vss0 and vector0 files should be stored under extPath.
func Open(dbName string, extPath string) (*sql.DB, error) {
sql.Register("sqlite-vss", &sqlite3.SQLiteDriver{
Extensions: []string{
path.Join(extPath, "vector0"),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do not use path package. please path/filepath instead.

path.Join(extPath, "vss0"),
},
})
return sql.Open("sqlite-vss", dbName)
}