Network.Minio

Types and functions to conveniently access S3 compatible object storage servers like MinIO.

Credentials

data Credentials

Contains access key and secret key to access object storage.

Constructors

Credentials

Fields

• cAccessKey :: Text
• cSecretKey :: Text

Instances

Eq Credentials

Defined in Network.Minio.Data

Methods

(==) :: Credentials -> Credentials -> Bool

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

Show Credentials

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> Credentials -> ShowS

show :: Credentials -> String

showList :: [Credentials] -> ShowS

Credential providers

Run actions that retrieve Credentials from the environment or files or other custom sources.

type Provider = IO (Maybe Credentials)

A Provider is an action that may return Credentials. Providers may be chained together using findFirst.

fromAWSConfigFile :: Provider

This Provider loads Credentials from ~/.aws/credentials

fromAWSEnv :: Provider

This Provider loads Credentials from AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY environment variables.

fromMinioEnv :: Provider

This Provider loads Credentials from MINIO_ACCESS_KEY and MINIO_SECRET_KEY environment variables.

findFirst :: [Provider] -> Provider

Combines the given list of providers, by calling each one in order until Credentials are found.

Connecting to object storage

data ConnectInfo

Connection Info data type. To create a ConnectInfo value, enable the OverloadedStrings language extension and use the IsString instance to provide a URL, for example:

let c :: ConnectInfo = "https://play.min.io"

Instances

Eq ConnectInfo

Defined in Network.Minio.Data

Methods

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

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

Show ConnectInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> ConnectInfo -> ShowS

show :: ConnectInfo -> String

showList :: [ConnectInfo] -> ShowS

IsString ConnectInfo

Defined in Network.Minio.Data

Methods

fromString :: String -> ConnectInfo

setRegion :: Region -> ConnectInfo -> ConnectInfo

Set the S3 region parameter in the ConnectInfo

setCreds :: Credentials -> ConnectInfo -> ConnectInfo

setCreds sets the given Credentials in the ConnectInfo.

setCredsFrom :: [Provider] -> ConnectInfo -> IO ConnectInfo

setCredsFrom retrieves access credentials from the first Provider form the given list that succeeds and sets it in the ConnectInfo.

isConnectInfoSecure :: ConnectInfo -> Bool

Check if the connection to object storage server is secure (i.e. uses TLS)

disableTLSCertValidation :: ConnectInfo -> ConnectInfo

Disable TLS certificate validation completely! This makes TLS insecure! Use only for testing with self-signed or temporary certificates. Note that this option has no effect, if you provide your own Manager in mkMinioConn.

data MinioConn

MinioConn holds connection info and a connection pool to allow for efficient resource re-use.

Instances

MonadReader MinioConn Minio

Defined in Network.Minio.Data

Methods

ask :: Minio MinioConn

local :: (MinioConn -> MinioConn) -> Minio a -> Minio a

reader :: (MinioConn -> a) -> Minio a

mkMinioConn :: ConnectInfo -> Manager -> IO MinioConn

Given ConnectInfo and a HTTP connection manager, create a MinioConn.

Connection helpers

These are helpers to construct ConnectInfo values for common cases.

minioPlayCI :: ConnectInfo

MinIO Play Server ConnectInfo. Credentials are already filled in.

awsCI :: ConnectInfo

Default AWS S3 ConnectInfo. Connects to "us-east-1". Credentials should be supplied before use.

gcsCI :: ConnectInfo

Default Google Compute Storage ConnectInfo. Works only for "Simple Migration" use-case with interoperability mode enabled on GCP console. For more information - https://cloud.google.com/storage/docs/migrating

Credentials should be supplied before use.

Minio Monad

The Minio Monad provides connection-reuse, bucket-location caching, resource management and simpler error handling functionality. All actions on object storage are performed within this Monad.

data Minio a

The Minio Monad - all computations accessing object storage happens in it.

Instances

Monad Minio

Defined in Network.Minio.Data

Methods

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

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

return :: a -> Minio a

fail :: String -> Minio a

Functor Minio

Defined in Network.Minio.Data

Methods

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

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

Applicative Minio

Defined in Network.Minio.Data

Methods

pure :: a -> Minio a

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

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

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

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

MonadIO Minio

Defined in Network.Minio.Data

Methods

liftIO :: IO a -> Minio a

MonadUnliftIO Minio

Defined in Network.Minio.Data

Methods

