haskell/minio-hs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove port :9000 for play.min.io (#130)

Browse Source
This commit is contained in:
Harshavardhana 2019-07-24 10:07:54 -07:00 committed by Aditya Manthramurthy
parent 0bcb1c9b33
commit 3291f8673c
18 changed files with 200 additions and 200 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -25,7 +25,7 @@ stack test
``` ```
A section of the tests use the remote MinIO Play server at A section of the tests use the remote MinIO Play server at
`https://play.min.io:9000` by default. For library development, `https://play.min.io` by default. For library development,
using this remote server maybe slow. To run the tests against a using this remote server maybe slow. To run the tests against a
locally running MinIO live server at `http://localhost:9000`, just set locally running MinIO live server at `http://localhost:9000`, just set
the environment `MINIO_LOCAL` to any value (and unset it to switch the environment `MINIO_LOCAL` to any value (and unset it to switch
@ -47,7 +47,7 @@ stack haddock
-- stack --resolver lts-11.1 runghc --package minio-hs --package optparse-applicative --package filepath -- stack --resolver lts-11.1 runghc --package minio-hs --package optparse-applicative --package filepath
-- --
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc. -- MinIO Haskell SDK, (C) 2017-2019 MinIO, Inc.
-- --
-- Licensed under the Apache License, Version 2.0 (the "License"); -- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License. -- you may not use this file except in compliance with the License.
@ -76,7 +76,7 @@ import UnliftIO (throwIO, try)
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

358
docs/API.md
View File

@ -20,15 +20,15 @@ awsCI { connectAccesskey = "your-access-key"
``` ```
|Bucket operations|Object Operations|Presigned Operations| | Bucket operations | Object Operations | Presigned Operations |
|:---|:---|:---| |:--------------------------------------------------|:----------------------------------------------|:--------------------------------------------------|
|[`listBuckets`](#listBuckets) |[`getObject`](#getObject)|[`presignedGetObjectUrl`](#presignedGetObjectUrl)| | [`listBuckets`](#listBuckets) | [`getObject`](#getObject) | [`presignedGetObjectUrl`](#presignedGetObjectUrl) |
|[`makeBucket`](#makeBucket)|[`putObject`](#putObject)|[`presignedPutObjectUrl`](#presignedPutObjectUrl)| | [`makeBucket`](#makeBucket) | [`putObject`](#putObject) | [`presignedPutObjectUrl`](#presignedPutObjectUrl) |
|[`removeBucket`](#removeBucket)|[`fGetObject`](#fGetObject)|[`presignedPostPolicy`](#presignedPostPolicy)| | [`removeBucket`](#removeBucket) | [`fGetObject`](#fGetObject) | [`presignedPostPolicy`](#presignedPostPolicy) |
|[`listObjects`](#listObjects)|[`fPutObject`](#fPutObject)|| | [`listObjects`](#listObjects) | [`fPutObject`](#fPutObject) | |
|[`listObjectsV1`](#listObjectsV1)|[`copyObject`](#copyObject)|| | [`listObjectsV1`](#listObjectsV1) | [`copyObject`](#copyObject) | |
|[`listIncompleteUploads`](#listIncompleteUploads)|[`removeObject`](#removeObject)|| | [`listIncompleteUploads`](#listIncompleteUploads) | [`removeObject`](#removeObject) | |
|[`bucketExists`](#bucketExists)|[`selectObjectContent`](#selectObjectContent)|| | [`bucketExists`](#bucketExists) | [`selectObjectContent`](#selectObjectContent) | |
## 1. Connecting and running operations on the storage service ## 1. Connecting and running operations on the storage service
@ -69,16 +69,16 @@ enable/disable the automatic region discovery behaviour.
The parameters in the expression `awsWithRegion region autoDiscover` are: The parameters in the expression `awsWithRegion region autoDiscover` are:
|Parameter|Type|Description| | Parameter | Type | Description |
|:---|:---|:---| |:---------------|:----------------------------|:---------------------------------------------------------------------------------------------------------------------------|
| `region` | _Region_ (alias for `Text`) | The region to connect to by default for all requests. | | `region` | _Region_ (alias for `Text`) | The region to connect to by default for all requests. |
| `autoDiscover` | _Bool_ | If `True`, region discovery will be enabled. If `False`, discovery is disabled, and all requests go the given region only.| | `autoDiscover` | _Bool_ | If `True`, region discovery will be enabled. If `False`, discovery is disabled, and all requests go the given region only. |
#### minioPlayCI :: ConnectInfo #### minioPlayCI :: ConnectInfo
This constructor provides connection and authentication information to This constructor provides connection and authentication information to
connect to the public MinIO Play server at connect to the public MinIO Play server at
`https://play.min.io:9000/`. `https://play.min.io/`.
#### minioCI :: Text -> Int -> Bool -> ConnectInfo #### minioCI :: Text -> Int -> Bool -> ConnectInfo
@ -86,25 +86,25 @@ Use to connect to a MinIO server.
The parameters in the expression `minioCI host port isSecure` are: The parameters in the expression `minioCI host port isSecure` are:
|Parameter|Type|Description| | Parameter | Type | Description |
|:---|:---|:---| |:-----------|:-------|:--------------------------------------------------------|
| `host` | _Text_ | Hostname of the MinIO or other S3-API compatible server | | `host` | _Text_ | Hostname of the MinIO or other S3-API compatible server |
| `port` | _Int_ | Port number to connect to| | `port` | _Int_ | Port number to connect to |
| `isSecure` | _Bool_ | Does the server use HTTPS? | | `isSecure` | _Bool_ | Does the server use HTTPS? |
#### The ConnectInfo fields and Default instance #### The ConnectInfo fields and Default instance
The following table shows the fields in the `ConnectInfo` record-type: The following table shows the fields in the `ConnectInfo` record-type:
| Field | Type | Description | | Field | Type | Description |
|:---|:---|:---| |:----------------------------|:----------------------------|:--------------------------------------------------------------------------------------------------|
| `connectHost` | _Text_ | Host name of the server. Defaults to `localhost`. | | `connectHost` | _Text_ | Host name of the server. Defaults to `localhost`. |
| `connectPort` | _Int_ | Port number on which the server listens. Defaults to `9000`. | | `connectPort` | _Int_ | Port number on which the server listens. Defaults to `9000`. |
| `connectAccessKey` | _Text_ | Access key to use in authentication. Defaults to `minio`. | | `connectAccessKey` | _Text_ | Access key to use in authentication. Defaults to `minio`. |
| `connectSecretkey` | _Text_ | Secret key to use in authentication. Defaults to `minio123`. | | `connectSecretkey` | _Text_ | Secret key to use in authentication. Defaults to `minio123`. |
| `connectIsSecure` | _Bool_ | Specifies if the server used TLS. Defaults to `False` | | `connectIsSecure` | _Bool_ | Specifies if the server used TLS. Defaults to `False` |
| `connectRegion` | _Region_ (alias for `Text`) | Specifies the region to use. Defaults to 'us-east-1' | | `connectRegion` | _Region_ (alias for `Text`) | Specifies the region to use. Defaults to 'us-east-1' |
| `connectAutoDiscoverRegion` | _Bool_ | Specifies if the library should automatically discover the region of a bucket. Defaults to `True`| | `connectAutoDiscoverRegion` | _Bool_ | Specifies if the library should automatically discover the region of a bucket. Defaults to `True` |
The `def` value of type `ConnectInfo` has all the above default The `def` value of type `ConnectInfo` has all the above default
values. values.
@ -148,17 +148,17 @@ Lists buckets.
__Return Value__ __Return Value__
|Return type |Description | | Return type | Description |
|:---|:---| |:---------------------|:----------------|
| _Minio [BucketInfo]_| List of buckets | | _Minio [BucketInfo]_ | List of buckets |
__BucketInfo record type__ __BucketInfo record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:-----------------|:---------------------------|:----------------------------|
| `biName` | _Bucket_ (alias of `Text`) | Name of the bucket | | `biName` | _Bucket_ (alias of `Text`) | Name of the bucket |
| `biCreationDate` | _UTCTime_ | Creation time of the bucket | | `biCreationDate` | _UTCTime_ | Creation time of the bucket |
<a name="makeBucket"></a> <a name="makeBucket"></a>
@ -171,10 +171,10 @@ __Parameters__
In the expression `makeBucket bucketName region` the arguments are: In the expression `makeBucket bucketName region` the arguments are:
| Param | Type | Description | | Param | Type | Description |
|---|---|---| |--------------|-----------------------------|-----------------------------------------------------------------------------------------------------|
|`bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `region` | _Maybe Region_ | Region where the bucket is to be created. If not specified, default to the region in `ConnectInfo`.| | `region` | _Maybe Region_ | Region where the bucket is to be created. If not specified, default to the region in `ConnectInfo`. |
__Example__ __Example__
@ -200,9 +200,9 @@ __Parameters__
In the expression `removeBucket bucketName` the arguments are: In the expression `removeBucket bucketName` the arguments are:
| Param | Type | Description | | Param | Type | Description |
|---|---|---| |--------------|-----------------------------|--------------------|
|`bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
__Example__ __Example__
@ -233,26 +233,26 @@ __Parameters__
In the expression `listObjects bucketName prefix recursive` the In the expression `listObjects bucketName prefix recursive` the
arguments are: arguments are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have | | `prefix` | _Maybe Text_ | Optional prefix that listed objects should have |
| `recursive` | _Bool_ |`True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. | | `recursive` | _Bool_ | `True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. |
__Return Value__ __Return Value__
|Return type |Description | | Return type | Description |
|:---|:---| |:------------------------------------|:------------------------------------------------------------------------|
| _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. | | _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. |
__ObjectInfo record type__ __ObjectInfo record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:------------|:----------------------------|:---------------------------------|
|`oiObject` | _Object_ (alias for `Text`) | Name of object | | `oiObject` | _Object_ (alias for `Text`) | Name of object |
|`oiModTime` | _UTCTime_ | Last modified time of the object | | `oiModTime` | _UTCTime_ | Last modified time of the object |
|`oiETag` | _ETag_ (alias for `Text`) | ETag of the object | | `oiETag` | _ETag_ (alias for `Text`) | ETag of the object |
|`oiSize` | _Int64_ | Size of the object in bytes | | `oiSize` | _Int64_ | Size of the object in bytes |
__Example__ __Example__
@ -265,7 +265,7 @@ import Prelude
-- | The following example uses MinIO play server at -- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -294,26 +294,26 @@ __Parameters__
In the expression `listObjectsV1 bucketName prefix recursive` the In the expression `listObjectsV1 bucketName prefix recursive` the
arguments are: arguments are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have | | `prefix` | _Maybe Text_ | Optional prefix that listed objects should have |
| `recursive` | _Bool_ |`True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. | | `recursive` | _Bool_ | `True` indicates recursive style listing and `False` indicates directory style listing delimited by '/'. |
__Return Value__ __Return Value__
|Return type |Description | | Return type | Description |
|:---|:---| |:------------------------------------|:------------------------------------------------------------------------|
| _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. | | _C.ConduitM () ObjectInfo Minio ()_ | A Conduit Producer of `ObjectInfo` values corresponding to each object. |
__ObjectInfo record type__ __ObjectInfo record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:------------|:----------------------------|:---------------------------------|
|`oiObject` | _Object_ (alias for `Text`) | Name of object | | `oiObject` | _Object_ (alias for `Text`) | Name of object |
|`oiModTime` | _UTCTime_ | Last modified time of the object | | `oiModTime` | _UTCTime_ | Last modified time of the object |
|`oiETag` | _ETag_ (alias for `Text`) | ETag of the object | | `oiETag` | _ETag_ (alias for `Text`) | ETag of the object |
|`oiSize` | _Int64_ | Size of the object in bytes | | `oiSize` | _Int64_ | Size of the object in bytes |
__Example__ __Example__
@ -326,7 +326,7 @@ import Prelude
-- | The following example uses MinIO play server at -- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -354,11 +354,11 @@ __Parameters__
In the expression `listIncompleteUploads bucketName prefix recursive` In the expression `listIncompleteUploads bucketName prefix recursive`
the parameters are: the parameters are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:---------------------------------------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `prefix` | _Maybe Text_ | Optional prefix that listed objects should have. | | `prefix` | _Maybe Text_ | Optional prefix that listed objects should have. |
| `recursive` | _Bool_ |`True` indicates recursive style listing and `Talse` indicates directory style listing delimited by '/'. | | `recursive` | _Bool_ | `True` indicates recursive style listing and `Talse` indicates directory style listing delimited by '/'. |
__Return Value__ __Return Value__
@ -368,11 +368,11 @@ __Return Value__
__UploadInfo record type__ __UploadInfo record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:-------------|:---------|:------------------------------------------|
|`uiKey` | _Object_ |Name of incompletely uploaded object | | `uiKey` | _Object_ | Name of incompletely uploaded object |
|`uiUploadId` | _String_ |Upload ID of incompletely uploaded object | | `uiUploadId` | _String_ | Upload ID of incompletely uploaded object |
|`uiSize` | _Int64_ |Size of incompletely uploaded object | | `uiSize` | _Int64_ | Size of incompletely uploaded object |
__Example__ __Example__
@ -384,7 +384,7 @@ import Conduit
import Prelude import Prelude
-- | The following example uses MinIO play server at -- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -415,29 +415,29 @@ __Parameters__
In the expression `getObject bucketName objectName opts` the parameters In the expression `getObject bucketName objectName opts` the parameters
are: are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:----------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `opts` | _GetObjectOptions_ | Options for GET requests specifying additional options like If-Match, Range | | `opts` | _GetObjectOptions_ | Options for GET requests specifying additional options like If-Match, Range |
__GetObjectOptions record type__ __GetObjectOptions record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:-----------------------|:--------------------------------|:------------------------------------------------------------------------------------------------------|
| `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object| | `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object |
| `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match | | `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match |
| `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match | | `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match |
| `gooIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since object wasn't modified | | `gooIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since object wasn't modified |
| `gooIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since object was modified | | `gooIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since object was modified |
__Return Value__ __Return Value__
The return value can be incrementally read to process the contents of The return value can be incrementally read to process the contents of
the object. the object.
|Return type |Description | | Return type | Description |
|:---|:---| |:--------------------------------------------|:-----------------------------------------|
| _Minio (C.ConduitM () ByteString Minio ())_ | A Conduit source of `ByteString` values. | | _Minio (C.ConduitM () ByteString Minio ())_ | A Conduit source of `ByteString` values. |
__Example__ __Example__
@ -451,7 +451,7 @@ import qualified Data.Conduit.Binary as CB
import Prelude import Prelude
-- | The following example uses MinIO play server at -- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -482,13 +482,13 @@ __Parameters__
In the expression `putObject bucketName objectName inputSrc` the parameters In the expression `putObject bucketName objectName inputSrc` the parameters
are: are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:------------------------------------|:------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputSrc` | _C.ConduitM () ByteString Minio ()_ | A Conduit producer of `ByteString` values | | `inputSrc` | _C.ConduitM () ByteString Minio ()_ | A Conduit producer of `ByteString` values |
| `size` | _Int64_ | Provide stream size (optional) | | `size` | _Int64_ | Provide stream size (optional) |
| `opts` | _PutObjectOptions_ | Optional parameters to provide additional metadata for the object | | `opts` | _PutObjectOptions_ | Optional parameters to provide additional metadata for the object |
__Example__ __Example__
@ -501,7 +501,7 @@ import qualified Data.Conduit.Combinators as CC
import Prelude import Prelude
-- | The following example uses MinIO play server at -- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -533,23 +533,23 @@ __Parameters__
In the expression `fGetObject bucketName objectName inputFile` the parameters In the expression `fGetObject bucketName objectName inputFile` the parameters
are: are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:----------------------------------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputFile` | _FilePath_ | Path to the file to be uploaded | | `inputFile` | _FilePath_ | Path to the file to be uploaded |
| `opts` | _GetObjectOptions_ | Options for GET requests specifying additional options like If-Match, Range | | `opts` | _GetObjectOptions_ | Options for GET requests specifying additional options like If-Match, Range |
__GetObjectOptions record type__ __GetObjectOptions record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:-----------------------|:--------------------------------|:------------------------------------------------------------------------------------------------------|
| `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object| | `gooRange` | `Maybe ByteRanges` | Represents the byte range of object. E.g ByteRangeFromTo 0 9 represents first ten bytes of the object |
| `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match | | `gooIfMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object should match |
| `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match | | `gooIfNoneMatch` | `Maybe ETag` (alias for `Text`) | (Optional) ETag of object shouldn't match |
| `gooIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since object wasn't modified | | `gooIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since object wasn't modified |
| `gooIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since object was modified | | `gooIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since object was modified |
``` haskell ``` haskell
@ -561,7 +561,7 @@ import Data.Conduit.Binary (sinkLbs)
import Prelude import Prelude
-- | The following example uses MinIO play server at -- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo
@ -592,11 +592,11 @@ __Parameters__
In the expression `fPutObject bucketName objectName inputFile` the parameters In the expression `fPutObject bucketName objectName inputFile` the parameters
are: are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:--------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `inputFile` | _FilePath_ | Path to the file to be uploaded | | `inputFile` | _FilePath_ | Path to the file to be uploaded |
__Example__ __Example__
@ -629,28 +629,28 @@ __Parameters__
In the expression `copyObject dstInfo srcInfo` the parameters In the expression `copyObject dstInfo srcInfo` the parameters
are: are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:----------|:------------------|:----------------------------------------------------------|
| `dstInfo` | _DestinationInfo_ | A value representing properties of the destination object | | `dstInfo` | _DestinationInfo_ | A value representing properties of the destination object |
| `srcInfo` | _SourceInfo_ | A value representing properties of the source object | | `srcInfo` | _SourceInfo_ | A value representing properties of the source object |
__SourceInfo record type__ __SourceInfo record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:-----------------------|:-----------------------|:----------------------------------------------------------------------------------------------------------|
| `srcBucket` | `Bucket` | Name of source bucket | | `srcBucket` | `Bucket` | Name of source bucket |
| `srcObject` | `Object` | Name of source object | | `srcObject` | `Object` | Name of source object |
| `srcRange` | `Maybe (Int64, Int64)` | (Optional) Represents the byte range of source object. (0, 9) represents first ten bytes of source object| | `srcRange` | `Maybe (Int64, Int64)` | (Optional) Represents the byte range of source object. (0, 9) represents first ten bytes of source object |
| `srcIfMatch` | `Maybe Text` | (Optional) ETag source object should match | | `srcIfMatch` | `Maybe Text` | (Optional) ETag source object should match |
| `srcIfNoneMatch` | `Maybe Text` | (Optional) ETag source object shouldn't match | | `srcIfNoneMatch` | `Maybe Text` | (Optional) ETag source object shouldn't match |
| `srcIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since source object wasn't modified | | `srcIfUnmodifiedSince` | `Maybe UTCTime` | (Optional) Time since source object wasn't modified |
| `srcIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since source object was modified | | `srcIfModifiedSince` | `Maybe UTCTime` | (Optional) Time since source object was modified |
__Destination record type__ __Destination record type__
|Field |Type |Description | | Field | Type | Description |
|:---|:---| :---| |:------------|:---------|:-----------------------------------------------------|
| `dstBucket` | `Bucket` | Name of destination bucket in server-side copyObject | | `dstBucket` | `Bucket` | Name of destination bucket in server-side copyObject |
| `dstObject` | `Object` | Name of destination object in server-side copyObject | | `dstObject` | `Object` | Name of destination object in server-side copyObject |
@ -684,10 +684,10 @@ __Parameters__
In the expression `removeObject bucketName objectName` the parameters In the expression `removeObject bucketName objectName` the parameters
are: are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:-------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
__Example__ __Example__
@ -718,10 +718,10 @@ __Parameters__
In the expression `removeIncompleteUpload bucketName objectName` the parameters In the expression `removeIncompleteUpload bucketName objectName` the parameters
are: are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:-------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
__Example__ __Example__
@ -752,11 +752,11 @@ __Parameters__
In the expression `selectObjectContent bucketName objectName selReq` In the expression `selectObjectContent bucketName objectName selReq`
the parameters are: the parameters are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:--------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `selReq` | _SelectRequest_ | Select request parameters | | `selReq` | _SelectRequest_ | Select request parameters |
__SelectRequest record__ __SelectRequest record__
@ -804,9 +804,9 @@ __Parameters__
In the expression `bucketExists bucketName` the parameters are: In the expression `bucketExists bucketName` the parameters are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:----------------------------|:-------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
## 4. Presigned operations ## 4. Presigned operations
@ -828,22 +828,22 @@ __Parameters__
In the expression `presignedGetObjectUrl bucketName objectName expiry queryParams headers` In the expression `presignedGetObjectUrl bucketName objectName expiry queryParams headers`
the parameters are: the parameters are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:--------------|:---------------------------------------------------------------|:------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds | | `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds |
| `queryParams` | _Query_ (from package `http-types:Network.HTTP.Types`) | Query parameters to add to the URL | | `queryParams` | _Query_ (from package `http-types:Network.HTTP.Types`) | Query parameters to add to the URL |
| `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL | | `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL |
__Return Value__ __Return Value__
Returns the generated URL - it will include authentication Returns the generated URL - it will include authentication
information. information.
|Return type |Description | | Return type | Description |
|:---|:---| |:-------------|:------------------------|
| _ByteString_ | Generated presigned URL | | _ByteString_ | Generated presigned URL |
__Example__ __Example__
@ -886,21 +886,21 @@ __Parameters__
In the expression `presignedPutObjectUrl bucketName objectName expiry headers` In the expression `presignedPutObjectUrl bucketName objectName expiry headers`
the parameters are: the parameters are:
|Param |Type |Description | | Param | Type | Description |
|:---|:---| :---| |:-------------|:---------------------------------------------------------------|:------------------------------------------------|
| `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket | | `bucketName` | _Bucket_ (alias for `Text`) | Name of the bucket |
| `objectName` | _Object_ (alias for `Text`) | Name of the object | | `objectName` | _Object_ (alias for `Text`) | Name of the object |
| `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds | | `expiry` | _UrlExpiry_ (alias for `Int`) | Url expiry time in seconds |
| `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL | | `headers` | _RequestHeaders_ (from package `http-types:Network.HTTP.Types` | Request headers that would be used with the URL |
__Return Value__ __Return Value__
Returns the generated URL - it will include authentication Returns the generated URL - it will include authentication
information. information.
|Return type |Description | | Return type | Description |
|:---|:---| |:-------------|:------------------------|
| _ByteString_ | Generated presigned URL | | _ByteString_ | Generated presigned URL |
__Example__ __Example__
@ -940,10 +940,10 @@ The `PostPolicy` argument is created using the `newPostPolicy` function:
In the expression `newPostPolicy expirationTime conditions` the parameters are: In the expression `newPostPolicy expirationTime conditions` the parameters are:
|Param | Type| Description | | Param | Type | Description |
|:---|:---|:---| |:-----------------|:--------------------------------------------------|:---------------------------------------------|
| `expirationTime` | _UTCTime_ (from package `time:Data.Time.UTCTime`) | The expiration time for the policy | | `expirationTime` | _UTCTime_ (from package `time:Data.Time.UTCTime`) | The expiration time for the policy |
| `conditions` | _[PostPolicyConditions]_ | List of conditions to be added to the policy | | `conditions` | _[PostPolicyConditions]_ | List of conditions to be added to the policy |
The policy conditions are created using various helper functions - The policy conditions are created using various helper functions -
please refer to the Haddocks for details. please refer to the Haddocks for details.

2
examples/BucketExists.hs
View File

@ -24,7 +24,7 @@ import Control.Monad.IO.Class (liftIO)
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/CopyObject.hs
View File

@ -24,7 +24,7 @@ import Control.Monad.Catch (catchIf)
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/FileUploader.hs
View File

@ -31,7 +31,7 @@ import UnliftIO (throwIO, try)
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/GetObject.hs
View File

@ -26,7 +26,7 @@ import qualified Data.Conduit.Binary as CB
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/HeadObject.hs
View File

@ -24,7 +24,7 @@ import Network.Minio.S3API
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/ListBuckets.hs
View File

@ -24,7 +24,7 @@ import Control.Monad.IO.Class (liftIO)
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/ListIncompleteUploads.hs
View File

@ -24,7 +24,7 @@ import Conduit
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/ListObjects.hs
View File

@ -25,7 +25,7 @@ import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/MakeBucket.hs
View File

@ -24,7 +24,7 @@ import Network.Minio
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/PresignedGetObject.hs
View File

@ -27,7 +27,7 @@ import qualified Data.Conduit.Combinators as CC
import qualified Data.Text.Encoding as E import qualified Data.Text.Encoding as E
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/PresignedPostPolicy.hs
View File

@ -27,7 +27,7 @@ import qualified Data.Text.Encoding as Enc
import qualified Data.Time as Time import qualified Data.Time as Time
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/PresignedPutObject.hs
View File

@ -24,7 +24,7 @@ import qualified Data.ByteString.Char8 as B
import Data.CaseInsensitive (original) import Data.CaseInsensitive (original)
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/PutObject.hs
View File

@ -25,7 +25,7 @@ import qualified Data.Conduit.Combinators as CC
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/RemoveBucket.hs
View File

@ -24,7 +24,7 @@ import Network.Minio
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

2
examples/RemoveIncompleteUpload.hs
View File

@ -23,7 +23,7 @@ import Network.Minio
import Prelude import Prelude
-- | The following example uses minio's play server at -- | The following example uses minio's play server at
-- https://play.min.io:9000. The endpoint and associated -- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant, -- credentials are provided via the libary constant,
-- --
-- > minioPlayCI :: ConnectInfo -- > minioPlayCI :: ConnectInfo

6
src/Network/Minio/Data.hs
View File

@ -96,7 +96,7 @@ awsRegionMap = Map.fromList [
-- enable the @OverloadedStrings@ language extension and use the -- enable the @OverloadedStrings@ language extension and use the
-- `IsString` instance to provide a URL, for example: -- `IsString` instance to provide a URL, for example:
-- --
-- > let c :: ConnectInfo = "https://play.min.io:9000" -- > let c :: ConnectInfo = "https://play.min.io"
data ConnectInfo = data ConnectInfo =
ConnectInfo { connectHost :: Text ConnectInfo { connectHost :: Text
, connectPort :: Int , connectPort :: Int
@ -231,13 +231,13 @@ awsCI :: ConnectInfo
awsCI = "https://s3.amazonaws.com" awsCI = "https://s3.amazonaws.com"
-- | <https://play.min.io:9000 MinIO Play Server> -- | <https://play.min.io MinIO Play Server>
-- ConnectInfo. Credentials are already filled in. -- ConnectInfo. Credentials are already filled in.
minioPlayCI :: ConnectInfo minioPlayCI :: ConnectInfo
minioPlayCI = let playCreds = Credentials "Q3AM3UQ867SPQQA43P2F" "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG" minioPlayCI = let playCreds = Credentials "Q3AM3UQ867SPQQA43P2F" "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG"
in setCreds playCreds in setCreds playCreds
$ setRegion "us-east-1" $ setRegion "us-east-1"
"https://play.min.io:9000" "https://play.min.io"
-- | -- |
-- Represents a bucket in the object store -- Represents a bucket in the object store