Haskell 快速入门指南
适用于 Amazon S3 兼容云存储的 MinIO Haskell 客户端 SDK
MinIO Haskell 客户端 SDK 提供了简单的 API,用于访问MinIO 和任何兼容 Amazon S3 的对象存储。
本指南假设您拥有一个可正常工作的Haskell 开发环境。
安装
添加到您的项目
只需将minio-hs
添加到您项目的.cabal
依赖项部分,或者如果您使用的是 hpack,则按常规方式添加到您的package.yaml
文件中。
在REPL中试用
对于基于 cabal 的环境
下载库源代码并切换到解压缩的目录
$ cabal get minio-hs
$ cd minio-hs-1.6.0/ # directory name could be different
然后使用库加载ghci
REPL 环境,并浏览可用的 API
$ cabal repl
ghci> :browse Network.Minio
对于基于 stack 的环境
从您的主文件夹或任何非 Haskell 项目目录中,只需运行
stack install minio-hs
然后启动一个解释器会话,并使用以下命令浏览可用的 API
$ stack ghci
> :browse Network.Minio
示例
示例文件夹包含许多您可以尝试的示例,这些示例可以帮助您学习并开发自己的项目。
快速入门示例 - 文件上传器
此示例程序连接到 MinIO 对象存储服务器,在服务器上创建一个存储桶,然后将文件上传到该存储桶。
在本例中,我们将使用在 https://play.min.io 上运行的 MinIO 服务器。欢迎使用此服务进行测试和开发。访问凭据存在于库中,并对公众开放。
FileUploader.hs
#!/usr/bin/env stack
-- stack --resolver lts-14.11 runghc --package minio-hs --package optparse-applicative --package filepath
--
-- MinIO Haskell SDK, (C) 2017-2019 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
-- You may obtain a copy of the License at
--
-- http://www.apache.org/licenses/LICENSE-2.0
--
-- Unless required by applicable law or agreed to in writing, software
-- distributed under the License is distributed on an "AS IS" BASIS,
-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-- See the License for the specific language governing permissions and
-- limitations under the License.
--
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE ScopedTypeVariables #-}
import Network.Minio
import Data.Monoid ((<>))
import Data.Text (pack)
import Options.Applicative
import System.FilePath.Posix
import UnliftIO (throwIO, try)
import Prelude
-- | The following example uses minio's play server at
-- https://play.min.io. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
--
-- optparse-applicative package based command-line parsing.
fileNameArgs :: Parser FilePath
fileNameArgs = strArgument
(metavar "FILENAME"
<> help "Name of file to upload to AWS S3 or a MinIO server")
cmdParser = info
(helper <*> fileNameArgs)
(fullDesc
<> progDesc "FileUploader"
<> header
"FileUploader - a simple file-uploader program using minio-hs")
main :: IO ()
main = do
let bucket = "my-bucket"
-- Parse command line argument
filepath <- execParser cmdParser
let object = pack $ takeBaseName filepath
res <- runMinio minioPlayCI $ do
-- Make a bucket; catch bucket already exists exception if thrown.
bErr <- try $ makeBucket bucket Nothing
-- If the bucket already exists, we would get a specific
-- `ServiceErr` exception thrown.
case bErr of
Left BucketAlreadyOwnedByYou -> return ()
Left e -> throwIO e
Right _ -> return ()
-- Upload filepath to bucket; object name is derived from filepath.
fPutObject bucket object filepath defaultPutObjectOptions
case res of
Left e -> putStrLn $ "file upload failed due to " ++ show e
Right () -> putStrLn "file upload succeeded."
运行 FileUploader
./FileUploader.hs "path/to/my/file"
贡献
开发
下载源代码
$ git clone https://github.com/minio/minio-hs.git
$ cd minio-hs/
构建包:
使用 cabal
$ # Configure cabal for development enabling all optional flags defined by the package.
$ cabal configure --enable-tests --test-show-details=direct -fexamples -fdev -flive-test
$ cabal build
使用 stack
$ stack build --test --no-run-tests --flag minio-hs:live-test --flag minio-hs:dev --flag minio-hs:examples
运行测试:
一部分测试默认使用位于 https://play.min.io
的远程 MinIO Play 服务器。对于库开发,使用此远程服务器可能会很慢。要针对在 http://127.0.0.1:9000
处本地运行的 MinIO 实时服务器运行测试,并使用凭据 access_key=minio
和 secret_key=minio123
,只需将环境变量 MINIO_LOCAL
设置为任何值(并取消设置以切换回 Play)。
使用 cabal
$ export MINIO_LOCAL=1 # to run live tests against local MinIO server
$ cabal test
使用 stack
$ export MINIO_LOCAL=1 # to run live tests against local MinIO server
stack test --flag minio-hs:live-test --flag minio-hs:dev
这将运行所有测试套件。
构建文档:
$ cabal haddock
$ # OR
$ stack haddock