Network.Minio

Documentation

data ConnectInfo

Connection Info data type. To create a ConnectInfo value, use one of the provided smart constructors or override fields of the Default instance.

Constructors

ConnectInfo

Fields

• connectHost :: Text
• connectPort :: Int
• connectAccessKey :: Text
• connectSecretKey :: Text
• connectIsSecure :: Bool
• connectRegion :: Region
• connectAutoDiscoverRegion :: Bool

Instances

Eq ConnectInfo

Methods

(==) :: ConnectInfo -> ConnectInfo -> Bool

(/=) :: ConnectInfo -> ConnectInfo -> Bool

Show ConnectInfo

Methods

showsPrec :: Int -> ConnectInfo -> ShowS

show :: ConnectInfo -> String

showList :: [ConnectInfo] -> ShowS

Default ConnectInfo

Connects to a Minio server located at localhost:9000 with access key minio and secret key minio123. It is over HTTP by default.

Methods

def :: ConnectInfo

awsCI :: ConnectInfo

Default AWS ConnectInfo. Connects to "us-east-1". Credentials should be supplied before use, for e.g.:

awsCI {
  connectAccessKey = "my-access-key"
, connectSecretKey = "my-secret-key"
}

awsWithRegionCI :: Region -> Bool -> ConnectInfo

AWS ConnectInfo with a specified region. It can optionally disable the automatic discovery of a bucket's region via the Boolean argument.

awsWithRegionCI "us-west-1" False {
  connectAccessKey = "my-access-key"
, connectSecretKey = "my-secret-key"
}

This restricts all operations to the "us-west-1" region and does not perform any bucket location requests.

minioPlayCI :: ConnectInfo

Minio Play Server ConnectInfo. Credentials are already filled in.

minioCI :: Text -> Int -> Bool -> ConnectInfo

ConnectInfo for Minio server. Takes hostname, port and a Boolean to enable TLS.

minioCI "minio.example.com" 9000 True {
  connectAccessKey = "my-access-key"
, connectSecretKey = "my-secret-key"
}

This connects to a Minio server at the given hostname and port over HTTPS.

data Minio a

Instances

Monad Minio

Methods

(>>=) :: Minio a -> (a -> Minio b) -> Minio b

(>>) :: Minio a -> Minio b -> Minio b

return :: a -> Minio a

fail :: String -> Minio a

Functor Minio

Methods

fmap :: (a -> b) -> Minio a -> Minio b

(<$) :: a -> Minio b -> Minio a

Applicative Minio

Methods

pure :: a -> Minio a

(<*>) :: Minio (a -> b) -> Minio a -> Minio b

(*>) :: Minio a -> Minio b -> Minio b

(<*) :: Minio a -> Minio b -> Minio a

MonadIO Minio

Methods

liftIO :: IO a -> Minio a

MonadResource Minio

Methods

liftResourceT :: ResourceT IO a -> Minio a

MonadThrow Minio

Methods

throwM :: Exception e => e -> Minio a

MonadCatch Minio

Methods

catch :: Exception e => Minio a -> (e -> Minio a) -> Minio a

MonadBase IO Minio

Methods

liftBase :: IO α -> Minio α

MonadBaseControl IO Minio

Associated Types

type StM (Minio :: * -> *) a :: *

Methods

liftBaseWith :: (RunInBase Minio IO -> IO a) -> Minio a

restoreM :: StM Minio a -> Minio a

type StM Minio a

type StM Minio a

runMinio :: ConnectInfo -> Minio a -> IO (Either MinioErr a)

Run the Minio action and return the result or an error.

def :: Default a => a

The default value for this type.

Error handling

Data types representing various errors that may occur while working with an object storage service.

data MinioErr

Errors thrown by the library

Constructors

MErrHTTP HttpException

MErrIO IOException

MErrService ServiceErr

MErrValidation MErrV

Instances

Eq MinioErr

Methods

(==) :: MinioErr -> MinioErr -> Bool

(/=) :: MinioErr -> MinioErr -> Bool

Show MinioErr

Methods

