PouchDB Add Attachment

The putAttachment() method is used to add a binary object to a document in PouchDB. To use this method, you have to pass the document id, attachment id, MIME type along with the attachment. This method also accepts an optional callback function.

Syntax:

Blob or buffer object is used to prepare attachment with documents. Blob is used while working with browser and buffer is used while working with Node.js.

Here we are using Node.js console so we will use buffer object.

Add Attachment Example

Let’s take an example to create a document with an attachent in a newly created database “New_Database”.

  //Requiring the package   var PouchDB = require(‘PouchDB’);  //Creating the database object   var db = new PouchDB(‘New_Database’);  //Preparing the attachment   var my_attachment = new Buffer([‘Hello tutoraspire……’], {type:’text/plain’});  //Adding attachment to a document   db.putAttachment(‘001’, ‘attachment1.txt’, my_attachment, ‘text/plain’, function(err, res) {      if (err) {         return console.log(err);      } else {         console.log(res+”Attachment added successfully”)      }   });  

Save the above code in a file named “Add_Attachment.js” within a folder name “PouchDB_Examples”. Open the command prompt and execute the JavaScript file using node:

Output:

PouchDB Add attachent 1

The above example will create an empty document adding an attachment to the database named “New_Database” which is stored in PouchDB.

Verification

Use the following code to verify if the attachment is added.

  //Requiring the package   var PouchDB = require(‘PouchDB’);  //Creating the database object   var db = new PouchDB(‘New_Database’);  //Reading the Document   db.get(‘001’,{attachments: true}, function(err, doc) {      if (err) {         return console.log(err);      } else {         console.log(doc);      }   });  

Save the above code in a file named “Read_Doc.js” within a folder name “PouchDB_Examples”. Open the command prompt and execute the JavaScript file using node:

Output:

PouchDB Add attachent 2

Add attachment to an existing document

We have a document in database named “Last_Database” with id “002”. You can see the value of the document:

  { name: ‘Aryan’,    age: 21,    designation: ‘Teacher’,    _id: ‘002’,    _rev: ‘1-06272bacc14146d68d8ee0c36dfa0cb9’   }  

PouchDB Add attachent 3

Now add an attachment to this document using its _rev value.

Example:

  //Requiring the package   var PouchDB = require(‘PouchDB’);  //Creating the database object   var db = new PouchDB(‘Last_Database’);  //Adding attachment to existing document   var my_attachment = new Buffer ([‘Hello tutoraspire….’], {type: ‘text/plain’});    rev = ‘1-06272bacc14146d68d8ee0c36dfa0cb9’;   db.putAttachment(‘002’, ‘attachment1.txt’, rev, my_attachment, ‘text/plain’, function(err, res) {      if (err) {         return console.log(err);      } else {         console.log (res + “Attachment added successfully”)      }   });  

Save the above code in a file named “Add_Attachment2.js” within a folder name “PouchDB_Examples”. Open the command prompt and execute the JavaScript file using node:

Output:

PouchDB Add attachent 4

Verification

You can verify the added attachment by using the read command:

PouchDB Add attachent 5

  { name: ‘Aryan’,    age: 21,    designation: ‘Teacher’,    _attachments:     { ‘attachment1.txt’:        { content_type: ‘text/plain’,          revpos: 2,          digest: ‘md5-k7iFrf4NoInN9jSQT9WfcQ==’,          data: ‘AA==’ } },    _id: ‘002’,    _rev: ‘2-388510d44393457cb06764dd89542ef3’ }  

Add Attachment to a Remote Database

You can also add an attachment to a remotely stored server (CouchDB). You just have to pass the path to the database in CouchDB, which contains the document where you want to add your attachment.

Example

We have a database name “employees” stored on the CouchDB server.

PouchDB Add attachent 6

There is one document in the database, having id 001.

PouchDB Add attachent 7

Add an attachment to the document 001 stored in a database named “employees” which is stored in the CouchDB server.

  //Requiring the package  var PouchDB = require(‘PouchDB’);    //Creating the database object  var db = new PouchDB(‘http://localhost:5984/employees’);    //Adding attachment to existing document  var my_attachment = new Buffer ([‘Hello tutoraspire…’], {type: ‘text/plain’});    rev = ‘9-92dc28669aea902edc4cf0d69c0eaebb’;  db.putAttachment(‘001’, ‘att_1.txt’,rev, my_attachment, ‘text/plain’, function(err, res) {     if (err) {        return console.log(err);     } else {        console.log (res+ “Attachment added successfully”)     }  });  

Save the above code in a file named “Add_Remote_Attachment.js” within a folder name “PouchDB_Examples”. Open the command prompt and execute the JavaScript file using node:

Output:

PouchDB Add attachent 8

Verification

Go to CouchDB server and you can see that attachment is added with the document.

PouchDB Add attachent 9

Next TopicPouchDB Retrieve Attachment

Pouchdb Add Attachment

PouchDB Add Attachment

Add Attachment Example

Verification

Add attachment to an existing document

Verification

Add Attachment to a Remote Database

Example

Verification

PostgreSQL View

Features of PowerShell

You may also like