Skip to main content

Introduction

Pair is a core idea in go-storage, which used to carry optional arguments.

There are two kinds of Pair:

  • Global Pair: Defined in specs, shared across all services.
  • System Pair: Defined in service's service.toml pairs section, only available in current service.

Available Pairs#

We will document all global pair here and leave system pairs in service's documents.

Default Pairs#

go-storage provides a mechanism to allow user pass default pairs for every operation during NewServicer and NewStorager.

Any service that supports this mechanism will generate system pairs called DefaultServicePairs and DefaultStoragePairs:

type DefaultStoragePairs struct {    CompleteMultipart []Pair    Create            []Pair    CreateMultipart   []Pair    Delete            []Pair    List              []Pair    ListMultipart     []Pair    Metadata          []Pair    Read              []Pair    Stat              []Pair    Write             []Pair    WriteMultipart    []Pair}
func WithDefaultStoragePairs(v DefaultStoragePairs) Pair {    return Pair{        Key:   pairDefaultStoragePairs,        Value: v,    }}

User can use pass default pairs like this:

store, err := s3.NewStorager(    s3.WithDefaultStoragePairs(s3.DefaultStoragePairs{        Write: []types.Pair{            s3.WithStorageClass("STANDARD_IA"),        },    }),)

As in example, every call to Write will specify the storage_class to STANDARD_IA.