https://github.com/superfly/litefs-go

Go library for interacting with LiteFS.
https://github.com/superfly/litefs-go

Last synced: about 1 month ago
JSON representation

Go library for interacting with LiteFS.

• Host: GitHub
• URL: https://github.com/superfly/litefs-go
• Owner: superfly
• License: apache-2.0
• Created: 2023-02-16T19:01:41.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-14T21:14:41.000Z (over 1 year ago)
• Last Synced: 2024-06-21T15:38:47.916Z (12 months ago)
• Language: Go
• Size: 10.7 KB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
LiteFS Go Library [![Go Reference](https://pkg.go.dev/badge/github.com/superfly/litefs-go.svg)](https://pkg.go.dev/github.com/superfly/litefs-go)

=================

This Go library is for interacting with LiteFS features that cannot be accessed

through the typical SQLite API.

## Halting

LiteFS provides the ability to halt writes on the primary node in order that

replicas may execute writes remotely and forward them back to the primary. This

isn't necessary in most usage, however, it can make running migrations simpler.

Write forwarding from the replica is much slower than executing the write

transaction directly on the primary so only use this for migrations or low-write

scenarios.

```go

// Initialize the database.

db, err := sql.Open("sqlite3", "/litefs/my.db")

if err != nil {

	return err

}

defer db.Close()

// Execute a write transaction from any node.

// If this is a replica, it will run the inner function with the HALT lock.

if err := litefs.WithHalt("/litefs/my.db", func() error {

	_, err := db.Exec(`CREATE TABLE users (id INTEGER PRIMARY KEY, name string)`)

	return err

}); err != nil {

	return err

}

```