gs

package
v0.0.0-...-77360e6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 6, 2024 License: Apache-2.0 Imports: 35 Imported by: 0

README

gs - Google Storage for Abstract File Storage

Usage


import (
	"context"
	"fmt"
	"github.com/viant/afs"
	_ "github.com/viant/afsc/gs"
	"io/ioutil"
	"log"
)

func main() {
	service := afs.New()
	ctx := context.Background()
	objects, err := service.List(ctx, "gs://myBucket/folder")
	if err != nil {
		log.Fatal(err)
	}
	for _, object := range objects {
		fmt.Printf("%v %v\n", object.Name(), object.URL())
		if object.IsDir() {
			continue
		}
		reader, err := service.Download(ctx, object)
		if err != nil {
			log.Fatal(err)
		}
		defer reader.Close()
		data, err := ioutil.ReadAll(reader)
		if err != nil {
			log.Fatal(err)
		}
		fmt.Printf("%s\n", data)
	}
	
	err = service.Copy(ctx, "gs://myBucket/folder", "/tmp")
	if err != nil {
		log.Fatal(err)
	}
}


Auth
  • Default Google Auth

When this library is used within GCP then owner service account is used to authenticate.
Otherwise use case use GOOGLE_APPLICATION_CREDENTIALS

  • JSON Web Token (JWT)

To use JWT auth, provide a type that implements the following interface, you can also use gs.NewJwtConfig

type JWTProvider interface {

	JWTConfig(scopes ...string) (config *jwt.Config, projectID string, err error)
}

Example:

    secretPath := path.Join(os.Getenv("HOME"), ".secret", TestCredenitlas)
	jwtConfig, err := gs.NewJwtConfig(option.NewLocation(secretPath))
	if err != nil {
		log.Fatal(err)
	}

	service := afs.New()
	reader, err := service.DownloadWithURL(ctx, "gs://my-bucket/myfolder/asset.txt", jwtConfig)
	data, err := ioutil.ReadAll(reader)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("data: %s\n", data)
	

Options


    secretPath := path.Join(os.Getenv("HOME"), ".secret", "gcp-e2e.json")
	jwtConfig, err := gs.NewJwtConfig(option.NewLocation(secretPath))
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()
	JSON, err := json.Marshal(jwtConfig)
	
    //import goption "google.golang.org/api/option"
	jsonAuth := goption.WithCredentialsJSON(JSON)

	service := afs.New()
	reader, err := service.DownloadWithURL(ctx, "gs://my-bucket/myfolder/asset.txt", gs.NewClientOptions(jsonAuth), gs.NewProject("myproject"))
	data, err := ioutil.ReadAll(reader)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("data: %s\n", data)

  • Custom key encryption

  	customKey, err := option.NewAES256Key([]byte("secret-key-that-is-32-bytes-long"))
  	if err != nil {
  		log.Fatal(err)
  	}
  	ctx := context.Background()
  	service := afs.New()
  	err = service.Upload(ctx, "gs://mybucket/folder/secret1.txt", 0644, strings.NewReader("my secret text"), customKey)
  	if err != nil {
  		log.Fatal(err)
  	}
  	reader, err := service.DownloadWithURL(ctx, "gs://mybucket/folder/secret1.txt", customKey)
  	data, err := ioutil.ReadAll(reader)
  	if err != nil {
  		log.Fatal(err)
  	}
  	fmt.Printf("data: %s\n", data)


  • option.Checksum{Skip:true}: checksum (crc/md5) is not computed to stream data in chunks
  • option.Stream: download reader reads data with specified stream PartSize

    jwtConfig, err := gs.NewJwtConfig()
	if err != nil {
		log.Fatal(err)
	}
	
	
	ctx := context.Background()
	fs := afs.New()
	sourceURL := "gs://myBucket/path/myasset.gz"
	reader, err := fs.DownloadWithURL(ctx, sourceURL, jwtConfig, option.NewStream(64*1024*1024, 0))
	if err != nil {
		log.Fatal(err)
	}
    
	_ = os.Setenv("AWS_SDK_LOAD_CONFIG", "true")
	destURL := "s3://myBucket/path/myasset.gz"
	err = fs.Upload(ctx, destURL, 0644, reader, &option.Checksum{Skip:true})
	if err != nil {
		log.Fatal(err)
		return
	}


