minio

package module
v2.0.1+incompatible Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2016 License: Apache-2.0 Imports: 33 Imported by: 0

README

Minio Golang Library for Amazon S3 Compatible Cloud Storage Gitter

The Minio Golang Client SDK provides simple APIs to access any Amazon S3 compatible object storage server.

List of supported cloud storage providers.

  • AWS Signature Version 4
    • Amazon S3
    • Minio
  • AWS Signature Version 2
    • Google Cloud Storage (Compatibility Mode)
    • Openstack Swift + Swift3 middleware
    • Ceph Object Gateway
    • Riak CS

This quickstart guide will show you how to install the client SDK and execute an example Golang program. For a complete list of APIs and examples, please take a look at the Golang Client API Reference documentation.

This document assumes that you have a working Golang setup in place.

Download from Github

$ go get -u github.com/minio/minio-go

Initialize Minio Client

You need four items in order to connect to Minio object storage server.

Params Description
endpoint URL to object storage service.
accessKeyID Access key is like user ID that uniquely identifies your account.
secretAccessKey Secret key is the password to your account.
secure Set this value to 'true' to enable secure (HTTPS) access. 
package main

import (
  "fmt"

  "github.com/minio/minio-go"
)

func main() {
        // Use a secure connection.
        ssl := true

        // Initialize minio client object.
        minioClient, err := minio.New("play.minio.io:9000", "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG", ssl)
        if err != nil {
                fmt.Println(err)
                return
        }
}

Quick Start Example - File Uploader

This example program connects to an object storage server, makes a bucket on the server and then uploads a file to the bucket.

We will use the Minio server running at https://play.minio.io:9000 in this example. Feel free to use this service for testing and development. Access credentials shown in this example are open to the public.

FileUploader.go
package main

import "fmt"
import (
        "log"

        "github.com/minio/minio-go"
)

func main() {
        // Use a secure connection.
        ssl := true

        // Initialize minio client object.
        minioClient, err := minio.New("play.minio.io:9000", "Q3AM3UQ867SPQQA43P2F", "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG", ssl)
        if err != nil {
                log.Fatalln(err)
        }
  
        // Make a new bucket called mymusic.
        err = minioClient.MakeBucket("mymusic", "us-east-1")
        if err != nil {
                log.Fatalln(err)
        }
        fmt.Println("Successfully created mymusic")
  
        // Upload the zip file with FPutObject.
        n, err := minioClient.FPutObject("mymusic", "golden-oldies.zip", "/tmp/golden-oldies.zip", "application/zip")
        if err != nil {
                log.Fatalln(err)
        }
        log.Printf("Successfully uploaded golden-oldies.zip of size %d\n", n)
}
Run FileUploader
$ go run file-uploader.go
$ Successfully created mymusic 
$ Successfully uploaded golden-oldies.zip of size 17MiB

$ mc ls play/mymusic/
[2016-05-27 16:02:16 PDT]  17MiB golden-oldies.zip

API Reference

The full API Reference is available here.

API Reference : Bucket Operations
API Reference : Bucket policy Operations
API Reference : File Object Operations
API Reference : Object Operations
API Reference : Presigned Operations

Full Examples

Full Examples : Bucket Operations
Full Examples : Bucket policy Operations
Full Examples : File Object Operations
Full Examples : Object Operations
Full Examples : Presigned Operations

Explore Further

Contribute

Contributors Guide

Build Status Build status

Documentation

Index

Constants

View Source 
const (
	BucketPolicyNone      BucketPolicy = "none"
	BucketPolicyReadOnly               = "readonly"
	BucketPolicyReadWrite              = "readwrite"
	BucketPolicyWriteOnly              = "writeonly"
)

Different types of Policies currently supported for buckets.

View Source 
const MaxJitter = 1.0

MaxJitter will randomize over the full exponential backoff time

View Source 
const NoJitter = 0.0

NoJitter disables the use of jitter for randomizing the exponential backoff time

Variables

View Source 
var ErrInvalidObjectPrefix = ErrInvalidObjectName

ErrInvalidObjectPrefix - Invalid object prefix response is similar to object name response.

View Source 
var MaxRetry = 5

MaxRetry is the maximum number of retries before stopping.

Functions

func ErrEntityTooLarge added in v1.0.0 

func ErrEntityTooLarge(totalSize, maxObjectSize int64, bucketName, objectName string) error

ErrEntityTooLarge - Input size is larger than supported maximum.

func ErrEntityTooSmall added in v1.0.0 

