euyuil-ots

OTS SDK

Aliyun OTS(Open Table Service) SDK for Node.js.

Using protobuf protocol API on ots@0.4.0+.

WANNING If you are still using XML protocol API, please use ots<=0.3.0.

Support API

• TableGroup
  • CreateTableGroup
  • DeleteTableGroup
  • ListTableGroup
• Table
  • CreateTable
  • DeleteTable
  • GetTableMeta
  • ListTable
• Transaction
  • StartTransaction
  • CommitTransaction
  • AbortTransaction
• DataRow
  • PutRow
  • MultiPutRow (Max 100 rows)
  • DeleteRow
  • MultiDeleteRow (Max 100 rows)
  • BatchModifyRow (working)
  • GetRow
  • MultiGetRow (Max 10 rows)
  • GetRowsByRange
  • GetRowsByOffset (removed)

Install

$ npm install ots
 
# If you are still using XML protocol API, please use this: 
$ npm install ots@0.3.0

Usage

var ots = require('ots');
var client = ots.createClient({
  accessID: 'your accessID',
  accessKey: 'your accessKey'
});
 
// create a table
client.createTable({
  TableName: 'testdemo',
  PrimaryKey: [
    {'Name': 'uid', 'Type': 'STRING'},
  ],
  PagingKeyLen: 0,
  View: [
    {
      'Name': 'view1',
      'PrimaryKey' : [
        {'Name':'uid', 'Type':'STRING'},
        {'Name':'flag', 'Type':'STRING'},
        {'Name':'docid', 'Type':'STRING'},
      ],
      'Column' : [
        {'Name':'updatetime', 'Type':'STRING'},
        {'Name':'createtime', 'Type':'STRING'},
      ],
     'PagingKeyLen': 2
    }
  ]
}, function(err, result) {
  console.log(err, result);
});
 
// insert a row
client.putRow('user',
  { Name: 'uid', Value: 'mk2' },
  [
    { Name: 'firstname', Value: 'yuan' },
    { Name: 'lastname', Value: 'feng\' aerdeng' },
    { Name: 'nickname', Value: '苏千' },
    { Name: 'age', Value: 28 },
    { Name: 'price', Value: 110.5 },
    { Name: 'enable', Value: true },
    { Name: 'man', Value: true },
    { Name: 'female', Value: false },
    { Name: 'createtime', Value: new Date().toJSON() },
  ], function(err, result) {
  console.log(err, result);
});
 
// get a row
client.getRow('user', { Name: 'uid', Value: 'mk2' }, function (err, row) {
  console.log(err, row);
});

More examples, please see test/client.test.js.

Links

• OTS RESTful API Documents
• OTS Data Model
• OTS Dashboard
• Python SDK
• .Net SDK
• Java SDK
• OTS Developer Guide

Authors

$ git summary
 
 project  : ots
 repo age : 1 year, 7 months
 active   : 22 days
 commits  : 63
 files    : 23
 authors  :
    58  fengmk2                 92.1%
     3  tangyao                 4.8%
     2  coolme200               3.2%

License

(The MIT License)

Copyright (c) 2012 - 2013 fengmk2 <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.