0.6.2 • Published 6 years ago

uniconnect-client v0.6.2

Weekly downloads
1
License
UNLICENSED
Repository
bitbucket
Last release
6 years ago

Uniconnect-node-client

For queries with long process time and heavy output:

var uniconnect = require('uniconnect-client');
var client = new uniconnect.Client({user: 'username'});
 
client.execute({
	query:   'select * from mysql1.retail_db.orders limit 4',
	success : function(error, stats){
		console.log({State: stats}); 
	},
	error:   function(error){
		console.log({Error: error}); 
	},
	data:    function(error, data, columns, stats){ 
		console.log(data); 
	},
	state:   function(error, query_id, stats){ 
		console.log({message:"status changed", id:query_id, stats:stats}); 
	},
	columns: function(error, data){ 
		console.log({resultColumns: data}); 
	}
});

Installation

npm install -g uniconnect-client

Or add uniconnect-client to your own packagen.json, and do npm install.

API

new Client(opts)

Instanciate client object and set default configurations.

  • opts object
    • host string
      • UniConnect coordinator hostname or address (default: localhost)
    • ssl object
      • Setting a Hash object enables SSL and verify server certificate with options (default: null):
        • ca: An authority certificate or array of authority certificates to check the remote host against
        • cert: Public x509 certificate to use (default : null)
        • ciphers : Default cipher suite to use. (default: https://nodejs.org/api/tls.html#tls_modifying_the_default_tls_cipher_suite)
        • key: Private key to use for SSL (default: null)
        • passphrase: A string of passphrase for the private key or pfx (default: null)
        • pfx: Certificate, Private key and CA certificates to use for SSL. (default: null).
        • rejectUnauthorized: If not false the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true (default: true)
        • secureProtocol: Optional SSL method to use. The possible values are listed as SSL_METHODS, use the function names as strings. For example, "SSLv3_method" to force SSL version 3 (default: SSLv23_method)
        • servername: Server name for the SNI (Server Name Indication) TLS extension
    • port integer
      • UniConnect coordinator port (default: 8080)
    • user string
      • Username of query (default: process user name)
    • basic_auth object
      • Pass in a user and password to enable Authorization Basic headers on all requests.
      • basic_auth: {user: "user", password: "password"} (default:null)
    • catalog string
      • Default catalog name
    • schema string
      • Default schema name
    • checkInterval integer
      • Interval milliseconds of each RPC to check query status (default: 800ms)
    • enableVerboseStateCallback boolean
      • Enable more verbose callback for UniConnect query states (default: false)
      • When set to true, this flag modifies the condition of the state change callback to return data every checkInterval(default: 800ms). Modify checkInterval if you wish to change the frequency.
      • Otherwise (false), the state change callback will only be called upon a change in state.
      • The purpose of this variable is to enable verbose update capability in state callbacks. This is such that "percentage complete" and "processed rows" may be extracted despite the state still remaining in a particular state eg. "RUNNING".
    • jsonParser object
      • Custom json parser if required (default: JSON)

return value: client instance object

execute(arg, callback)

Execute query on UniConnect cluster, and fetch results.

  • arg Object or string
  • arg String: query string executed
    • catalog and schema must be specified in new Client() for this argument type
  • arg Object
  • callback function(error, data, columns)
  • called once when query finished
  • data
    • array of arrays of each field values
    • [ [ 'field1Value', 'field2Value', 3 ], [ 'field1Value', 'field2Value', 6 ], ... ]
  • columns
    • array of field names and types
    • [ { name: 'timestamp', type: 'varchar' }, { name: 'username', type: 'varchar' }, { name: 'cnt', type: 'bigint' } ]

execute(opts)

This is an API to execute queries that really read large amount of data.

Execute query on UniConnect cluster, and fetch results.

Attributes of opts object are:

Callbacks order (success query) is: columns -> data (-> data xN) -> success (or callback)

query(query_id, callback)

Get query current status. (Same with 'Raw' of UniConnect Web in browser.)

kill(query_id, callback)

Stop query immediately.

nodes(opts, callback)

Get node list of UniConnect cluster and return it.

BIGINT value handling

Javascript standard JSON module cannot handle BIGINT values correctly by precision problems.

JSON.parse('{"bigint":1139779449103133602}').bigint //=> 1139779449103133600

If your query puts numeric values in its results and precision is important for that query, you can swap JSON parser with any modules which has parse method.

var JSONbig = require('json-bigint');
JSONbig.parse('{"bigint":1139779449103133602}').bigint.toString() //=> "1139779449103133602"
// set client option
var client = new uniconnect.Client({
  // ...
  jsonParser: JSONbig,
  // ...
});
uniconnect
uniconnect-base-db-api
0.6.2

6 years ago

0.6.1

6 years ago

0.6.0

6 years ago

0.5.0

6 years ago

0.4.0

6 years ago

0.3.1

6 years ago