Website |Documentation |Community

Vision

Goal

Examples

package mainimport ("log""github.com/beyondstorage/go-storage/v5/services""github.com/beyondstorage/go-storage/v5/types"// Add fs support    _"github.com/beyondstorage/go-storage/services/fs/v4"// Add s3 support    _"github.com/beyondstorage/go-storage/services/s3/v3"// Add gcs support    _"github.com/beyondstorage/go-storage/services/gcs/v3"// Add azblob support    _"github.com/beyondstorage/go-storage/services/azblob/v3"// More support could be found under BeyondStorage.    _"github.com/beyondstorage/go-storage/services/xxx" )funcmain() {// Init a Storager from connection string.store,err:=services.NewStoragerFromString("s3://bucket_name/path/to/workdir")iferr!=nil {log.Fatalf("service init failed: %v",err)    }// Write data from io.Reader into hello.txtn,err:=store.Write("hello.txt",r,length)// Read data from hello.txt to io.Writern,err:=store.Read("hello.txt",w)// Stat hello.txt to check existence or get its metadatao,err:=store.Stat("hello.txt")// Use object's functions to get metadatalength,ok:=o.GetContentLength()// List will create an iterator of object under path.it,err:=store.List("path")for {// Use iterator.Next to retrieve next object until we meet IterateDone.o,err:=it.Next()iferrors.Is(err,types.IterateDone) {break        }    }// Delete hello.txterr=store.Delete("hello.txt")}

Features

Widely native services support

Complete and easily extensible interface

meta:=store.Metadata()_:=meta.GetWorkDir()// Get object WorkDir_,ok:=meta.GetWriteSizeMaximum()// Get the maximum size for write operation

// Read 2048 byte at the offset 1024 into the io.Writer.n,err:=store.Read("path",w,pairs.WithOffset(1024),pairs.WithSize(2048))

// Write 2048 byte from io.Readern,err:=store.Write("path",r,2048)

o,err:=store.Stat("path")iferrors.Is(err,services.ErrObjectNotExist) {// object is not exist}length,ok:=o.GetContentLength()// get the object content length.

err:=store.Delete("path")// Delete the object "path"

it,err:=store.List("path")for {o,err:=it.Next()iferr!=nil&&errors.Is(err,types.IterateDone) {// the list is over    }length,ok:=o.GetContentLength()// get the object content length.}

err:=store.(Copier).Copy(src,dst)// Copy an object from src to dst.

err:=store.(Mover).Move(src,dst)// Move an object from src to dst.

url,err:=store.(Reacher).Reach("path")// Generate an url to the object.

o,err:=store.(Direr).CreateDir("path")// Create a dir object.

ms:=store.(Multiparter)// Create a multipart object.o,err:=ms.CreateMultipart("path")// Write 1024 bytes from io.Reader into a multipart at index 1n,part,err:=ms.WriteMultipart(o,r,1024,1)// Complete a multipart object.err:=ms.CompleteMultipart(o, []*Part{part})

as:=store.(Appender)// Create an appendable object.o,err:=as.CreateAppend("path")// Write 1024 bytes from io.Reader.n,err:=as.WriteAppend(o,r,1024)// Commit an append object.err=as.CommitAppend(o)

bs:=store.(Blocker)// Create a block object.o,err:=bs.CreateBlock("path")// Write 1024 bytes from io.Reader with block id "id-abc"n,err:=bs.WriteBlock(o,r,1024,"id-abc")// Combine block via block ids.err:=bs.CombineBlock(o, []string{"id-abc"})

ps:=store.(Pager)// Create a page object.o,err:=ps.CreatePage("path")// Write 1024 bytes from io.Reader at offset 2048n,err:=ps.WritePage(o,r,1024,2048)

Comprehensive metadata

o,err:=store.Stat("path")// Get service system metadata via API provides by go-service-s3.om:=s3.GetObjectSystemMetadata(o)_=om.StorageClass// this object's storage class_=om.ServerSideEncryptionCustomerAlgorithm// this object's sse algorithm

Strong Typing Everywhere

funcWithContentMd5(vstring)Pair {returnPair{Key:"content_md5",Value:v,    }}

func (o*Object)GetContentMd5() (string,bool) {o.stat()ifo.bit&objectIndexContentMd5!=0 {returno.contentMd5,true    }return"",false}

Server-Side Encrypt

funcNewS3SseC(key []byte) (types.Storager,error) {defaultPairs:= s3.DefaultStoragePairs{Write: []types.Pair{// Required, must be AES256s3.WithServerSideEncryptionCustomerAlgorithm(s3.ServerSideEncryptionAes256),// Required, your AES-256 key, a 32-byte binary values3.WithServerSideEncryptionCustomerKey(key),        },// Now you have to provide customer key to read encrypted dataRead: []types.Pair{// Required, must be AES256s3.WithServerSideEncryptionCustomerAlgorithm(s3.ServerSideEncryptionAes256),// Required, your AES-256 key, a 32-byte binary values3.WithServerSideEncryptionCustomerKey(key),        }}return s3.NewStorager(...,s3.WithDefaultStoragePairs(defaultPairs))}

Sponsor