217 lines
5.9 KiB
JavaScript
Executable File
217 lines
5.9 KiB
JavaScript
Executable File
#!/usr/bin/env node
|
|
|
|
// Command line tool for CartoDB SQL API
|
|
//
|
|
// https://github.com/Vizzuality/CartoDB-SQL-API
|
|
//
|
|
|
|
var http = require('http');
|
|
|
|
var nodevers = process.versions.node.split('.');
|
|
|
|
// NOTE: readline is also available in 0.4 but doesn't work
|
|
var hasReadline = parseInt(nodevers[0]) > 0 || parseInt(nodevers[1]) >= 8;
|
|
//console.log('Node version ' + nodevers.join(',') + ( hasReadline ? ' has' : ' does not have' ) + ' readline support');
|
|
|
|
var readline = hasReadline ? require('readline') : null;
|
|
var tty = require('tty');
|
|
|
|
var me = process.argv[1];
|
|
|
|
process.argv.shift(); // this will be "node" (argv[0])
|
|
process.argv.shift(); // this will be "benchmark.js" (argv[1])
|
|
|
|
var batch_mode = false;
|
|
var format = 'json';
|
|
var username = 'dev';
|
|
var domain = 'localhost';
|
|
var port = 8080;
|
|
var api_version = 2;
|
|
var api_key = process.env['CDBSQL_APIKEY'];
|
|
var sql;
|
|
var decimal_places;
|
|
var echo_queries = false;
|
|
var skipfields;
|
|
var verbose = 0;
|
|
|
|
function usage(exit_code) {
|
|
console.log("Usage: " + me + " [OPTIONS] <query>");
|
|
if ( hasReadline ) {
|
|
console.log(" " + me + " [OPTIONS]");
|
|
}
|
|
console.log("Options:");
|
|
console.log(" -v verbose operations (off)");
|
|
console.log(" --help print this help");
|
|
console.log(" --user <string> cartodb username (" + username + ")");
|
|
console.log(" --domain <string> service domain (" + domain + ")");
|
|
console.log(" --port <num> service tcp port number (" + port + ")");
|
|
console.log(" --api-version <num> API version (" + api_version +")");
|
|
console.log(" --key <string> API authentication key (CDBSQL_APIKEY)");
|
|
console.log(" --format <string> Response format (json)");
|
|
console.log(" --dp <num> Decimal places in geojson format (unspecified)");
|
|
console.log(" --skipfields <string> Comma-separated list of fields to skip (none)");
|
|
console.log(" --echo-queries echo commands sent to server");
|
|
if ( hasReadline ) {
|
|
console.log(" --batch Send all read queries at once (off)");
|
|
}
|
|
process.exit(exit_code);
|
|
}
|
|
|
|
var arg;
|
|
while ( arg = process.argv.shift() ) {
|
|
if ( arg == '-v' ) {
|
|
++verbose;
|
|
}
|
|
else if ( arg == '--help' ) {
|
|
usage(0);
|
|
}
|
|
else if ( arg == '--key' ) {
|
|
api_key = process.argv.shift();
|
|
}
|
|
else if ( arg == '--domain' ) {
|
|
domain = process.argv.shift();
|
|
}
|
|
else if ( arg == '--user' ) {
|
|
username = process.argv.shift();
|
|
}
|
|
else if ( arg == '--port' ) {
|
|
port = process.argv.shift();
|
|
}
|
|
else if ( arg == '--api-version' ) {
|
|
api_version = process.argv.shift();
|
|
}
|
|
else if ( arg == '--format' ) {
|
|
format = process.argv.shift();
|
|
}
|
|
else if ( arg == '--dp' ) {
|
|
decimal_places = process.argv.shift();
|
|
}
|
|
else if ( arg == '--batch' ) {
|
|
batch_mode = true;
|
|
}
|
|
else if ( arg == '--skipfields' ) {
|
|
skipfields = process.argv.shift();
|
|
}
|
|
else if ( arg == '--echo-queries' ) {
|
|
echo_queries = true;
|
|
}
|
|
else if ( ! sql ) {
|
|
sql = arg;
|
|
}
|
|
else {
|
|
usage(1);
|
|
}
|
|
}
|
|
|
|
var hostname = username + '.' + domain;
|
|
|
|
if ( ! tty.isatty(process.stdin) || ! tty.isatty(process.stdout) ) {
|
|
batch_mode = true;
|
|
}
|
|
|
|
if ( ! sql ) {
|
|
|
|
if ( ! batch_mode ) {
|
|
|
|
if ( readline ) {
|
|
|
|
var rl = readline.createInterface({
|
|
input: process.stdin,
|
|
output: process.stdout,
|
|
});
|
|
|
|
rl.setPrompt(hostname + '> ');
|
|
rl.prompt();
|
|
|
|
sql = '';
|
|
rl.on('line', function(line) {
|
|
sql += line;
|
|
// TODO: some sanity checking, like trim the line or check if it ends with semicolon
|
|
if ( sql.length ) {
|
|
processQuery(sql, function() {
|
|
sql = '';
|
|
rl.prompt();
|
|
});
|
|
} else rl.prompt();
|
|
}).on('close', function() {
|
|
if ( sql.length ) {
|
|
console.warn("Unprocessed sql left: [" + sql + "]");
|
|
}
|
|
console.log("Good bye");
|
|
}).on('SIGCONT', function() {
|
|
// this is needed so not to exit on stop/resume
|
|
rl.prompt();
|
|
});
|
|
} else {
|
|
usage(1);
|
|
}
|
|
} else { // batch mode
|
|
process.stdin.resume();
|
|
process.stdin.setEncoding('utf8');
|
|
sql = '';
|
|
process.stdin.on('data', function(chunk) {
|
|
// TODO: some sanity checking, like trim the line or check if it ends with semicolon
|
|
processQuery(chunk);
|
|
});
|
|
}
|
|
} else {
|
|
processQuery(sql);
|
|
}
|
|
|
|
// -- Perform the request
|
|
|
|
function processQuery(sql, callback)
|
|
{
|
|
|
|
var post_data = 'q=' + encodeURIComponent(sql);
|
|
|
|
var opt = {
|
|
host: hostname,
|
|
port: port,
|
|
path: '/api/v' + api_version + '/sql?format=' + encodeURIComponent(format),
|
|
method: 'POST',
|
|
headers: {
|
|
'Content-Type': 'application/x-www-form-urlencoded',
|
|
'Content-Length': post_data.length
|
|
}
|
|
};
|
|
|
|
if ( api_key ) opt.path += '&api_key=' + api_key;
|
|
if ( typeof(decimal_places) != 'undefined' ) opt.path += '&dp=' + decimal_places;
|
|
if ( typeof(skipfields) != 'undefined' ) opt.path += '&skipfields=' + encodeURIComponent(skipfields);
|
|
|
|
var body = '';
|
|
var request = 'http://' + opt.host + ':' + opt.port + opt.path;
|
|
if ( verbose ) {
|
|
console.log("Posting " + post_data + " to ", request);
|
|
}
|
|
|
|
var req = http.request(opt, function(res) {
|
|
//console.log("Response status: " + res.statusCode);
|
|
res.on('data', function(chunk) {
|
|
body += chunk;
|
|
//console.log("data: "); console.dir(json);
|
|
});
|
|
|
|
res.on('end', function() {
|
|
console.log("Request:", request);
|
|
var sqlprint = sql.length > 100 ? sql.substring(0, 100) + ' ... [truncated ' + (sql.length-100) + ' bytes]' : sql;
|
|
sqlprint = sqlprint.split('\n').join(' ');
|
|
if ( echo_queries ) console.log("Query:", sqlprint);
|
|
console.log("Response status: " + res.statusCode);
|
|
console.log('Response body:');
|
|
console.dir(body);
|
|
if ( callback ) callback();
|
|
});
|
|
|
|
}).on('error', function(e) {
|
|
console.log("Request:", request);
|
|
console.log("Error: " + e.message);
|
|
if ( callback ) callback();
|
|
});
|
|
|
|
req.write(post_data);
|
|
req.end();
|
|
|
|
}
|