KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #typescript #codex #cli #claude-code #mcp #rust #deepseek-harness #ai-agent

ots

★ 48 Open GitHub ↗

This project no longer maintained, please use https://github.com/ali-sdk/ots2 instead.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OTS SDK [![Build Status](https://secure.travis-ci.org/fengmk2/ots.png)](http://travis-ci.org/fengmk2/ots) [![Coverage Status](https://coveralls.io/repos/fengmk2/ots/badge.png)](https://coveralls.io/r/fengmk2/ots)

This project no longer maintained, please use https://github.com/ali-sdk/ots2 instead.

[![NPM](https://nodei.co/npm/ots.png?downloads=true&stars=true)](https://nodei.co/npm/ots)

Aliyun [OTS](http://ots.aliyun.com/)(Open Table Service) SDK for [Node.js](http://nodejs.org).

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

```bash
$ npm install ots

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

## Usage

```js
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](https://github.com/fengmk2/ots/blob/master/test/client.test.js).

## Links

* [OTS RESTful API Documents](http://ots.aliyun.com/ots_sdk/OTS_RESTful_API_2012_03_22.pdf)
* [OTS Data Model](http://ots.aliyun.com/ots_sdk/OTS_Data%20Model_2012_03_22.pdf)
* [OTS Dashboard](http://ots.aliyun.com/dashboard)
* [Python SDK](http://ots.aliyun.com/ots_sdk/ots_python_sdk_2012_03_22.zip)
* [.Net SDK](http://ots.aliyun.com/ots_sdk/Aliyun_SDK_dotNET_1_0_4458.zip)
* [Java SDK](http://storage.aliyun.com/oss/aliyun_portal_storage/oss_api/OSS_OTS_Java_SDK.zip)
* [OTS Developer Guide](http://ots.aliyun.com/guide/index)

## Authors

```bash
$ 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)

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.

ots

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README