README-EN.md

Aliyun Tablestore SDK for Node.js

中文版 (Link to the Chinese README)

About

• This NodeJs SDK is a client library for the Alibaba Cloud Tablestore Service API.
• Alibaba Cloud Tablestore is a NoSQL database service built on Alibaba Cloud’s Apsara distributed operating system that can store and access large volumes of structured data in real time.

Version Feature Updates

• Version: 5.5.1
  • Bug fix in _parseSearchHit function.
• Version: 5.5.0
  • Search: GroupByDateHistogram
  • GroupByHistogram Support Offset Parameter
  • DescribeTable API Support IndexSyncPhase
  • DescribeSearchIndex Support IndexStatus
  • Search: GroupByGeoGrid
  • Search: Function Score
  • Search: KnnVectorQuery
  • Search: Highlight
  • Nested Query Highlight
  • Search: GroupByComposite
  • Field Sort Support Missing Field Parameter
• Version: 5.4.1
  • fix wrong time unit in default_retry_policy.js
• Version: 5.3.1
  • Modified the writing style of some js, compatible with Deno
• Version: 5.3.0
  • SQLPayloadVersion no longer supports SQL_PLAIN_BUFFER
• Version: 5.2.2
  • Search Support Collapse
• Version: 5.2.1
  • SQL use default SQLPayloadVersion SQL_FLAT_BUFFERS
• Version: 5.2.0
  • Added Support for SQL
  • Added Support for Search Agg and GroupBy
  • Added Support for Search ColumnReturnType RETURN_ALL_FROM_INDEX
  • Added Support for Search Query Weight Parameter
  • Added Support for ComputeSplits
  • Added Support for ParallelScan
  • Added Support for UpdateSearchIndex
  • UpdateSearchIndex supports the return of measurement, TTL, createTime and other information
  • CreateSearchIndex supports dynamic schema modification and TTL
  • Added Support for Table allowUpdate Parameter
  • Modified Retry Policy
  • Carry RequestId in Error
• Version: 4.3.2
  • Bug fixed: Queries are now supported using the "Long" datatype
  • Added Support for SearchIndex
  • Added Support for GlobalIndex
  • Added Support for Atomic Addition
  • Added Support for Transactions
  • Added Support for ExistsQuery

Installation

npm install tablestore

Getting Started

To get started, we recommend taking a look at the samples found in the "samples/" directory. You can configure the samples for use by setting the correct relevant parameters for your Tablestore instance by modifying the "samples/client.js" file (modify the values for 'accessKeyId', 'secretAccessKey', 'endpoint' and 'instancename' accordingly).

Contributing

• We welcome everyone to contribute code to the Tablestore NodeJs SDK and other Tablestore SDKs.

Contact US

• Alibaba Cloud Tablestore Official Product Page
• Alibaba Cloud Official Support Forum
• Alibaba Cloud Tablestore Official Documentation
• Alibaba Cloud Official Blog
• Create Alibaba Cloud Support Ticket (Must be logged in)

Join our Tablestore Chat Group(GroupNumber:23307953) on DingDing Talk