Documentation

Overview

Package gs implements abstract file storage API with Google Storage

Index

Examples

Constants

View Source
const (
	//UserAgent defines this library user agent
	UserAgent = "viant/gcpgs"
	//DefaultUploadChunkSize default upload chunk size
	DefaultUploadChunkSize = 16 * 1024 * 1024
)
View Source
const Scheme = "gs"

Scheme represents google storage scheme

Variables

View Source
var DefaultHTTPClientProvider = getDefaultHTTPClient

DefaultHTTPClientProvider defaultHTTP client

View Source
var DefaultOptions []goptions.ClientOption

DefaultOptions represents default client option

View Source
var DefaultProjectProvider = getDefaultProject

DefaultProjectProvider default projectid provider

Functions

func GetListCounter

func GetListCounter(reset bool) int

GetListCounter returns count of list operations

func GetRetryCodes

func GetRetryCodes(reset bool) map[int]int

func New

func New(options ...storage.Option) storage.Manager

New creates scp manager

Example
package main

import (
	"context"
	"fmt"
	"github.com/viant/afsc/gs"
	"io/ioutil"
	"log"
)

func main() {
	service := gs.New()
	ctx := context.Background()
	reader, err := service.OpenURL(ctx, "gs://my-bucket/folder/asset")
	if err != nil {
		log.Fatal(err)
	}
	defer reader.Close()
	data, err := ioutil.ReadAll(reader)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("data: %s\n", data)
}
Output:

func NewReadSeeker

func NewReadSeeker(ctx context.Context, storager *storager, call *storage.ObjectsGetCall, size int) io.ReadSeeker

NewReadSeeker create a reader seeker

func NewStorager

func NewStorager(ctx context.Context, baseURL string, options ...storage.Option) (storage.Storager, error)

NewStorager returns new storager

func Provider

func Provider(options ...storage.Option) (storage.Manager, error)

Provider returns a google storage manager

func SetCustomKeyHeader

func SetCustomKeyHeader(key *option.AES256Key, headers http.Header) error

SetCustomKeyHeader set encryption headers

func SetOptions

func SetOptions(options ...goptions.ClientOption)

SetOptions set global default options

Types

type ClientOptions

type ClientOptions []option.ClientOption

ClientOptions represents gcp client options

func NewClientOptions

func NewClientOptions(options ...option.ClientOption) ClientOptions

NewClientOptions creates an option slice

Example
package main

import (
	"context"
	"encoding/json"
	"fmt"
	"github.com/viant/afs"
	"github.com/viant/afs/option"
	"github.com/viant/afsc/auth"
	"github.com/viant/afsc/gs"

	goption "google.golang.org/api/option"
	"io/ioutil"
	"log"
	"os"
	"path"
)

func main() {
	secretPath := path.Join(os.Getenv("HOME"), ".secret", "gcp-e2e.json")
	jwtConfig, err := auth.NewJwtConfig(option.NewLocation(secretPath))
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()
	JSON, err := json.Marshal(jwtConfig)
	jsonAuth := goption.WithCredentialsJSON(JSON)

	service := afs.New()
	reader, err := service.OpenURL(ctx, "gs://my-bucket/myfolder/asset.txt", gs.NewClientOptions(jsonAuth), gs.NewProject("myproject"))
	data, err := ioutil.ReadAll(reader)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("data: %s\n", data)
}
Output:

type Project

type Project struct {
	ID string
}

Project represents a project info

func NewProject

func NewProject(id string) *Project

NewProject returns a project option

type Scopes

type Scopes []string

Scopes represents storage scopes

func NewScopes

func NewScopes(scopes ...string) Scopes

NewScopes create scopes

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL