node-red-contrib-minio-all 0.0.6

A collection of Node-RED nodes for MinIO.

npm install node-red-contrib-minio-all

node-red-contrib-minio-all

NodeRed Node for common MinIO operations, by Colin Payne.

This node utilises the MinIO JavaScript API (please see https://docs.min.io/docs/javascript-client-api-reference.html).

Please Note: This set of nodes (and associated support information) is a work in progress.

The Bucket Notification Operation setBucketNotification is being worked on, and is not currently functioning correctly.

2021/01/29 - Version: 0.0.6 • getObject now working; edits by @macanfa - thank you!

2020/05/06 - Version: 0.0.5 • getPartialObject now working as expected, and README updated accordingly.

2020/04/29 - Version: 0.0.4 • listenBucketNotification now extended to include defined Supported Event Types.

MinIO Operations

Bucket Operations File Object Operations Object Operations
makeBucket fGetObject getObject
listBuckets fPutObject getPartialObject
bucketExists putObject
removeBucket copyObject
listObjects statObject
listObjectsV2 removeObject
listObjectsV2WithMetadata removeObjects
listIncompleteUploads removeIncompleteUpload
Presigned Operations Bucket Notification Operations Bucket Policy Operations
presignedUrl getBucketNotification getBucketPolicy
presignedGetObject setBucketNotification setBucketPolicy
presignedPutObject removeAllBucketNotification
presignedPostPolicy listenBucketNotification

Passing in parameters

For each operation, parameters can either be set in the Edit Node dialogue, or passed in to the node via the node input. Parameters passed in will override any parameters set in the Edit Node dialogue.

The Operation in each case can be passed in to the node by setting the appropriate incoming value of msg.operation

Bucket Operations

1. makeBucket

Description

Creates a new bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket to be created
regionRegion region
(msg.region)		 Region where the bucket is to be created. (optional)

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket was created, e.g. {"makeBucket":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

2. listBuckets

Description

List all buckets.

Parameters

No parameters required.

Node Outputs

Name Description
Output The node will output a JS object in the form {"listBuckets":[...]} containing an array of objects in the form {"name":"bucketname","creationDate": "yyyy-mm-ddThh:mm:ss.sssZ"} for each bucket.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

3. bucketExists

Description

Checks if a bucket exists.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket to be checked.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket exists, e.g. {"bucketExists":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

4. removeBucket

Description

Removes a bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket to be removed.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket has been removed, e.g. {"removeBucket":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

5. listObjects

Description

Lists all objects in a bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket for which the objects listing is required.
prefixPrefix prefix
(msg.prefix)		 The prefix of the objects that should be listed. (optional).
recursiveRecursive recursive
(msg.recursive)		 true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).

Node Outputs

Name Description
Output The node will output a JS object in the form {"listObjects":[...]} containing an array of JS objects in the form {"name":"objectname", "lastModified": "yyyy-mm-ddThh:mm:ss.sssZ", "etag":"etagstring", "size":1234} for each object returned.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

6. listObjectsV2

Description

Lists all objects in a bucket using S3 listing objects V2 API.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket for which the objects listing is required.
prefixPrefix prefix
(msg.prefix)		 The prefix of the objects that should be listed. (optional).
recursiveRecursive recursive
(msg.recursive)		 true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).
startAfterStart After startAfter
(msg.startAfter)		 Specifies the object name to start after, when listing objects in a bucket. (optional).

Node Outputs

Name Description
Output The node will output a JS object in the form {"listObjectsV2":[...]} containing an array of JS objects in the form {"name":"objectname", "lastModified": "yyyy-mm-ddThh:mm:ss.sssZ", "etag":"etagstring", "size":1234} for each object returned.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

7. listObjectsV2WithMetadata

Description

Lists all objects and their metadata in a bucket using S3 listing objects V2 API.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket for which the objects listing is required.
prefixPrefix prefix
(msg.prefix)		 The prefix of the objects that should be listed. (optional).
recursiveRecursive recursive
(msg.recursive)		 true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).
startAfterStart After startAfter
(msg.startAfter)		 Specifies the object name to start after, when listing objects in a bucket. (optional).

Node Outputs

Name Description
Output The node will output a JS object in the form {"listObjectsV2WithMetadata":[...]} containing an array of JS objects in the form {"name":"objectname", "lastModified": "yyyy-mm-ddThh:mm:ss.sssZ", "etag":"etagstring", "size":1234, "metadata":{...} } for each object returned.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

8. listIncompleteUploads

Description

Lists partially uploaded objects in a bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
prefixPrefix prefix
(msg.prefix)		 Prefix of the object names that are partially uploaded. (optional).
recursiveRecursive recursive
(msg.recursive)		 true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).

