<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutGridFS</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutGridFS</h1><h2>Description: </h2><p>Writes a file to a GridFS bucket.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>mongo, gridfs, put, file, store</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Client Service</strong></td><td>gridfs-client-service</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MongoDBClientService<br/><strong>Implementation: </strong><a href="../../../nifi-mongodb-services-nar/1.19.1/org.apache.nifi.mongodb.MongoDBControllerService/index.html">MongoDBControllerService</a></td><td id="description">The MongoDB client service to use for database connections.</td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td>gridfs-database-name</td><td></td><td id="allowable-values"></td><td id="description">The name of the database to use<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Bucket Name</td><td>gridfs-bucket-name</td><td></td><td id="allowable-values"></td><td id="description">The GridFS bucket where the files will be stored. If left blank, it will use the default value 'fs' that the MongoDB client driver uses.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>File Name</strong></td><td>gridfs-file-name</td><td></td><td id="allowable-values"></td><td id="description">The name of the file in the bucket that is the target of this processor. GridFS file names do not include path information because GridFS does not sort files into folders within a bucket.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">File Properties Prefix</td><td>putgridfs-properties-prefix</td><td></td><td id="allowable-values"></td><td id="description">Attributes that have this prefix will be added to the file stored in GridFS as metadata.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Enforce Uniqueness</strong></td><td>putgridfs-enforce-uniqueness</td><td id="default-value">None</td><td id="allowable-values"><ul><li>None <img src="../../../../../html/images/iconInfo.png" alt="No uniqueness will be enforced." title="No uniqueness will be enforced."></img></li><li>Both <img src="../../../../../html/images/iconInfo.png" alt="Both the filename and hash must be unique." title="Both the filename and hash must be unique."></img></li><li>Name <img src="../../../../../html/images/iconInfo.png" alt="Only the filename must be unique." title="Only the filename must be unique."></img></li><li>Hash <img src="../../../../../html/images/iconInfo.png" alt="Only the file hash must be unique." title="Only the file hash must be unique."></img></li></ul></td><td id="description">When enabled, this option will ensure that uniqueness is enforced on the bucket. It will do so by creating a MongoDB index that matches your selection. It should ideally be configured once when the bucket is created for the first time because it could take a long time to build on an existing bucket wit a lot of data.</td></tr><tr><td id="name">Hash Attribute</td><td>putgridfs-hash-attribute</td><td id="default-value">hash.value</td><td id="allowable-values"></td><td id="description">If uniquness enforcement is enabled and the file hash is part of the constraint, this must be set to an attribute that exists on all incoming flowfiles.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Chunk Size</strong></td><td>putgridfs-chunk-size</td><td id="default-value">256 KB</td><td id="allowable-values"></td><td id="description">Controls the maximum size of each chunk of a file uploaded into GridFS.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>When the operation succeeds, the flowfile is sent to this relationship.</td></tr><tr><td>duplicate</td><td>Flowfiles that fail the duplicate check are sent to this relationship.</td></tr><tr><td>failure</td><td>When there is a failure processing the flowfile, it goes to this relationship.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html>