func ErrEntityTooSmall(totalSize int64, bucketName, objectName string) error

ErrEntityTooSmall - Input size is smaller than supported minimum.

func ErrInvalidArgument added in v1.0.0 

func ErrInvalidArgument(message string) error

ErrInvalidArgument - Invalid argument response.

func ErrInvalidBucketName added in v1.0.0 

func ErrInvalidBucketName(message string) error

ErrInvalidBucketName - Invalid bucket name response.

func ErrInvalidObjectName added in v1.0.0 

func ErrInvalidObjectName(message string) error

ErrInvalidObjectName - Invalid object name response.

func ErrInvalidParts added in v1.0.0 

func ErrInvalidParts(expectedParts, uploadedParts int) error

ErrInvalidParts - Invalid number of parts.

func ErrNoSuchBucketPolicy 

func ErrNoSuchBucketPolicy(message string) error

ErrNoSuchBucketPolicy - No Such Bucket Policy response The specified bucket does not have a bucket policy.

func ErrUnexpectedEOF added in v1.0.0 

func ErrUnexpectedEOF(totalRead, totalSize int64, bucketName, objectName string) error

ErrUnexpectedEOF - Unexpected end of file reached.

Types

type BucketAccessPolicy 

type BucketAccessPolicy struct {
	Version    string      // date in 0000-00-00 format
	Statements []Statement `json:"Statement"`
}

BucketAccessPolicy - minio policy collection

type BucketInfo added in v1.0.0 

type BucketInfo struct {
	// The name of the bucket.
	Name string `json:"name"`
	// Date the bucket was created.
	CreationDate time.Time `json:"creationDate"`
}

BucketInfo container for bucket metadata.

type BucketPolicy 

type BucketPolicy string

BucketPolicy - Bucket level policy.

type Client added in v1.0.0 

type Client struct {
	// contains filtered or unexported fields
}

Client implements Amazon S3 compatible methods.

func New 

func New(endpoint string, accessKeyID, secretAccessKey string, secure bool) (*Client, error)

New - instantiate minio client Client, adds automatic verification of signature.

func NewV2 added in v1.0.0 

func NewV2(endpoint string, accessKeyID, secretAccessKey string, secure bool) (*Client, error)

NewV2 - instantiate minio client with Amazon S3 signature version '2' compatibility.

func NewV4 added in v1.0.0 

func NewV4(endpoint string, accessKeyID, secretAccessKey string, secure bool) (*Client, error)

NewV4 - instantiate minio client with Amazon S3 signature version '4' compatibility.

func (Client) BucketExists added in v1.0.0 

func (c Client) BucketExists(bucketName string) error

BucketExists verify if bucket exists and you have permission to access it.

func (Client) CopyObject 

func (c Client) CopyObject(bucketName string, objectName string, objectSource string, cpCond CopyConditions) error

CopyObject - copy a source object into a new object with the provided name in the provided bucket

func (Client) FGetObject added in v1.0.0 

func (c Client) FGetObject(bucketName, objectName, filePath string) error

FGetObject - download contents of an object to a local file.

func (Client) FPutObject added in v1.0.0 

func (c Client) FPutObject(bucketName, objectName, filePath, contentType string) (n int64, err error)

FPutObject - Create an object in a bucket, with contents from file at filePath.

func (Client) GetBucketPolicy 

func (c Client) GetBucketPolicy(bucketName, objectPrefix string) (bucketPolicy BucketPolicy, err error)

GetBucketPolicy - get bucket policy at a given path.

func (Client) GetObject added in v1.0.0 

func (c Client) GetObject(bucketName, objectName string) (*Object, error)

GetObject - returns an seekable, readable object.

func (Client) ListBuckets added in v1.0.0 

func (c Client) ListBuckets() ([]BucketInfo, error)

ListBuckets list all buckets owned by this authenticated user.

This call requires explicit authentication, no anonymous requests are allowed for listing buckets. 

api := client.New(....)
for message := range api.ListBuckets() {
    fmt.Println(message)
}

func (Client) ListIncompleteUploads added in v1.0.0 