showsPrec :: Int -> MinioErr -> ShowS

show :: MinioErr -> String

showList :: [MinioErr] -> ShowS

Exception MinioErr

Methods

toException :: MinioErr -> SomeException

fromException :: SomeException -> Maybe MinioErr

displayException :: MinioErr -> String

data MErrV

Various validation errors

Constructors

MErrVSinglePUTSizeExceeded Int64

MErrVPutSizeExceeded Int64

MErrVETagHeaderNotFound

MErrVInvalidObjectInfoResponse

MErrVInvalidSrcObjSpec Text

MErrVInvalidSrcObjByteRange (Int64, Int64)

MErrVCopyObjSingleNoRangeAccepted

MErrVRegionNotSupported Text

MErrVXmlParse Text

MErrVInvalidBucketName Text

MErrVInvalidObjectName Text

Instances

Eq MErrV

Methods

(==) :: MErrV -> MErrV -> Bool

(/=) :: MErrV -> MErrV -> Bool

Show MErrV

Methods

showsPrec :: Int -> MErrV -> ShowS

show :: MErrV -> String

showList :: [MErrV] -> ShowS

Exception MErrV

Methods

toException :: MErrV -> SomeException

fromException :: SomeException -> Maybe MErrV

displayException :: MErrV -> String

data ServiceErr

Errors returned by S3 compatible service

Constructors

BucketAlreadyExists

BucketAlreadyOwnedByYou

NoSuchBucket

InvalidBucketName

NoSuchKey

ServiceErr Text Text

Instances

Eq ServiceErr

Methods

(==) :: ServiceErr -> ServiceErr -> Bool

(/=) :: ServiceErr -> ServiceErr -> Bool

Show ServiceErr

Methods

showsPrec :: Int -> ServiceErr -> ShowS

show :: ServiceErr -> String

showList :: [ServiceErr] -> ShowS

Exception ServiceErr

Methods

toException :: ServiceErr -> SomeException

fromException :: SomeException -> Maybe ServiceErr

displayException :: ServiceErr -> String

Data Types

Data types representing various object store concepts.

type Bucket = Text

Represents a bucket in the object store

type Object = Text

Represents an object name

data BucketInfo

BucketInfo returned for list buckets call

Constructors

BucketInfo

Fields

• biName :: Bucket
• biCreationDate :: UTCTime

Instances

Eq BucketInfo

Methods

(==) :: BucketInfo -> BucketInfo -> Bool

(/=) :: BucketInfo -> BucketInfo -> Bool

Show BucketInfo

Methods

showsPrec :: Int -> BucketInfo -> ShowS

show :: BucketInfo -> String

showList :: [BucketInfo] -> ShowS

data ObjectInfo

Represents information about an object.

Constructors

ObjectInfo

Fields

• oiObject :: Object
• oiModTime :: UTCTime
• oiETag :: ETag
• oiSize :: Int64

Instances

Eq ObjectInfo

Methods

(==) :: ObjectInfo -> ObjectInfo -> Bool

(/=) :: ObjectInfo -> ObjectInfo -> Bool

Show ObjectInfo

Methods

showsPrec :: Int -> ObjectInfo -> ShowS

show :: ObjectInfo -> String

showList :: [ObjectInfo] -> ShowS

data UploadInfo

Represents information about a multipart upload.

Constructors

UploadInfo

Fields

• uiKey :: Object
• uiUploadId :: UploadId
• uiInitTime :: UTCTime
• uiSize :: Int64

Instances

Eq UploadInfo

Methods

(==) :: UploadInfo -> UploadInfo -> Bool

(/=) :: UploadInfo -> UploadInfo -> Bool

Show UploadInfo

Methods

showsPrec :: Int -> UploadInfo -> ShowS

show :: UploadInfo -> String

showList :: [UploadInfo] -> ShowS

data ObjectPartInfo

Represents information about an object part in an ongoing multipart upload.

Constructors

ObjectPartInfo

Fields

• opiNumber :: PartNumber
• opiETag :: ETag
• opiSize :: Int64
• opiModTime :: UTCTime

Instances