askUnliftIO :: Minio (UnliftIO Minio)

withRunInIO :: ((forall a. Minio a -> IO a) -> IO b) -> Minio b

MonadResource Minio

Defined in Network.Minio.Data

Methods

liftResourceT :: ResourceT IO a -> Minio a

MonadReader MinioConn Minio

Defined in Network.Minio.Data

Methods

ask :: Minio MinioConn

local :: (MinioConn -> MinioConn) -> Minio a -> Minio a

reader :: (MinioConn -> a) -> Minio a

runMinioWith :: MinioConn -> Minio a -> IO (Either MinioErr a)

Run the computation accessing object storage using the given MinioConn. This reuses connections, but otherwise it is similar to runMinio.

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

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

runMinioResWith :: MinioConn -> Minio a -> ResourceT IO (Either MinioErr a)

Similar to runMinioWith. Allows applications to allocate/release its resources along side MinIO's internal resources.

runMinioRes :: ConnectInfo -> Minio a -> ResourceT IO (Either MinioErr a)

Similar to runMinio. Allows applications to allocate/release its resources along side MinIO's internal resources.

Bucket Operations

Creation, removal and querying

type Bucket = Text

Represents a bucket in the object store

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 ()

Removes a bucket from the object store.

bucketExists :: Bucket -> Minio Bool

Query the object store if a given bucket is present.

type Region = Text

Represents a region

getLocation :: Bucket -> Minio Region

Fetch bucket location (region)

Listing buckets

data BucketInfo

BucketInfo returned for list buckets call

Constructors

BucketInfo

Fields

• biName :: Bucket
• biCreationDate :: UTCTime

Instances

Eq BucketInfo

Defined in Network.Minio.Data

Methods

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

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

Show BucketInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> BucketInfo -> ShowS

show :: BucketInfo -> String

showList :: [BucketInfo] -> ShowS

listBuckets :: Minio [BucketInfo]

Lists buckets.

Listing objects

listObjects :: Bucket -> Maybe Text -> Bool -> ConduitM () ListItem Minio ()

listObjects bucket prefix recurse lists objects in a bucket similar to a file system tree traversal.

If prefix is not Nothing, only items with the given prefix are listed, otherwise items under the bucket are returned.

If recurse is set to True all directories under the prefix are recursively traversed and only objects are returned.

If recurse is set to False, objects and directories immediately under the given prefix are returned (no recursive traversal is performed).

listObjectsV1 :: Bucket -> Maybe Text -> Bool -> ConduitM () ListItem Minio ()

Lists objects - similar to listObjects, however uses the older V1 AWS S3 API. Prefer listObjects to this.

data ListItem

Represents a list output item - either an object or an object prefix (i.e. a directory).

Constructors

ListItemObject ObjectInfo

ListItemPrefix Text

Instances

Eq ListItem

Defined in Network.Minio.ListOps

Methods

(==) :: ListItem -> ListItem -> Bool

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

Show ListItem

Defined in Network.Minio.ListOps

Methods

showsPrec :: Int -> ListItem -> ShowS

show :: ListItem -> String

showList :: [ListItem] -> ShowS

data ObjectInfo

Represents information about an object.

Instances

Eq ObjectInfo

Defined in Network.Minio.Data

Methods

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

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

Show ObjectInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> ObjectInfo -> ShowS

show :: ObjectInfo -> String

showList :: [ObjectInfo] -> ShowS

oiObject :: ObjectInfo -> Object

Object key

oiModTime :: ObjectInfo -> UTCTime

Modification time of the object

oiETag :: ObjectInfo -> ETag

ETag of the object

oiSize :: ObjectInfo -> Int64

Size of the object in bytes

oiUserMetadata :: ObjectInfo -> HashMap Text Text

A map of user-metadata pairs stored with an object (keys will not have the X-Amz-Meta- prefix).

oiMetadata :: ObjectInfo -> HashMap Text Text

A map of metadata key-value pairs (not including the user-metadata pairs)

Listing incomplete uploads

listIncompleteUploads :: Bucket -> Maybe Text -> Bool -> ConduitM () UploadInfo Minio ()

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.

type UploadId = Text

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

data UploadInfo

Represents information about a multipart upload.

Constructors

UploadInfo

Fields

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

Instances

Eq UploadInfo

Defined in Network.Minio.Data

Methods

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

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

Show UploadInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> UploadInfo -> ShowS

show :: UploadInfo -> String