func (c Client) ListIncompleteUploads(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectMultipartInfo

ListIncompleteUploads - List incompletely uploaded multipart objects.

ListIncompleteUploads lists all incompleted objects matching the objectPrefix from the specified bucket. If recursion is enabled it would list all subdirectories and all its contents.

Your input parameters are just bucketName, objectPrefix, recursive and a done channel to pro-actively close the internal go routine. If you enable recursive as 'true' this function will return back all the multipart objects in a given bucket name. 

api := client.New(....)
// Create a done channel.
doneCh := make(chan struct{})
defer close(doneCh)
// Recurively list all objects in 'mytestbucket'
recursive := true
for message := range api.ListIncompleteUploads("mytestbucket", "starthere", recursive) {
    fmt.Println(message)
}

func (Client) ListObjects added in v1.0.0 

func (c Client) ListObjects(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectInfo

ListObjects - (List Objects) - List some objects or all recursively.

ListObjects lists all objects matching the objectPrefix from the specified bucket. If recursion is enabled it would list all subdirectories and all its contents.

Your input parameters are just bucketName, objectPrefix, recursive and a done channel for pro-actively closing the internal go routine. If you enable recursive as 'true' this function will return back all the objects in a given bucket name and object prefix. 

api := client.New(....)
// Create a done channel.
doneCh := make(chan struct{})
defer close(doneCh)
// Recurively list all objects in 'mytestbucket'
recursive := true
for message := range api.ListObjects("mytestbucket", "starthere", recursive, doneCh) {
    fmt.Println(message)
}

func (Client) ListObjectsV2 

func (c Client) ListObjectsV2(bucketName, objectPrefix string, recursive bool, doneCh <-chan struct{}) <-chan ObjectInfo

ListObjectsV2 lists all objects matching the objectPrefix from the specified bucket. If recursion is enabled it would list all subdirectories and all its contents.

Your input parameters are just bucketName, objectPrefix, recursive and a done channel for pro-actively closing the internal go routine. If you enable recursive as 'true' this function will return back all the objects in a given bucket name and object prefix. 

api := client.New(....)
// Create a done channel.
doneCh := make(chan struct{})
defer close(doneCh)
// Recurively list all objects in 'mytestbucket'
recursive := true
for message := range api.ListObjectsV2("mytestbucket", "starthere", recursive, doneCh) {
    fmt.Println(message)
}

func (Client) MakeBucket added in v1.0.0 

func (c Client) MakeBucket(bucketName string, location string) error

MakeBucket creates a new bucket with bucketName.

Location is an optional argument, by default all buckets are created in US Standard Region.

For Amazon S3 for more supported regions - http://docs.aws.amazon.com/general/latest/gr/rande.html For Google Cloud Storage for more supported regions - https://cloud.google.com/storage/docs/bucket-locations

func (Client) PresignedGetObject added in v1.0.0 

func (c Client) PresignedGetObject(bucketName string, objectName string, expires time.Duration, reqParams url.Values) (u *url.URL, err error)

PresignedGetObject - Returns a presigned URL to access an object without credentials. Expires maximum is 7days - ie. 604800 and minimum is 1. Additionally you can override a set of response headers using the query parameters.

func (Client) PresignedPostPolicy added in v1.0.0 

func (c Client) PresignedPostPolicy(p *PostPolicy) (u *url.URL, formData map[string]string, err error)

PresignedPostPolicy - Returns POST urlString, form data to upload an object.

func (Client) PresignedPutObject added in v1.0.0 

func (c Client) PresignedPutObject(bucketName string, objectName string, expires time.Duration) (u *url.URL, err error)

PresignedPutObject - Returns a presigned URL to upload an object without credentials. Expires maximum is 7days - ie. 604800 and minimum is 1.

func (Client) PutObject added in v1.0.0 

func (c Client) PutObject(bucketName, objectName string, reader io.Reader, contentType string) (n int64, err error)

PutObject creates an object in a bucket.

You must have WRITE permissions on a bucket to create an object.

  • For size smaller than 5MiB PutObject automatically does a single atomic Put operation.
  • For size larger than 5MiB PutObject automatically does a resumable multipart Put operation.
  • For size input as -1 PutObject does a multipart Put operation until input stream reaches EOF. Maximum object size that can be uploaded through this operation will be 5TiB.

NOTE: Google Cloud Storage does not implement Amazon S3 Compatible multipart PUT. So we fall back to single PUT operation with the maximum limit of 5GiB.

NOTE: For anonymous requests Amazon S3 doesn't allow multipart upload. So we fall back to single PUT operation.

func (Client) PutObjectWithProgress added in v1.0.0 

func (c Client) PutObjectWithProgress(bucketName, objectName string, reader io.Reader, contentType string, progress io.Reader) (n int64, err error)

PutObjectWithProgress - With progress.

func (Client) RemoveBucket added in v1.0.0 

func (c Client) RemoveBucket(bucketName string) error

RemoveBucket deletes the bucket name. 

All objects (including all object versions and delete markers).
in the bucket must be deleted before successfully attempting this request.

func (Client) RemoveIncompleteUpload added in v1.0.0 

func (c Client) RemoveIncompleteUpload(bucketName, objectName string) error

RemoveIncompleteUpload aborts an partially uploaded object. Requires explicit authentication, no anonymous requests are allowed for multipart API.

func (Client) RemoveObject added in v1.0.0 

func (c Client) RemoveObject(bucketName, objectName string) error

RemoveObject remove an object from a bucket.

func (*Client) SetAppInfo added in v1.0.0 

func (c *Client) SetAppInfo(appName string, appVersion string)

SetAppInfo - add application details to user agent.

func (Client) SetBucketPolicy 

func (c Client) SetBucketPolicy(bucketName string, objectPrefix string, bucketPolicy BucketPolicy) error

SetBucketPolicy set the access permissions on an existing bucket.

For example 

none - owner gets full access [default].
readonly - anonymous get access for everyone at a given object prefix.
readwrite - anonymous list/put/delete access to a given object prefix.
writeonly - anonymous put/delete access to a given object prefix.

func (*Client) SetCustomTransport added in v1.0.0 

func (c *Client) SetCustomTransport(customHTTPTransport http.RoundTripper)

SetCustomTransport - set new custom transport.

func (Client) StatObject added in v1.0.0 

func (c Client) StatObject(bucketName, objectName string) (ObjectInfo, error)

StatObject verifies if object exists and you have permission to access.

func (*Client) TraceOff added in v1.0.0 

func (c *Client) TraceOff()

TraceOff - disable HTTP tracing.

func (*Client) TraceOn added in v1.0.0 

func (c *Client) TraceOn(outputStream io.Writer)

TraceOn - enable HTTP tracing.

type CopyConditions 

type CopyConditions struct {
	// contains filtered or unexported fields
}

CopyConditions - copy conditions.

func NewCopyConditions 

func NewCopyConditions() CopyConditions

NewCopyConditions - Instantiate new list of conditions.

func (CopyConditions) SetMatchETag 

func (c CopyConditions) SetMatchETag(etag string) error

SetMatchETag - set match etag.

func (CopyConditions) SetMatchETagExcept 

func (c CopyConditions) SetMatchETagExcept(etag string) error

SetMatchETagExcept - set match etag except.

func (CopyConditions) SetModified 

func (c CopyConditions) SetModified(modTime time.Time) error

SetModified - set modified time since.

func (CopyConditions) SetUnmodified 

func (c CopyConditions) SetUnmodified(modTime time.Time) error

SetUnmodified - set unmodified time since.

type ErrorResponse 

type ErrorResponse struct {
	XMLName    xml.Name `xml:"Error" json:"-"`
	Code       string
	Message    string
	BucketName string
	Key        string
	RequestID  string `xml:"RequestId"`
	HostID     string `xml:"HostId"`

	// Region where the bucket is located. This header is returned
	// only in HEAD bucket and ListObjects response.
	Region string
}

ErrorResponse - Is the typed error returned by all API operations.

func ToErrorResponse 

func ToErrorResponse(err error) ErrorResponse

ToErrorResponse - Returns parsed ErrorResponse struct from body and http headers.

For example: 

import s3 "github.com/minio/minio-go"
...
...
reader, stat, err := s3.GetObject(...)
if err != nil {
   resp := s3.ToErrorResponse(err)
}
...

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error - Returns HTTP error string

type Object added in v1.0.0 

type Object struct {
	// contains filtered or unexported fields
}

Object represents an open object. It implements Read, ReadAt, Seeker, Close for a HTTP stream.

func (*Object) Close added in v1.0.0 

func (o *Object) Close() (err error)

Close - The behavior of Close after the first call returns error for subsequent Close() calls.

func (*Object) Read added in v1.0.0 

func (o *Object) Read(b []byte) (n int, err error)

Read reads up to len(p) bytes into p. It returns the number of bytes read (0 <= n <= len(p)) and any error encountered. Returns io.EOF upon end of file.

func (*Object) ReadAt added in v1.0.0 

func (o *Object) ReadAt(b []byte, offset int64) (n int, err error)

ReadAt reads len(b) bytes from the File starting at byte offset off. It returns the number of bytes read and the error, if any. ReadAt always returns a non-nil error when n < len(b). At end of file, that error is io.EOF.

func (*Object) Seek added in v1.0.0 

func (o *Object) Seek(offset int64, whence int) (n int64, err error)

Seek sets the offset for the next Read or Write to offset, interpreted according to whence: 0 means relative to the origin of the file, 1 means relative to the current offset, and 2 means relative to the end. Seek returns the new offset and an error, if any.

Seeking to a negative offset is an error. Seeking to any positive offset is legal, subsequent io operations succeed until the underlying object is not closed.

func (*Object) Stat added in v1.0.0 

func (o *Object) Stat() (ObjectInfo, error)

Stat returns the ObjectInfo structure describing object.

type ObjectInfo added in v1.0.0 

type ObjectInfo struct {
	// An ETag is optionally set to md5sum of an object.  In case of multipart objects,
	// ETag is of the form MD5SUM-N where MD5SUM is md5sum of all individual md5sums of
	// each parts concatenated into one string.
	ETag string `json:"etag"`

	Key          string    `json:"name"`         // Name of the object
	LastModified time.Time `json:"lastModified"` // Date and time the object was last modified.
	Size         int64     `json:"size"`         // Size in bytes of the object.
	ContentType  string    `json:"contentType"`  // A standard MIME type describing the format of the object data.

	// Owner name.
	Owner struct {
		DisplayName string `json:"name"`
		ID          string `json:"id"`
	} `json:"owner"`

	// The class of storage used to store the object.
	StorageClass string `json:"storageClass"`

	// Error
	Err error `json:"-"`
}

ObjectInfo container for object metadata.

type ObjectMultipartInfo added in v1.0.0 

type ObjectMultipartInfo struct {
	// Date and time at which the multipart upload was initiated.
	Initiated time.Time `type:"timestamp" timestampFormat:"iso8601"`

	Initiator initiator
	Owner     owner

	// The type of storage to use for the object. Defaults to 'STANDARD'.
	StorageClass string

	// Key of the object for which the multipart upload was initiated.
	Key string

	// Size in bytes of the object.
	Size int64

	// Upload ID that identifies the multipart upload.
	UploadID string `xml:"UploadId"`

	// Error
	Err error
}

ObjectMultipartInfo container for multipart object metadata.

type PostPolicy added in v1.0.0 

type PostPolicy struct {
	// contains filtered or unexported fields
}

PostPolicy - Provides strict static type conversion and validation for Amazon S3's POST policy JSON string.

func NewPostPolicy added in v1.0.0 

func NewPostPolicy() *PostPolicy

NewPostPolicy - Instantiate new post policy.

func (*PostPolicy) SetBucket added in v1.0.0 

func (p *PostPolicy) SetBucket(bucketName string) error

SetBucket - Sets bucket at which objects will be uploaded to.

func (*PostPolicy) SetContentLengthRange added in v1.0.0 

func (p *PostPolicy) SetContentLengthRange(min, max int64) error

SetContentLengthRange - Set new min and max content length condition for all incoming uploads.

func (*PostPolicy) SetContentType added in v1.0.0 

func (p *PostPolicy) SetContentType(contentType string) error

SetContentType - Sets content-type of the object for this policy based upload.

func (*PostPolicy) SetExpires added in v1.0.0 

func (p *PostPolicy) SetExpires(t time.Time) error

SetExpires - Sets expiration time for the new policy.

func (*PostPolicy) SetKey added in v1.0.0 

func (p *PostPolicy) SetKey(key string) error

SetKey - Sets an object name for the policy based upload.

func (*PostPolicy) SetKeyStartsWith added in v1.0.0 

func (p *PostPolicy) SetKeyStartsWith(keyStartsWith string) error

SetKeyStartsWith - Sets an object name that an policy based upload can start with.

func (PostPolicy) String added in v1.0.0 

func (p PostPolicy) String() string

Stringer interface for printing policy in json formatted string.

type SignatureType added in v1.0.0 

type SignatureType int

SignatureType is type of Authorization requested for a given HTTP request. 

const (
	Latest SignatureType = iota
	SignatureV4
	SignatureV2
)

Different types of supported signatures - default is Latest i.e SignatureV4.

type Statement 

type Statement struct {
	Sid        string
	Effect     string
	Principal  User                         `json:"Principal"`
	Actions    []string                     `json:"Action"`
	Resources  []string                     `json:"Resource"`
	Conditions map[string]map[string]string `json:"Condition,omitempty"`
}

Statement - minio policy statement

type User 

type User struct {
	AWS []string
}

User - canonical users list.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.