Node Outputs

Name Description
Output The node will output a JS object in the form {"listIncompleteUploads":[...]} containing an array of JS objects in the form {"key":"objectname", "uploadId": "uploadidstring", "size":1234} for each object returned.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

File Object Operations

1. fGetObject

Description

Downloads and saves the object as a file in the local filesystem.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
filefile objectName
(msg.objectName)		 Name of the object.
pathPath filePath
(msg.filePath)		 Path on the local filesystem to which the object data will be written.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the object could be downloaded as a file, e.g. {"fGetObject":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

2. fPutObject

Description

Uploads contents from a file to objectName.

The maximum size of a single object is limited to 5TB. fPutObject transparently uploads objects larger than 64MiB in multiple parts. Uploaded data is carefully verified using MD5SUM signatures.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
filefile objectName
(msg.objectName)		 Name of the object.
pathPath filePath
(msg.filePath)		 Path of the file to be uploaded.
metaDataMetaData metaData
(msg.metaData)		 Metadata of the object (optional).

Node Outputs

Name Description
Output The node will output a JS object, containing confirmation as to whether or not the file object was successfully uploaded, and, if successful, an etag value for the uploaded file object, e.g. {"fPutObject":true,"etag":"etagvaluestring"}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

Object Operations

1. getObject

Description

Downloads an object as a stream.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
fileObject objectName
(msg.objectName)		 Name of the object.

Node Outputs

Name Description
Output The node will output a JS object. {"getObject":true,"objectData":[Buffer],"opjectSize":size-in-bytes}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

2. getPartialObject

Description

Downloads the specified range bytes of an object as a stream.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
fileObject objectName
(msg.objectName)		 Name of the object.
offsetOffset offset
(msg.offset)		 Offset of the object from where the stream will start.
lengthLength length
(msg.length)		 Length of the object that will be read in the stream (optional, if not specified we read the rest of the file from the offset).

Node Outputs

Name Description
Output The node will output a JS object, containing confirmation as to whether or not thepartial object (chunk) was successfully downloaded, and, if successful, a buffer array for the downloaded partial object stream, e.g. { "getPartialObject": true, "chunk": [...] }
Error Any errors received in response to the request will be passed to the node's 'Error' output.

3.putObject

Description

Uploads an object from a stream/Buffer.

The maximum size of a single object is limited to 5TB. putObject transparently uploads objects larger than 64MiB in multiple parts. Uploaded data is carefully verified using MD5SUM signatures.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
fileObject objectName
(msg.objectName)		 Name of the object.
streamStream stream
(msg.stream)		 Readable stream.
sizeSize size
(msg.size)		 Size of the object (optional).
metaDataMeta Data metaData
(msg.metaData)		 Meta data of the object (optional).

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the object PUT operation was successful, including (if appropriate) the etag reference of the object, , e.g. {"bucketExists":true, "etag":etagstring}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

4. copyObject

Description

Copy a source object into a new object in the specified bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
fileObject objectName
(msg.objectName)		 Name of the object.
sourceObjectSource sourceObject
(msg.sourceObject)		 Path of the file to be copied, in the format bucketname/objectname
sizeSize size
(msg.size)		 Conditions to be satisfied before allowing object copy.
tagETag setMatchEtag
(msg.setMatchEtag)		 Conditions to be satisfied before allowing object copy.
tagExcept ETag setMatchEtagExcept
(msg.setMatchEtagExcept)		 Conditions to be satisfied before allowing object copy.
calendarModified setModified
(msg.setModified)		 Conditions to be satisfied before allowing object copy.
metaDataMetaData setReplaceMetadataDirective
(msg.setReplaceMetadataDirective)		 Conditions to be satisfied before allowing object copy.
calendarUnmodified setUnmodified
(msg.setUnmodified)		 Conditions to be satisfied before allowing object copy.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the object has been copied, e.g. {"copyObject":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

5. statObject

Description

Lists all objects in a bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket for which the objects listing is required.
prefixPrefix prefix
(msg.prefix)		 The prefix of the objects that should be listed. (optional).
recursiveRecursive recursive
(msg.recursive)		 true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).

Node Outputs

Name Description
Output The node will output a JS object in the form {"listObjects":[...]} containing an array of JS objects in the form {"name":"objectname", "lastModified": "yyyy-mm-ddThh:mm:ss.sssZ", "etag":"etagstring", "size":1234} for each object returned.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

6. removeObject

Description

Lists all objects in a bucket using S3 listing objects V2 API.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket for which the objects listing is required.
prefixPrefix prefix
(msg.prefix)		 The prefix of the objects that should be listed. (optional).
recursiveRecursive recursive
(msg.recursive)		 true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).
startAfterStart After startAfter
(msg.startAfter)		 Specifies the object name to start after, when listing objects in a bucket. (optional).