showList :: [UploadInfo] -> ShowS

listIncompleteParts :: Bucket -> Object -> UploadId -> ConduitM () ObjectPartInfo Minio ()

List object parts of an ongoing multipart upload for given bucket, object and uploadId.

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

Defined in Network.Minio.Data

Methods

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

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

Show ObjectPartInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> ObjectPartInfo -> ShowS

show :: ObjectPartInfo -> String

showList :: [ObjectPartInfo] -> ShowS

Bucket Notifications

getBucketNotification :: Bucket -> Minio Notification

Retrieve the notification configuration on a bucket.

putBucketNotification :: Bucket -> Notification -> Minio ()

Set the notification configuration on a bucket.

removeAllBucketNotification :: Bucket -> Minio ()

Remove all notifications configured on a bucket.

data Notification

A data-type to represent bucket notification configuration. It is a collection of queue, topic or lambda function configurations. The structure of the types follow closely the XML representation described at https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTnotification.html

Constructors

Notification

Fields

• nQueueConfigurations :: [NotificationConfig]
• nTopicConfigurations :: [NotificationConfig]
• nCloudFunctionConfigurations :: [NotificationConfig]

Instances

Eq Notification

Defined in Network.Minio.Data

Methods

(==) :: Notification -> Notification -> Bool

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

Show Notification

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> Notification -> ShowS

show :: Notification -> String

showList :: [Notification] -> ShowS

defaultNotification :: Notification

The default notification configuration is empty.

data NotificationConfig

A data-type representing the configuration for a particular notification system. It could represent a Queue, Topic or Lambda Function configuration.

Constructors

NotificationConfig

Fields

• ncId :: Text
• ncArn :: Arn
• ncEvents :: [Event]
• ncFilter :: Filter

Instances

Eq NotificationConfig

Defined in Network.Minio.Data

Methods

(==) :: NotificationConfig -> NotificationConfig -> Bool

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

Show NotificationConfig

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> NotificationConfig -> ShowS

show :: NotificationConfig -> String

showList :: [NotificationConfig] -> ShowS

type Arn = Text

Arn is an alias of Text

data Event

A data-type for events that can occur in the object storage server. Reference: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#supported-notification-event-types

Constructors

ObjectCreated

ObjectCreatedPut

ObjectCreatedPost

ObjectCreatedCopy

ObjectCreatedMultipartUpload

ObjectRemoved

ObjectRemovedDelete

ObjectRemovedDeleteMarkerCreated

ReducedRedundancyLostObject

Instances

Eq Event

Defined in Network.Minio.Data

Methods

(==) :: Event -> Event -> Bool

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

Show Event

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

data Filter

Filter data type - part of notification configuration

Constructors

Filter

Fields

• fFilter :: FilterKey

Instances

Eq Filter

Defined in Network.Minio.Data

Methods

(==) :: Filter -> Filter -> Bool

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

Show Filter

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> Filter -> ShowS

show :: Filter -> String

showList :: [Filter] -> ShowS

defaultFilter :: Filter

defaultFilter is empty, used to create a notification configuration.

data FilterKey

FilterKey contains FilterRules, and is part of a Filter.

Constructors

FilterKey

Fields

• fkKey :: FilterRules

Instances

Eq FilterKey

Defined in Network.Minio.Data

Methods

(==) :: FilterKey -> FilterKey -> Bool

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

Show FilterKey

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> FilterKey -> ShowS

show :: FilterKey -> String

showList :: [FilterKey] -> ShowS

defaultFilterKey :: FilterKey

defaultFilterKey is empty, used to create notification configuration.

data FilterRules

FilterRules represents a collection of FilterRules.

Constructors

FilterRules

Fields

• frFilterRules :: [FilterRule]

Instances

Eq FilterRules

Defined in Network.Minio.Data

Methods

(==) :: FilterRules -> FilterRules -> Bool

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

Show FilterRules

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> FilterRules -> ShowS

show :: FilterRules -> String

showList :: [FilterRules] -> ShowS

defaultFilterRules :: FilterRules

defaultFilterRules is empty, used to create notification configuration.

data FilterRule

A filter rule that can act based on the suffix or prefix of an object. As an example, let's create two filter rules:

let suffixRule = FilterRule "suffix" ".jpg"
let prefixRule = FilterRule "prefix" "images/"

The suffixRule restricts the notification to be triggered only for objects having a suffix of ".jpg", and the prefixRule restricts it to objects having a prefix of "images/".

