Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

remote

package

Go to main page

Versions in this module

v0

v0.11.0

May 28, 2026

Changes in this version

+ const DefaultSQLiteBundleChunkSize

+ const SQLiteGzipChunkedBundleFormat

+ const SQLiteGzipCompression

+ func SQLiteBundleManifestKey(app, archive string) string

+ func SQLiteBundlePartKey(app, archive string, index int) string

+ func SQLiteCompressedObjectKey(app, archive string) string

+ func SQLiteObjectKey(app, archive string) string

type Client

+ func (c *Client) UploadSQLiteBundleFiles(ctx context.Context, app, archive string, manifest SQLiteBundleManifest, ...) (SQLiteBundleUploadResult, error)

+ func (c *Client) UploadSQLiteBundleManifest(ctx context.Context, app, archive string, manifest SQLiteBundleManifest) (SQLiteBundleUploadResult, error)

+ func (c *Client) UploadSQLiteBundlePart(ctx context.Context, app, archive string, part SQLiteBundlePartUpload) (SQLiteUploadResult, error)

+ type SQLiteBundle struct

+ ContentType string

+ ETag string

+ Key string

+ Manifest *SQLiteBundleManifest

+ Size int64

+ UploadedAt string

+ type SQLiteBundleBuild struct

+ Cleanup func()

+ CompressedPath string

+ Manifest SQLiteBundleManifest

+ Parts []SQLiteBundlePartFile

+ func BuildGzipSQLiteBundle(ctx context.Context, opts SQLiteBundleBuildOptions) (SQLiteBundleBuild, error)

+ type SQLiteBundleBuildOptions struct

+ App string

+ Archive string

+ ChunkSize int64

+ CompressionLevel int

+ ContentType string

+ Counts map[string]int64

+ GeneratedAt time.Time

+ Privacy map[string]any

+ SourcePath string

+ WorkDir string

+ type SQLiteBundleCompression struct

+ Algorithm string

+ type SQLiteBundleManifest struct

+ App string

+ Archive string

+ CompressedObject SQLiteBundleObject

+ Compression SQLiteBundleCompression

+ ContentType string

+ Counts map[string]int64

+ Format string

+ GeneratedAt string

+ Object SQLiteBundleObject

+ Parts []SQLiteBundlePart

+ Privacy map[string]any

+ Reconstruct string

+ type SQLiteBundleObject struct

+ Key string

+ SHA256 string

+ Size int64

+ type SQLiteBundlePart struct

+ Index int

+ Key string

+ SHA256 string

+ Size int64

+ type SQLiteBundlePartFile struct

+ Path string

+ type SQLiteBundlePartUpload struct

+ Body io.Reader

+ Compression string

+ Index int

+ SHA256 string

+ Size int64

+ type SQLiteBundleUploadResult struct

+ App string

+ Archive string

+ Bundle *SQLiteBundle

+ Complete bool

type Status

+ SQLiteBundle *SQLiteBundle

v0.10.0

May 28, 2026

Changes in this version

+ const AuthPublic

+ const AuthPublisher

+ const AuthReader

+ const ContractPath

+ const HealthPath

+ const ProtocolVersion

+ type AppSpec struct

+ App string

+ Capabilities []string

+ IngestTables []IngestTableSpec

+ Queries []QuerySpec

+ type AuthSpec struct

+ Description string

+ Name string

type Client

+ func (c *Client) Contract(ctx context.Context) (Contract, error)

+ func (c *Client) UploadSQLite(ctx context.Context, app, archive string, upload SQLiteUploadRequest) (SQLiteUploadResult, error)

+ type Contract struct

+ Apps []AppSpec

+ Auth []AuthSpec

+ Notes []string

+ ProtocolVersion string

+ Routes []RouteSpec

+ Service string

+ func BaseContract() Contract

+ func (c Contract) Validate() error

+ type IngestTableSpec struct

+ Columns []string

+ Name string

+ PrivacyFilters []string

+ type QuerySpec struct

+ Args []string

+ Name string

+ type RouteSpec struct

+ Auth string

+ Method string

+ Path string

+ type SQLiteObject struct

+ ContentType string

+ ETag string

+ Key string

+ SHA256 string

+ Size int64

+ UploadedAt string

+ type SQLiteUploadRequest struct

+ Body io.Reader

+ ContentSHA256 string

+ SchemaHash string

+ SchemaName string

+ SchemaVersion int

+ Size int64

+ SourceSyncAt string

+ type SQLiteUploadResult struct

+ App string

