hdfs247 v1.0.0

NPM HDFS module

This is node.js interface to communicating with web HDFS interface.

How to use

Installing

Before we can use this module we need to install it first

$ npm install --save hdfs247

Using on Unsecure Cluster

var Hdfs = require('hdfs'),
  localpath = '/tmp/filetest.txt',
  remotepath = '/user/apps/filetest.txt';

var hdfs = new Hdfs({
  protocol: 'http',
  hostname: '192.168.1.225',
  port: 50070
});

hdfs.upload({
  'user.name': 'apps',
  overwrite: true,
  localpath: localpath,
  path: remotepath
}, function(error, response, body) {
  console.log(error);    // Error will be null if upload process is succeed.
  console.log(response); // Raw response from node.js request.
  console.log(body);     // Body of request result.
});

Using on Secure Cluster (Kerberized/SPNego)

var Hdfs = require('hdfs'),
  localpath = '/tmp/filetest.txt',
  remotepath = '/user/apps/filetest.txt';

var hdfs = new Hdfs({
  protocol: 'http',
  hostname: '192.168.1.225',
  port: 50070
});

hdfs.upload({
  'user.name': 'apps',
  overwrite: true,
  localpath: localpath,
  spnego_token: result.token,
  principal: spnego_principal,
  keytab: keytab,
  realm: realm,
  krb_fqdn: krb_fqdn,
  path: remotepath
}, function(error, response, body) {
  console.log(error);    // Error will be null if upload process is succeed.
  console.log(response); // Raw response from node.js request.
  console.log(body);     // Body of request result.
});

Functions

cekpath(param) ⇒ Object

Check the parameter, return path if there is path in parameter, and return / if no path in parameter.

Kind: global function
Returns: Object - Object with only path in it.

prepvar(param) ⇒ Object

Prepare parameter, separate request option and request parameter, set default option, and explicitly set path.

Kind: global function
Returns: Object - Clean ready to use request parameter.

Hdfs(data)

Hdfs class constructor

Kind: global function

• Hdfs(data)
  • .getfilestatus(param, callback)
  • .liststatus(param, callback)
  • .download(param, callback)
  • .upload(param, callback)
  • .open(param, callback)
  • .gethomedirectory(param, callback)
  • .getcontentsummary(param, callback)
  • .getfilechecksum(param, callback)
  • .concat(param, callback)
  • .append(param, callback)
  • .create(param, callback)
  • .rename(param, callback)
  • .mkdirs(param, callback)
  • .setpermission(param, callback)
  • .setowner(param, callback)
  • .setreplication(param, callback)
  • .settimes(param, callback)
  • .delete(param, callback)

hdfs.getfilestatus(param, callback)

Get file status from HDFS Possible properties of param is :

Kind: instance method of Hdfs

hdfs.liststatus(param, callback)

List status of file and directory under specified directory

Kind: instance method of Hdfs

hdfs.download(param, callback)

Download file from HDFS with without buffering.

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Open_and_Read_a_File

Param properties :

hdfs.upload(param, callback)

Upload file to HDFS without buffering.

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Create_and_Write_to_a_File

Param properties :

hdfs.open(param, callback)

Open file from HDFS, this function will buffer content file in memory

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Open_and_Read_a_File

Param properties :

hdfs.gethomedirectory(param, callback)

Get home directory of current accessing user.

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Get_Home_Directory

hdfs.getcontentsummary(param, callback)

Get summary of content

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Get_Content_Summary_of_a_Directory

hdfs.getfilechecksum(param, callback)

Get checksum of file

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Get_File_Checksum

hdfs.concat(param, callback)

Concatenating file to another one. Warning : It's still experimental. We warn you.

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Concat_Files

hdfs.append(param, callback)

Append data to another file in HDFS

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Append_to_a_File

Param properties :

hdfs.create(param, callback)

Create file in HDFS.

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Create_and_Write_to_a_File

Param properties :

hdfs.rename(param, callback)

Rename file or directory in HDFS

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Rename_a_FileDirectory

Param properties :

hdfs.mkdirs(param, callback)

Make directory in Hdfs

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Make_a_Directory

Param properties :

hdfs.setpermission(param, callback)

Set permission of file in HDFS

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Set_Permission

Param properties :

hdfs.setowner(param, callback)

Set owner of file or directory

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Set_Owner

Param properties :

hdfs.setreplication(param, callback)

Set replication factor of file.

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Set_Replication_Factor

Param properties :

hdfs.settimes(param, callback)

Set time and date of file in HDFS

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Set_Access_or_Modification_Time

Param properties :

hdfs.delete(param, callback)

Delete file or directory in HDFS

Kind: instance method of Hdfs
See: https://hadoop.apache.org/docs/r2.7.0/hadoop-project-dist/hadoop-hdfs/WebHDFS.html#Delete_a_FileDirectory

Param properties :