Constructors

FilterRule

Fields

• frName :: Text
• frValue :: Text

Instances

Eq FilterRule

Defined in Network.Minio.Data

Methods

(==) :: FilterRule -> FilterRule -> Bool

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

Show FilterRule

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> FilterRule -> ShowS

show :: FilterRule -> String

showList :: [FilterRule] -> ShowS

Object Operations

type Object = Text

Represents an object name

File-based operations

fGetObject :: Bucket -> Object -> FilePath -> GetObjectOptions -> 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 -> PutObjectOptions -> Minio ()

Upload the given file to the given object.

Conduit-based streaming operations

putObject :: Bucket -> Object -> ConduitM () ByteString Minio () -> Maybe Int64 -> PutObjectOptions -> 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.

data PutObjectOptions

Data type for options in PutObject call. Start with the empty defaultPutObjectOptions and use various the various poo* accessors.

defaultPutObjectOptions :: PutObjectOptions

Provide default PutObjectOptions.

pooContentType :: PutObjectOptions -> Maybe Text

Set a standard MIME type describing the format of the object.

pooContentEncoding :: PutObjectOptions -> Maybe Text

Set what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

pooContentDisposition :: PutObjectOptions -> Maybe Text

Set presentational information for the object.

pooContentLanguage :: PutObjectOptions -> Maybe Text

Set to describe the language(s) intended for the audience.

pooCacheControl :: PutObjectOptions -> Maybe Text

Set to specify caching behavior for the object along the request/reply chain.

pooStorageClass :: PutObjectOptions -> Maybe Text

Set to STANDARD or REDUCED_REDUNDANCY depending on your performance needs, storage class is STANDARD by default (i.e when Nothing is passed).

pooUserMetadata :: PutObjectOptions -> [(Text, Text)]

Set user defined metadata to store with the object.

pooNumThreads :: PutObjectOptions -> Maybe Word

Set number of worker threads used to upload an object.

pooSSE :: PutObjectOptions -> Maybe SSE

Set object encryption parameters for the request.

getObject :: Bucket -> Object -> GetObjectOptions -> Minio GetObjectResponse

Get an object from the object store.

data GetObjectOptions

Data type for options when getting an object from the service. Start with the empty defaultGetObjectOptions and modify it using the goo* functions.

defaultGetObjectOptions :: GetObjectOptions

Provide default GetObjectOptions.

gooRange :: GetObjectOptions -> Maybe ByteRange

Set object's data of given offset begin and end, [ByteRangeFromTo 0 9] means first ten bytes of the source object.

gooIfMatch :: GetObjectOptions -> Maybe ETag

Set matching ETag condition, GetObject which matches the following ETag.

gooIfNoneMatch :: GetObjectOptions -> Maybe ETag

Set matching ETag none condition, GetObject which does not match the following ETag.

gooIfModifiedSince :: GetObjectOptions -> Maybe UTCTime

Set object modified condition, GetObject modified since given time.

gooIfUnmodifiedSince :: GetObjectOptions -> Maybe UTCTime

Set object unmodified condition, GetObject unmodified since given time.

gooSSECKey :: GetObjectOptions -> Maybe SSECKey

Specify SSE-C key

data GetObjectResponse

Data type returned by getObject representing the object being retrieved. Use the gor* functions to access its contents.

gorObjectInfo :: GetObjectResponse -> ObjectInfo

ObjectInfo of the object being retrieved.

gorObjectStream :: GetObjectResponse -> ConduitM () ByteString Minio ()

A conduit of the bytes of the object.

Server-side object copying

copyObject :: DestinationInfo -> SourceInfo -> Minio ()

Perform a server-side copy operation to create an object based on the destination specification in DestinationInfo from the source specification in SourceInfo. This function performs a multipart copy operation if the new object is to be greater than 5GiB in size.

data SourceInfo

Represents source object in server-side copy object

Instances

Eq SourceInfo

Defined in Network.Minio.Data

Methods

(==) :: SourceInfo -> SourceInfo -> Bool

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

Show SourceInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> SourceInfo -> ShowS

show :: SourceInfo -> String

showList :: [SourceInfo] -> ShowS

defaultSourceInfo :: SourceInfo

Provide a default for SourceInfo

srcBucket :: SourceInfo -> Text

Bucket containing the source object

srcObject :: SourceInfo -> Text