Eq ObjectPartInfo

Methods

(==) :: ObjectPartInfo -> ObjectPartInfo -> Bool

(/=) :: ObjectPartInfo -> ObjectPartInfo -> Bool

Show ObjectPartInfo

Methods

showsPrec :: Int -> ObjectPartInfo -> ShowS

show :: ObjectPartInfo -> String

showList :: [ObjectPartInfo] -> ShowS

type UploadId = Text

A type alias to represent an upload-id for multipart upload

data ObjectData m

A data-type to represent the source data for an object. A file-path or a producer-conduit may be provided.

For files, a size may be provided - this is useful in cases when the file size cannot be automatically determined or if only some prefix of the file is desired.

For streams also, a size may be provided. This is useful to limit the input - if it is not provided, upload will continue until the stream ends or the object reaches maxObjectsize size.

Constructors

ODFile FilePath (Maybe Int64)

Takes filepath and optional size.

ODStream (Producer m ByteString) (Maybe Int64)

Pass size in bytes as maybe if known.

data CopyPartSource

Constructors

CopyPartSource

Fields

• cpSource :: Text
• cpSourceRange :: Maybe (Int64, Int64)

  formatted like "/sourceBucket/sourceObject"

• cpSourceIfMatch :: Maybe Text

  (0, 9) means first ten bytes of the source object

• cpSourceIfNoneMatch :: Maybe Text
• cpSourceIfUnmodifiedSince :: Maybe UTCTime
• cpSourceIfModifiedSince :: Maybe UTCTime

Instances

Eq CopyPartSource

Methods

(==) :: CopyPartSource -> CopyPartSource -> Bool

(/=) :: CopyPartSource -> CopyPartSource -> Bool

Show CopyPartSource

Methods

showsPrec :: Int -> CopyPartSource -> ShowS

show :: CopyPartSource -> String

showList :: [CopyPartSource] -> ShowS

Default CopyPartSource

Methods

def :: CopyPartSource

Bucket Operations

listBuckets :: Minio [BucketInfo]

Lists buckets.

getLocation :: Bucket -> Minio Region

Fetch bucket location (region)

bucketExists :: Bucket -> Minio Bool

Query the object store if a given bucket is present.

makeBucket :: Bucket -> Maybe Region -> Minio ()

Creates a new bucket in the object store. The Region can be optionally specified. If not specified, it will use the region configured in ConnectInfo, which is by default, the US Standard Region.

removeBucket :: Bucket -> Minio ()

listObjects :: Bucket -> Maybe Text -> Bool -> Producer Minio ObjectInfo

List objects in a bucket matching the given prefix. If recurse is set to True objects matching prefix are recursively listed.

listIncompleteUploads :: Bucket -> Maybe Text -> Bool -> Producer Minio UploadInfo

List incomplete uploads in a bucket matching the given prefix. If recurse is set to True incomplete uploads for the given prefix are recursively listed.

Object Operations

fGetObject :: Bucket -> Object -> FilePath -> Minio ()

Fetch the object and write it to the given file safely. The object is first written to a temporary file in the same directory and then moved to the given path.

fPutObject :: Bucket -> Object -> FilePath -> Minio ()

Upload the given file to the given object.

putObject :: Bucket -> Object -> Producer Minio ByteString -> Maybe Int64 -> Minio ()

Put an object from a conduit source. The size can be provided if known; this helps the library select optimal part sizes to perform a multipart upload. If not specified, it is assumed that the object can be potentially 5TiB and selects multipart sizes appropriately.

copyObject :: Bucket -> Object -> CopyPartSource -> Minio ()

Perform a server-side copy operation to create an object with the given bucket and object name from the source specification in CopyPartSource. This function performs a multipart copy operation if the new object is to be greater than 5GiB in size.

removeObject :: Bucket -> Object -> Minio ()

Remove an object from the object store.

getObject :: Bucket -> Object -> Minio (ResumableSource Minio ByteString)

Get an object from the object store as a resumable source (conduit).

statObject :: Bucket -> Object -> Minio ObjectInfo

Get an object's metadata from the object store.