+ Archive string

+ Complete bool

+ Object *SQLiteObject

type Status

+ SQLiteObject *SQLiteObject

v0.8.0

May 27, 2026

Changes in this version

+ const DefaultTokenEnv

+ const ModeCloud

+ const ModeGit

+ const ModeHybrid

+ const ModeLocal

+ const ModePublisher

+ var ErrMissingToken = errors.New("remote token is missing")

+ func LoginPollSecretHash(secret string) string

+ func NewLoginPollSecret() (string, error)

+ type Archive struct

+ App string

+ Capabilities []string

+ ID string

+ LastIngestAt string

+ LastSyncAt string

+ SchemaHash string

+ SchemaName string

+ SchemaVersion int

+ Slug string

+ type AuthConfig struct

+ KeyringAccount string

+ KeyringService string

+ TokenSource string

+ type ChainTokenProvider []TokenProvider

+ func (p ChainTokenProvider) Token(ctx context.Context) (string, error)

+ type Client struct

+ func NewClient(opts Options) (*Client, error)

+ func NewClientFromConfig(cfg Config, opts Options) (*Client, error)

+ func (c *Client) Archives(ctx context.Context) ([]Archive, error)

+ func (c *Client) BatchRead(ctx context.Context, app, archive string, requests []QueryRequest) ([]QueryResult, error)

+ func (c *Client) Ingest(ctx context.Context, app, archive string, req IngestRequest) (IngestResult, error)

+ func (c *Client) LoginWithGitHubToken(ctx context.Context, token string) (LoginPollResult, error)

+ func (c *Client) PollGitHubLogin(ctx context.Context, loginID, pollSecret string) (LoginPollResult, error)

+ func (c *Client) Query(ctx context.Context, app, archive string, req QueryRequest) (QueryResult, error)

+ func (c *Client) StartGitHubLogin(ctx context.Context, pollSecretHash string) (LoginStartResult, error)

+ func (c *Client) Status(ctx context.Context, app, archive string) (Status, error)

+ func (c *Client) Whoami(ctx context.Context) (Identity, error)

+ type Config struct

+ Archive string

+ Auth AuthConfig

+ Endpoint string

+ Mode string

+ StaleAfter string

+ TokenEnv string

+ func (c *Config) Normalize()

+ func (c Config) Enabled() bool

+ type EnvTokenProvider struct

+ Name string

+ func (p EnvTokenProvider) Token(context.Context) (string, error)

+ type Error struct

+ Code string

+ Message string

+ Status int

+ func (e *Error) Error() string

+ type GitHubTokenLoginRequest struct

+ Token string

+ type Identity struct

+ Auth string

+ Login string

+ Org string

+ Owner string

+ Roles []string

+ type IngestManifest struct

+ App string

+ Archive string

+ Mode string

+ SchemaHash string

+ SchemaName string

+ SchemaVersion int

+ Source string

+ SourceSyncAt string

+ type IngestRequest struct

+ Columns []string

+ Cursor string

+ Final bool

+ Manifest IngestManifest

+ Rows [][]any

+ Table string

+ type IngestResult struct

+ Complete bool

+ Cursor string

+ RowsAccepted int64

+ RunID string

+ Table string

+ type LoginPollRequest struct

+ LoginID string

+ PollSecret string

+ type LoginPollResult struct

+ Error string

+ Login string

+ Org string

+ Owner string

+ Status string

+ Token string

+ type LoginStartRequest struct

+ PollSecretHash string

+ type LoginStartResult struct

+ ExpiresAt string

+ LoginID string

+ URL string

+ type Options struct

+ Endpoint string

+ HTTPClient *http.Client

+ TokenProvider TokenProvider

+ UserAgent string

+ type QueryRequest struct

+ App string

+ Archive string

+ Args map[string]any

+ Cursor string

+ Limit int

+ Name string

+ type QueryResult struct

+ Columns []string

+ Cursor string

+ Rows [][]any

+ SchemaHash string

+ Stats QueryStats

+ Values []map[string]any

+ type QueryStats struct

+ DurationMS int64

+ RowsRead int64

+ RowsWritten int64

+ ServedBy string

+ type StaticToken string

+ func (t StaticToken) Token(context.Context) (string, error)

+ type Status struct

+ App string

+ Archive string

+ Capabilities []string

+ Counts []control.Count

+ GeneratedAt string

+ LastIngestAt string

+ LastSyncAt string

+ Mode string

+ Warnings []string

+ type TokenProvider interface

+ Token func(context.Context) (string, error)