Source object key

srcRange :: SourceInfo -> Maybe (Int64, Int64)

Source object byte-range (inclusive)

srcIfMatch :: SourceInfo -> Maybe Text

ETag condition on source - object is copied only if the source object's ETag matches this value.

srcIfNoneMatch :: SourceInfo -> Maybe Text

ETag not match condition on source - object is copied if ETag does not match this value.

srcIfModifiedSince :: SourceInfo -> Maybe UTCTime

Copy source object only if the source has been modified since this time.

srcIfUnmodifiedSince :: SourceInfo -> Maybe UTCTime

Copy source object only if the source has been un-modified since this given time.

data DestinationInfo

Represents destination object in server-side copy object

Instances

Eq DestinationInfo

Defined in Network.Minio.Data

Methods

(==) :: DestinationInfo -> DestinationInfo -> Bool

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

Show DestinationInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> DestinationInfo -> ShowS

show :: DestinationInfo -> String

showList :: [DestinationInfo] -> ShowS

defaultDestinationInfo :: DestinationInfo

Provide a default for DestinationInfo

dstBucket :: DestinationInfo -> Text

Destination bucket

dstObject :: DestinationInfo -> Text

Destination object key

Querying object info

statObject :: Bucket -> Object -> GetObjectOptions -> Minio ObjectInfo

Get an object's metadata from the object store. It accepts the same options as GetObject.

Object removal operations

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

Remove an object from the object store.

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

Removes an ongoing multipart upload of an object.

Select Object Content with SQL

The selectObjectContent allows querying CSV, JSON or Parquet format objects in AWS S3 and in MinIO using SQL Select statements. This allows significant reduction of data transfer from object storage for computation-intensive tasks, as relevant data is filtered close to the storage.

selectObjectContent :: Bucket -> Object -> SelectRequest -> Minio (ConduitT () EventMessage Minio ())

selectObjectContent calls the SelectRequest on the given object. It returns a Conduit of event messages that can be consumed by the client.

data SelectRequest

SelectRequest represents the Select API call. Use the selectRequest function to create a value of this type.

Instances

Eq SelectRequest

Defined in Network.Minio.Data

Methods

(==) :: SelectRequest -> SelectRequest -> Bool

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

Show SelectRequest

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> SelectRequest -> ShowS

show :: SelectRequest -> String

showList :: [SelectRequest] -> ShowS

selectRequest :: Text -> InputSerialization -> OutputSerialization -> SelectRequest

selectRequest is used to build a SelectRequest value. selectRequest query inputSer outputSer represents a SelectRequest with the SQL query text given by query, the input serialization settings (compression format and format information) inputSer and the output serialization settings outputSer.

Input Serialization

data InputSerialization

InputSerialization represents format information of the input object being queried. Use one of the smart constructors such as defaultCsvInput as a starting value, and add compression info using setInputCompressionType

Instances

Eq InputSerialization

Defined in Network.Minio.Data

Methods

(==) :: InputSerialization -> InputSerialization -> Bool

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

Show InputSerialization

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> InputSerialization -> ShowS

show :: InputSerialization -> String

showList :: [InputSerialization] -> ShowS

defaultCsvInput :: InputSerialization

defaultCsvInput returns InputSerialization with default CSV format, and without any compression setting.

linesJsonInput :: InputSerialization

linesJsonInput returns InputSerialization with JSON line based format with no compression setting.

documentJsonInput :: InputSerialization

documentJsonInput returns InputSerialization with JSON document based format with no compression setting.

defaultParquetInput :: InputSerialization

defaultParquetInput returns InputSerialization with Parquet format, and no compression setting.

setInputCSVProps :: CSVProp -> InputSerialization -> InputSerialization

Set the CSV format properties in the InputSerialization.

data CompressionType

Data type representing the compression setting in a Select request.

Constructors

CompressionTypeNone

CompressionTypeGzip

CompressionTypeBzip2

Instances

Eq CompressionType

Defined in Network.Minio.Data

Methods

(==) :: CompressionType -> CompressionType -> Bool

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

Show CompressionType

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> CompressionType -> ShowS

show :: CompressionType -> String

showList :: [CompressionType] -> ShowS

setInputCompressionType :: CompressionType -> SelectRequest -> SelectRequest

setInputCompressionType sets the compression type for the input of the SelectRequest

CSV Format details

CSV format options such as delimiters and quote characters are specified using using the functions below. Options are combined monoidally.

