0.0.2-alpha • Published 11 months ago

loopback-connector-minio v0.0.2-alpha

Weekly downloads
-
License
MIT
Repository
github
Last release
11 months ago

loopback-connector-minio

Installation

In your application root directory, enter this command to install the connector:

npm install loopback-connector-minio --save

This installs the module from npm and adds it as a dependency to the application's package.json file.

If you create a MongoDB data source using the data source generator as described below, you don't have to do this, since the generator will run npm install for you.

Creating a Minio data source

For LoopBack 4 users, use the LB4 Command-line interface to generate a DataSource with MongoDB connector to your LB4 application. Run lb4 datasource, it will prompt for configurations such as host, post, etc. that are required to connect to a other database.

After setting it up, the configuration can be found under src/datasources/<DataSourceName>.datasource.ts, which would look like this:

const config = {
  endPoint: "play.min.io",
  port: 9000,
  useSSL: true,
  accessKey: "Q3AM3UQ867SPQQA43P2F",
  secretKey: "zuf+tfteSlswRu7BJ86wekitnifILbZam1KYY3TG",
};

Connection properties

PropertyType  Description
connectorstringConnector name, either "loopback-connector-minio" or "mongodb".
endPointstringURL to object storage service.
portNumberTCP/IP port number. This input is optional. Default value set to 80 for HTTP and 443 for HTTPs.
accessKeyStringAccess key is like user ID that uniquely identifies your account
secretKeyStringSecret key is the password to your account
useSSLbooleanSet this value to ‘true’ to enable secure (HTTPS) access
sessionTokenstringSet this value to provide x-amz-security-token (AWS S3 specific). (Optional)
regionstringSet this value to override region cache. (Optional)
transportstringSet this value to pass in a custom transport. (Optional)
partSizenumberSet this value to override default part size of 64MB for multipart uploads. (Optional)
pathStylebooleanSet this value to override default access behavior (path) for non AWS endpoints. Default is true. (Optional)
transportAgentstringSet this value to provide a custom HTTP(s) agent to handle timeouts, TLS handling, and low-level socket configurations. (Optional)

Operations

BucketObjectPresignedBucket policyNotification
makeBucketgetObjectpresignedUrlgetBucketNotification
listBucketsgetPartialObjectpresignedGetObjectsetBucketNotification
bucketExistsfGetObjectpresignedPutObjectremoveAllBucketNotification
removeBucketputObjectpresignedPostPolicygetBucketPolicy
listObjectsfPutObjectsetBucketPolicy
listObjectsV2copyObjectlistenBucketNotification
listIncompleteUploadsstatObject
getBucketVersioningremoveObject
setBucketVersioningremoveObjects
getBucketTaggingremoveIncompleteUpload
setBucketTaggingputObjectRetention
removeBucketTagginggetObjectRetention
setBucketLifecyclesetObjectTagging
getBucketLifecycleremoveObjectTagging
removeBucketLifecyclegetObjectTagging
setObjectLockConfiggetObjectLegalHold
getObjectLockConfigsetObjectLegalHold
getBucketEncryptioncomposeObject
setBucketEncryptionselectObjectContent
removeBucketEncryption
setBucketReplication
getBucketReplication
removeBucketReplication

Refs