Categorygithub.com/superfly/lfsc-go
modulepackage
0.1.1
Repository: https://github.com/superfly/lfsc-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
10
Dependents
4
Files
276 SLOC

# README

LiteFS Cloud Go Client GitHub release (latest by date) GitHub

This project is a thin wrapper for connecting to LiteFS Cloud. Most methods require either an org-scoped or cluster-scoped auth token. The API on this package is not considered stable until it reaches v1.0.0.

Usage

To use the library, instantiate a Client and set the auth token if your method requires it:

client := lfsc.NewClient()
client.Token = os.Getenv("LITEFS_CLOUD_TOKEN")

# Functions

NewClient returns a new instance of Client with the default URL.

# Constants

DefaultURL is the default URL set by NewClient().

# Structs

Client represents a client for connecting to LiteFS Cloud.
Cluster represents a grouping of databases in LiteFS Cloud.
Error represents an error code & message returned from LiteFS Cloud.
No description provided by the author
No description provided by the author