data CSVProp

CSVProp represents CSV format properties. It is built up using the Monoid instance.

Instances

Eq CSVProp

Defined in Network.Minio.Data

Methods

(==) :: CSVProp -> CSVProp -> Bool

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

Show CSVProp

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> CSVProp -> ShowS

show :: CSVProp -> String

showList :: [CSVProp] -> ShowS

Semigroup CSVProp

Defined in Network.Minio.Data

Methods

(<>) :: CSVProp -> CSVProp -> CSVProp

sconcat :: NonEmpty CSVProp -> CSVProp

stimes :: Integral b => b -> CSVProp -> CSVProp

Monoid CSVProp

Defined in Network.Minio.Data

Methods

mempty :: CSVProp

mappend :: CSVProp -> CSVProp -> CSVProp

mconcat :: [CSVProp] -> CSVProp

recordDelimiter :: Text -> CSVProp

Specify the CSV record delimiter property.

fieldDelimiter :: Text -> CSVProp

Specify the CSV field delimiter property.

quoteCharacter :: Text -> CSVProp

Specify the CSV quote character property.

quoteEscapeCharacter :: Text -> CSVProp

Specify the CSV quote-escape character property.

commentCharacter :: Text -> CSVProp

Specify the CSV comment character property. Lines starting with this character are ignored by the server.

allowQuotedRecordDelimiter :: CSVProp

Allow quoted record delimiters inside a row using this property.

data FileHeaderInfo

FileHeaderInfo specifies information about column headers for CSV format.

Constructors

FileHeaderNone

No column headers are present

FileHeaderUse

Headers are present and they should be used

FileHeaderIgnore

Header are present, but should be ignored

Instances

Eq FileHeaderInfo

Defined in Network.Minio.Data

Methods

(==) :: FileHeaderInfo -> FileHeaderInfo -> Bool

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

Show FileHeaderInfo

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> FileHeaderInfo -> ShowS

show :: FileHeaderInfo -> String

showList :: [FileHeaderInfo] -> ShowS

fileHeaderInfo :: FileHeaderInfo -> CSVProp

Specify the CSV file header info property.

data QuoteFields

Represent the QuoteField setting.

Constructors

QuoteFieldsAsNeeded

QuoteFieldsAlways

Instances

Eq QuoteFields

Defined in Network.Minio.Data

Methods

(==) :: QuoteFields -> QuoteFields -> Bool

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

Show QuoteFields

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> QuoteFields -> ShowS

show :: QuoteFields -> String

showList :: [QuoteFields] -> ShowS

quoteFields :: QuoteFields -> CSVProp

quoteFields is an output serialization parameter

Output Serialization

data OutputSerialization

OutputSerialization represents output serialization settings for the SelectRequest. Use defaultCsvOutput or defaultJsonOutput as a starting point.

Instances

Eq OutputSerialization

Defined in Network.Minio.Data

Methods

(==) :: OutputSerialization -> OutputSerialization -> Bool

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

Show OutputSerialization

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> OutputSerialization -> ShowS

show :: OutputSerialization -> String

showList :: [OutputSerialization] -> ShowS

defaultCsvOutput :: OutputSerialization

defaultCsvOutput returns OutputSerialization with default CSV format.

defaultJsonOutput :: OutputSerialization

defaultJsonInput returns OutputSerialization with default JSON format.

outputCSVFromProps :: CSVProp -> OutputSerialization

Set the CSV format properties in the OutputSerialization.

outputJSONFromRecordDelimiter :: Text -> OutputSerialization

Set the output record delimiter for JSON format

Progress messages

setRequestProgressEnabled :: Bool -> SelectRequest -> SelectRequest

setRequestProgressEnabled sets the flag for turning on progress messages when the Select response is being streamed back to the client.

Interpreting Select output

The conduit returned by selectObjectContent returns values of the EventMessage data type. This returns the query output messages formatted according to the chosen output serialization, interleaved with progress messages (if enabled by setRequestProgressEnabled), and at the end a statistics message.

If the application is interested in only the payload, then getPayloadBytes can be used. For example to simply print the payload to stdout:

resultConduit <- selectObjectContent bucket object mySelectRequest
runConduit $ resultConduit .| getPayloadBytes .| stdoutC

Note that runConduit, the connect operator (.|) and stdoutC are all from the "conduit" package.

getPayloadBytes :: MonadIO m => ConduitT EventMessage ByteString m ()

