Start Using the Node.js SDK

typescript
ViewCopy
'use strict'

import {
  Bucket,
  Cluster,
  Collection,
  connect,
  ConnectOptions,
  GetResult,
  QueryResult,
} from 'couchbase'

async function main() {
  const clusterConnStr: string =
    'couchbases://cb.<your-endpoint>.cloud.couchbase.com'
  const username: string = 'username'
  const password: string = 'Password!123'
  const bucketName: string = 'travel-sample'

  const connectOptions: ConnectOptions = {
    username: username,
    password: password,
    // Sets a pre-configured profile called "wanDevelopment" to help avoid latency issues
    // when accessing Capella from a different Wide Area Network
    // or Availability Zone (e.g. your laptop).
    configProfile: 'wanDevelopment'
  }

  const cluster: Cluster = await connect(clusterConnStr, connectOptions)

  const bucket: Bucket = cluster.bucket(bucketName)

  const collection: Collection = bucket
    .scope('tenant_agent_00')
    .collection('users')

  // Get a reference to the default collection, required only for older Couchbase server versions
  const collection_default: Collection = bucket.defaultCollection()

  interface User {
    type: string
    name: string
    email: string
    interests: string[]
  }

  const user: User = {
    type: 'user',
    name: 'Michael',
    email: 'michael123@test.com',
    interests: ['Swimming', 'Rowing'],
  }

  await collection.upsert('michael123', user)

  // Load the Document and print it
  // Prints Content and Metadata of the stored document
  const getResult: GetResult = await collection.get('michael123')
  console.log('Get Result:', getResult)

  // Perform a N1QL Query
  const queryResult: QueryResult = await bucket
    .scope('inventory')
    .query('SELECT name FROM `airline` WHERE country=$1 LIMIT 10', {
      parameters: ['United States'],
    })
  console.log('Query Results:')
  queryResult.rows.forEach((row) => {
    console.log(row)
  })
}

// Run the main function
main()
  .catch((err) => {
    console.log('ERR:', err)
    process.exit(1)
  })
  .then(() => process.exit(0))

nodejs
ViewCopy
const couchbase = require('couchbase')

async function main() {
  // For a secure cluster connection, use `couchbases://<your-cluster-ip>` instead.
  const clusterConnStr = 'couchbase://localhost'
  const username = 'Administrator'
  const password = 'password'
  const bucketName = 'travel-sample'

  const cluster = await couchbase.connect(clusterConnStr, {
    username: username,
    password: password,
  })

  const bucket = cluster.bucket(bucketName)

  // Get a reference to the default collection, required only for older Couchbase server versions
  const defaultCollection = bucket.defaultCollection()

  const collection = bucket.scope('tenant_agent_00').collection('users')

  const user = {
    type: 'user',
    name: 'Michael',
    email: 'michael123@test.com',
    interests: ['Swimming', 'Rowing'],
  }

  // Create and store a document
  await collection.upsert('michael123', user)

  // Load the Document and print it
  // Prints Content and Metadata of the stored Document
  let getResult = await collection.get('michael123')
  console.log('Get Result: ', getResult)

  // Perform a N1QL Query
  const queryResult = await bucket
    .scope('inventory')
    .query('SELECT name FROM `airline` WHERE country=$1 LIMIT 10', {
      parameters: ['United States'],
    })
  console.log('Query Results:')
  queryResult.rows.forEach((row) => {
    console.log(row)
  })
}

// Run the main function
main()
  .catch((err) => {
    console.log('ERR:', err)
    process.exit(1)
  })
  .then(process.exit)

typescript
ViewCopy
import {
  Bucket,
  Cluster,
  Collection,
  connect,
  ConnectOptions,
  GetResult,
  QueryResult,
} from 'couchbase'