Skip to content

Latest commit

 

History

History
104 lines (74 loc) · 3.1 KB

vfssimple.md

File metadata and controls

104 lines (74 loc) · 3.1 KB
Raw

vfssimple

Package vfssimple provides a basic and easy to use set of functions to any supported backend filesystem by using full URI's:

  • Local OS: file:///some/path/to/file.txt
  • Amazon S3: s3://mybucket/path/to/file.txt
  • Google Cloud Storage: gs://mybucket/path/to/file.txt

Usage

Just import vfssimple.

package main

import(
    "github.com/c2fo/vfs/vfssimple"
)

...

func DoSomething() error {
    myLocalDir, err := vfssimple.NewLocation("file:///tmp/")
    if err != nil {
        return err
    }
    
    myS3File, err := vfssimple.NewFile("s3://mybucket/some/path/to/key.txt")
    if err != nil {
        return err
    }
    
    localFile, err := myS3File.MoveToLocation(myLocalDir)
    if err != nil {
        return err
    }
}

Authentication and Options

vfssimple is largely an example of how to initialize a set of backend filesystems. It only provides a default initialization of the individual file systems. See backend docs for specific authentication info for each backend but generally speaking, most backends can use Environment variables to set credentials or client options.

File systems can only use one set of options. If you would like to configure more than one file system of the same type/schema with separate credentials, you can register and map file system options to locations or individual objects. The vfssimple library will automatically try to resolve the provided URI in NewFile() or NewLocation() to the registered file system.

package main

import(
    "github.com/c2fo/vfs/vfssimple"
    "github.com/c2fo/vfs/backend"
    "github.com/c2fo/vfs/backend/s3"
)

...

func DoSomething() error {
    bucketAuth := s3.NewFileSystem().WithOptions(s3.Options{
        AccessKeyID:     "key1",
        SecretAccessKey: "secret1,
        Region:          "us-west-2",
    })
    
    fileAuth := s3.NewFileSystem().WithOptions(s3.Options{
        AccessKeyID:     "key2",
        SecretAccessKey: "secret2,
        Region:          "us-west-2",
    })
    
    backend.Register("s3://bucket1/, bucketAuth)
    backend.Register("s3://bucket2/file.txt, fileAuth)
    
    secureFile, _ := vfssimple.NewFile("s3://bucket2/file.txt")
    publicLocation, _ := vfssimple.NewLocation("s3://bucket1/")
    
    secureFile.CopyToLocation(publicLocation)
}

Functions

func NewFile

func NewFile(uri string) (vfs.File, error)

NewFile is a convenience function that allows for instantiating a file based on a uri string. Any backend filesystem is supported, though some may require prior configuration. See the docs for specific requirements of each.

func NewLocation

func NewLocation(uri string) (vfs.Location, error)

NewLocation is a convenience function that allows for instantiating a location based on a uri string.Any backend filesystem is supported, though some may require prior configuration. See the docs for specific requirements of each