A helper conduit that returns only the record payload bytes.

data EventMessage

An EventMessage represents each kind of message received from the server.

Constructors

ProgressEventMessage

Fields

• emProgress :: Progress

StatsEventMessage

Fields

• emStats :: Stats

RequestLevelErrorMessage

Fields

• emErrorCode :: Text
• emErrorMessage :: Text

RecordPayloadEventMessage

Fields

• emPayloadBytes :: ByteString

Instances

Eq EventMessage

Defined in Network.Minio.Data

Methods

(==) :: EventMessage -> EventMessage -> Bool

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

Show EventMessage

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> EventMessage -> ShowS

show :: EventMessage -> String

showList :: [EventMessage] -> ShowS

data Progress

Represent the progress event returned in the Select response.

Constructors

Progress

Fields

• pBytesScanned :: Int64
• pBytesProcessed :: Int64
• pBytesReturned :: Int64

Instances

Eq Progress

Defined in Network.Minio.Data

Methods

(==) :: Progress -> Progress -> Bool

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

Show Progress

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> Progress -> ShowS

show :: Progress -> String

showList :: [Progress] -> ShowS

type Stats = Progress

Represent the stats event returned at the end of the Select response.

Server-Side Encryption Helpers

mkSSECKey :: MonadThrow m => ByteString -> m SSECKey

Validates that the given ByteString is 32 bytes long and creates an encryption key.

data SSECKey

Data type to represent an object encryption key. Create one using the mkSSECKey function.

Instances

Eq SSECKey

Defined in Network.Minio.Data

Methods

(==) :: SSECKey -> SSECKey -> Bool

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

Show SSECKey

Defined in Network.Minio.Data

Methods

showsPrec :: Int -> SSECKey -> ShowS

show :: SSECKey -> String

showList :: [SSECKey] -> ShowS

data SSE where

Data type to represent Server-Side-Encryption settings

Constructors

SSE :: SSE

Specifies SSE S3 encryption - server manages encryption keys

SSEKMS :: ToJSON a => Maybe ByteString -> Maybe a -> SSE

Specifies that KMS service should be used. The first argument to the constructor is the Key Id to be used by the server (if not specified, the default KMS key id is used). The second argument is the optional KMS context that must have a ToJSON instance - please refer to the AWS S3 documentation for detailed information.

SSEC :: SSECKey -> SSE

Specifies server-side encryption with customer provided key. The argument is the encryption key to be used.

Presigned Operations

presignedPutObjectUrl :: Bucket -> Object -> UrlExpiry -> RequestHeaders -> Minio ByteString

Generate a URL with authentication signature to PUT (upload) an object. Any extra headers if passed, are signed, and so they are required when the URL is used to upload data. This could be used, for example, to set user-metadata on the object.

For a list of possible headers to pass, please refer to the PUT object REST API AWS S3 documentation.

presignedGetObjectUrl :: Bucket -> Object -> UrlExpiry -> Query -> RequestHeaders -> Minio ByteString

Generate a URL with authentication signature to GET (download) an object. All extra query parameters and headers passed here will be signed and are required when the generated URL is used. Query parameters could be used to change the response headers sent by the server. Headers can be used to set Etag match conditions among others.

For a list of possible request parameters and headers, please refer to the GET object REST API AWS S3 documentation.

presignedHeadObjectUrl :: Bucket -> Object -> UrlExpiry -> RequestHeaders -> Minio ByteString

Generate a URL with authentication signature to make a HEAD request on an object. This is used to fetch metadata about an object. All extra headers passed here will be signed and are required when the generated URL is used.

For a list of possible headers to pass, please refer to the HEAD object REST API AWS S3 documentation.

type UrlExpiry = Int

Time to expire for a presigned URL. It interpreted as a number of seconds. The maximum duration that can be specified is 7 days.

POST (browser) upload helpers

Please see https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-HTTPPOSTConstructPolicy.html for detailed information.

newPostPolicy :: UTCTime -> [PostPolicyCondition] -> Either PostPolicyError PostPolicy

This function creates a PostPolicy after validating its arguments.

presignedPostPolicy :: PostPolicy -> Minio (ByteString, HashMap Text ByteString)

Generate a presigned URL and POST policy to upload files via a browser. On success, this function returns a URL and POST form-data.

showPostPolicy :: PostPolicy -> ByteString

Convert Post Policy to a string (e.g. for printing).