Node Outputs

Name Description
Output The node will output a JS object in the form {"listObjectsV2":[...]} containing an array of JS objects in the form {"name":"objectname", "lastModified": "yyyy-mm-ddThh:mm:ss.sssZ", "etag":"etagstring", "size":1234} for each object returned.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

7. removeObjects

Description

Removes all objects in a specified bucket matching an optional prefix value, or a defined list of object names.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
listObjects List objectsList
(msg.objectsList)		 Explicit list of objects in the bucket to be removed (Optional). Should be provided as an array of object names, e.g. [ "object_01", "object_02", "object_03" ]. If left blank, then all objects in the specified bucket will be removed (subject to any value specified in the prefix field).
prefixPrefix prefix
(msg.prefix)		 The prefix of the objects that should be removed (Optional). If no prefix is provided, then all objects within the specified bucket will be removed, unless an explicit list of objects is provided in the Objects List field.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the list of objects have been removed, e.g. {"removeObjects":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

8. removeIncompleteUpload

Description

Lists partially uploaded objects in a bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
prefixPrefix prefix
(msg.prefix)		 Prefix of the object names that are partially uploaded. (optional).
recursiveRecursive recursive (msg.recursive) true indicates recursive style listing and false indicates directory style listing delimited by '/'. (optional, default false).

Node Outputs

Name Description
Output The node will output a JS object in the form {"listIncompleteUploads":[...]} containing an array of JS objects in the form {"key":"objectname", "uploadId": "uploadidstring", "size":1234} for each object returned.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

Presigned Operations

1. presignedURL

Description

Generates a presigned URL for the provided HTTP method, 'httpMethod'.

Browsers/Mobile clients may point to this URL to directly download objects even if the bucket is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
fileObject objectName
(msg.objectName)		 Name of the object.
expiryExpiry expiry
(msg.expiry)		 Expiry time in seconds. Default value is 7 days. (optional)
paramsParams reqParams
(msg.reqParams)		 Request parameters. (optional)
calendarIssue Date requestDate
(msg.requestDate)		 A date object, the url will be issued at. Default value is now. (optional)

Node Outputs

Name Description
Output If successful, the node will output a JS object, containing the generated presigned URL, e.g. { "presignedURL": presignedUrl }
Error Any errors received in response to the request will be passed to the node's 'Error' output.

2. presignedGetObject

Description

Generates a presigned URL for HTTP GET operations. Browsers/Mobile clients may point to this URL to directly download objects even if the bucket is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
fileObject objectName
(msg.objectName)		 Name of the object.
expiryExpiry expiry
(msg.expiry)		 Expiry time in seconds. Default value is 7 days. (optional)
headersHeaders respHeaders
(msg.respHeaders)		 Response headers to override (optional)
calendarIssue Date requestDate
(msg.requestDate)		 A date object, the url will be issued at. Default value is now. (optional)

Node Outputs

Name Description
Output If successful, the node will output a JS object, containing the generated presigned GET object URL, e.g. { "presignedURL": presignedUrl }
Error Any errors received in response to the request will be passed to the node's 'Error' output.

3. presignedPutObject

Description

Generates a presigned URL for HTTP PUT operations. Browsers/Mobile clients may point to this URL to upload objects directly to a bucket even if it is private. This presigned URL can have an associated expiration time in seconds after which the URL is no longer valid. The default value is 7 days.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
fileObject objectName
(msg.objectName)		 Name of the object.
expiryExpiry expiry
(msg.expiry)		 Expiry time in seconds. Default value is 7 days. (optional)

Node Outputs

Name Description
Output If successful, the node will output a JS object, containing the generated presigned PUT object URL, e.g. { "presignedURL": presignedUrl }
Error Any errors received in response to the request will be passed to the node's 'Error' output.

4. presignedPostPolicy

Description

Allows setting policy conditions to a presigned URL for POST operations. Policies such as bucket name to receive object uploads, key name prefixes, expiry policy may be set.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket policy.setBucket
(msg.policy.setBucket)		 Policy restricting bucket for upload (optional).
fileKey policy.setKey
(msg.policy.setKey)		 Policy restricting object Key for upload (optional).
Key Prefix policy.setKeyStartsWith
(msg.policy.setKeyStartsWith)		 Policy restricting object Key prefix for upload (optional).
expiryExpiry policy.setExpires
(msg.policy.setExpires)		 Expiry time of the policy, in seconds (optional).
typeType policy.setContentType
(msg.policy.setContentType)		 Policy restricting content type for upload, e.g. text/plain (optional).
sizeFromSize: From policy.setContentLengthRange
(msg.policy.setContentLengthRange.from)		 The lower end of the range of content length for the upload, in bytes, e.g. 1024 (optional).
sizeToSize: To policy.setContentLengthRange
(msg.policy.setContentLengthRange.to)		 The upper end of the range of content length for the upload, in bytes, e.g. 1024*1024 (optional).

Node Outputs

Name Description
Output If successful, the node will output a JS object, containing the details of the submitted policy, e.g. { "presignedPostPolicy": { "postURL": url, "formData": {...} } }
Error Any errors received in response to the request will be passed to the node's 'Error' output.

Bucket Notification Operations

For each operation, paramenters can either be set in the Edit Node dialogue, or passed in to the node via the node input. Parameters passed in will override any parameters set in the Edit Node dialogue.

The bucket Operation can be passed in to the node by setting the appropriate incoming value of msg.operation

1. getBucketNotification

Description

Creates a new bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket to be created.
regionRegion region
(msg.region)		 Region where the bucket is to be created. (optional)

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket was created, e.g. {"makeBucket":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

2. setBucketNotification

Description

List all buckets.

Node Outputs

Name Description
Output The node will output a JS object in the form {"listBuckets":[...]} containing an array of objects in the form {"name":"bucketname","creationDate": "yyyy-mm-ddThh:mm:ss.sssZ"} for each bucket.
Error Any errors received in response to the request will be passed to the node's 'Error' output.

3. removeAllBucketNotification

Description

Checks if a bucket exists.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket to be checked.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket exists, e.g. {"bucketExists":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

4. listenBucketNotification

Description

Removes a bucket.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket to be removed.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket has been removed, e.g. {"removeBucket":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

Bucket Policy Operations

For each operation, paramenters can either be set in the Edit Node dialogue, or passed in to the node via the node input. Parameters passed in will override any parameters set in the Edit Node dialogue.

The bucket Operation can be passed in to the node by setting the appropriate incoming value of msg.operation

1. getBucketPolicy

Description

Get the bucket policy associated with the specified bucket. If objectPrefix is not empty, the bucket policy will be filtered based on object permissions as well.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket policy exists, and if it does, the details of the policy, e.g. {"getBucketPolicy":true, "policy":{...} }
Error Any errors received in response to the request will be passed to the node's 'Error' output.

2. setBucketPolicy

Description

Set the bucket policy on the specified bucket. bucketPolicy is detailed here.

Parameters

Name Parameter
(passed in as)		 Description
bucketBucket bucketName
(msg.bucketName)		 Name of the bucket.
policyPolicy bucketPolicy
(msg.bucketPolicy)		 Bucket policy.

Node Outputs

Name Description
Output The node will output confirmation, in the form of a JS object, as to whether or not the bucket policy has been set, e.g. {"setBucketPolicy":true}
Error Any errors received in response to the request will be passed to the node's 'Error' output.

Copyright © 2020 Colin Payne

Node Info

Version: 0.0.6
Updated 4 years, 2 months ago
License: Apache-2.0
Rating: 5.0 4
View on npm
View on GitHub

Categories

Actions

Rate:

Downloads

13 in the last week

Nodes

  • minio-config
  • buckets
  • files
  • objects
  • presigned
  • notifications
  • policies

Keywords

  • node-red
  • minio
  • s3

Maintainers