Yandex.Cloud
  • Services
  • Why Yandex.Cloud
  • Pricing
  • Documentation
  • Contact us
Get started
Yandex Database
  • Getting started
    • Overview
    • Create databases
    • Examples of YQL queries
    • Examples of operations in the YDB CLI
    • Launch a test app
    • Document API
    • Developing in NodeJS through the Document API
  • Step-by-step instructions
    • Database management
    • How to connect to a database
    • Table management
    • Reading and writing data
    • Working with secondary indexes
  • Working with the SDK
  • Concepts
    • Overview
    • Data model and schema
    • Serverless and Dedicated operation modes
    • Data types
    • Transactions
    • Secondary indexes
    • Time to Live (TTL)
    • Terms and definitions
    • Quotas and limits
  • Access management
  • Pricing policy
    • Overview
    • Serverless mode
    • Dedicated mode
  • Recommendations
    • Schema design
    • Partitioning tables
    • Secondary indexes
    • Paginated output
    • Loading large data volumes
    • Using timeouts
  • YDB API and API reference
    • Database limits
    • Handling errors in the API
  • Amazon DynamoDB-compatible HTTP API
    • API reference
      • All methods
      • Actions
        • BatchGetItem
        • BatchWriteItem
        • CreateTable
        • DeleteItem
        • DeleteTable
        • DescribeTable
        • GetItem
        • ListTables
        • PutItem
        • Query
        • Scan
        • TransactGetItems
        • TransactWriteItems
        • UpdateItem
      • Common errors
  • YQL reference guide
    • Overview
    • Data types
      • Simple
      • Optional
      • Containers
      • Special
    • Syntax
      • Unsupported statements
      • For text representation of data types
      • Expressions
      • CREATE TABLE
      • DROP TABLE
      • INSERT INTO
      • UPSERT INTO
      • REPLACE INTO
      • UPDATE
      • DELETE
      • SELECT
      • GROUP BY
      • JOIN
      • FLATTEN
      • ACTION
      • DISCARD
      • PRAGMA
      • DECLARE
      • OVER, PARTITION BY, and WINDOW
    • Built-in functions
      • Basic
      • Aggregate
      • Window
      • For lists
      • For dictionaries
      • For JSON
      • For structures
      • For types
    • Preset user-defined functions
      • HyperScan
      • Pcre
      • Pire
      • Re2
      • String
      • Unicode
      • Datetime
      • Url
      • Ip
      • Digest
      • Math
      • Histogram
    • For text representation of data types
  • YQL tutorial
    • Overview
    • Creating a table
    • Adding data to a table
    • Selecting data from all columns
    • Selecting data from specific columns
    • Sorting and filtering
    • Data aggregation
    • Additional selection criteria
    • Joining tables by JOIN
    • Data insert and update by REPLACE
    • Data insert and update by UPSERT
    • Data insert by INSERT
    • Data update by UPDATE
    • Deleting data
    • Adding and deleting columns
    • Deleting a table
  • Maintenance
    • Backups
  • Diagnostics
    • System views
  • Questions and answers
    • General questions
    • Errors
    • YQL
    • All questions on the same page
  • Public materials
  1. Getting started
  2. Developing in NodeJS through the Document API

Developing in NodeJS through the Document API

  • Before you start
  • Creating a table
  • Saving writes
  • Reading writes

Before you start

  1. Create a serverless database in Yandex.Cloud.
  2. In the properties of the created database, on the Overview tab, find and copy the Document API endpoint value.
  3. Install the developer's tools by running the command npm install yandex-cloud.

Creating a table

const { DocAPIService } = require('yandex-cloud')

// change for your Document API endpoint
const endpoint = '<your Document API endpoint here>';
const docapi = new DocAPIService(endpoint)

var params =
{
  TableName: "test/pets",
  AttributeDefinitions:
  [
    {
      AttributeName: "species",
      AttributeType: "S"
    },
    {
      AttributeName: "name",
      AttributeType: "S"
    }
  ],
  KeySchema:
  [
    {
      AttributeName: "species",
      KeyType: "HASH"
    },
    {
      AttributeName: "name",
      KeyType: "RANGE"
    }
  ]
};
docapi.createTable(params).then(res => { console.log(res); }).catch(err => { console.log(err); });

Saving writes

const { DocAPIService } = require('yandex-cloud')

// change for your Document API endpoint
const endpoint = '<your Document API endpoint here>';
const docapi = new DocAPIService(endpoint)

var params =
{
  TableName: "test/pets",
  Item:
  {
    "species": "cat",
    "name": "Tom",
    "color": "Black",
    "price": "10.5"
  }
};
docapi.putItem(params).then(res => { console.log(res); }).catch(err => { console.log(err); });

Reading writes

const { DocAPIService } = require('yandex-cloud')

// change for your Document API endpoint
const endpoint = '<your Document API endpoint here>';
const docapi = new DocAPIService(endpoint)

var params =
{
  TableName: "test/pets",
  Key:
  {
    "species": "cat",
    "name": "Tom"
  }
};
docapi.getItem(params).then(res => { console.log(res); }).catch(err => console.log(err));
In this article:
  • Before you start
  • Creating a table
  • Saving writes
  • Reading writes
Language
Careers
Privacy policy
Terms of use
© 2021 Yandex.Cloud LLC