data PostPolicy

A PostPolicy is required to perform uploads via browser forms.

Instances

Eq PostPolicy

Defined in Network.Minio.PresignedOperations

Methods

(==) :: PostPolicy -> PostPolicy -> Bool

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

Show PostPolicy

Defined in Network.Minio.PresignedOperations

Methods

showsPrec :: Int -> PostPolicy -> ShowS

show :: PostPolicy -> String

showList :: [PostPolicy] -> ShowS

ToJSON PostPolicy

Defined in Network.Minio.PresignedOperations

Methods

toJSON :: PostPolicy -> Value

toEncoding :: PostPolicy -> Encoding

toJSONList :: [PostPolicy] -> Value

toEncodingList :: [PostPolicy] -> Encoding

data PostPolicyError

Possible validation errors when creating a PostPolicy.

Constructors

PPEKeyNotSpecified

PPEBucketNotSpecified

PPEConditionKeyEmpty

PPERangeInvalid

Instances

Eq PostPolicyError

Defined in Network.Minio.PresignedOperations

Methods

(==) :: PostPolicyError -> PostPolicyError -> Bool

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

Show PostPolicyError

Defined in Network.Minio.PresignedOperations

Methods

showsPrec :: Int -> PostPolicyError -> ShowS

show :: PostPolicyError -> String

showList :: [PostPolicyError] -> ShowS

Post Policy condition helpers

data PostPolicyCondition

Represents individual conditions in a Post Policy document.

Instances

Eq PostPolicyCondition

Defined in Network.Minio.PresignedOperations

Methods

(==) :: PostPolicyCondition -> PostPolicyCondition -> Bool

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

Show PostPolicyCondition

Defined in Network.Minio.PresignedOperations

Methods

showsPrec :: Int -> PostPolicyCondition -> ShowS

show :: PostPolicyCondition -> String

showList :: [PostPolicyCondition] -> ShowS

ToJSON PostPolicyCondition

Defined in Network.Minio.PresignedOperations

Methods

toJSON :: PostPolicyCondition -> Value

toEncoding :: PostPolicyCondition -> Encoding

toJSONList :: [PostPolicyCondition] -> Value

toEncodingList :: [PostPolicyCondition] -> Encoding

ppCondBucket :: Bucket -> PostPolicyCondition

Set the bucket name that the upload should use.

ppCondContentLengthRange :: Int64 -> Int64 -> PostPolicyCondition

Set the content length range constraint with minimum and maximum byte count values.

ppCondContentType :: Text -> PostPolicyCondition

Set the content-type header for the upload.

ppCondKey :: Object -> PostPolicyCondition

Set the object name constraint for the upload.

ppCondKeyStartsWith :: Object -> PostPolicyCondition

Set the object name prefix constraint for the upload.

ppCondSuccessActionStatus :: Int -> PostPolicyCondition

Status code that the S3-server should send on a successful POST upload

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

Defined in Network.Minio.Errors

Methods

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

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

Show MinioErr

Defined in Network.Minio.Errors

Methods

showsPrec :: Int -> MinioErr -> ShowS

show :: MinioErr -> String

showList :: [MinioErr] -> ShowS

Exception MinioErr

Defined in Network.Minio.Errors

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

MErrVInvalidUrlExpiry Int

MErrVJsonParse Text

MErrVInvalidHealPath

MErrVMissingCredentials

MErrVInvalidEncryptionKeyLength

MErrVStreamingBodyUnexpectedEOF

MErrVUnexpectedPayload

Instances

Eq MErrV

Defined in Network.Minio.Errors

Methods

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

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

Show MErrV

Defined in Network.Minio.Errors

Methods

showsPrec :: Int -> MErrV -> ShowS

show :: MErrV -> String

showList :: [MErrV] -> ShowS

Exception MErrV

Defined in Network.Minio.Errors

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

SelectErr Text Text

ServiceErr Text Text

Instances

Eq ServiceErr

Defined in Network.Minio.Errors

Methods

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

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

Show ServiceErr

Defined in Network.Minio.Errors

Methods

showsPrec :: Int -> ServiceErr -> ShowS

show :: ServiceErr -> String

showList :: [ServiceErr] -> ShowS

Exception ServiceErr

Defined in Network.Minio.Errors

Methods

toException :: ServiceErr -> SomeException

fromException :: SomeException -> Maybe ServiceErr

displayException :: ServiceErr -> String