The official Couchbase Node.js Columnar Client Library.
npm install couchbase-columnarInstall the SDK via npm:
``console`
npm install couchbase-columnar
If a compatible prebuild is not available, the SDK's binary will need to be built from source:
1. Follow the steps on the BUILDING page
2. After the build succeeds, the SDK can be used by running Node scripts from within the cloned repository or the SDK can be installed via pip: npm install
Some more examples are provided in the examples directory.
javascript
const columnar = require('couchbase-columnar')async function main() {
// Update this to your cluster
const clusterConnStr = 'couchbases://--your-instance--'
const username = 'username'
const password = 'password'
// User Input ends here.
const credential = new columnar.Credential(username, password)
const cluster = columnar.createInstance(clusterConnStr, credential)
// Execute a streaming query with positional arguments.
let qs = 'SELECT * FROM
travel-sample.inventory.airline LIMIT 10;'
let res = await cluster.executeQuery(qs)
for await (let row of res.rows()) {
console.log('Found row: ', row)
}
console.log('Metadata: ', res.metadata()) // Execute a streaming query with positional arguments.
qs =
'SELECT * FROM
travel-sample.inventory.airline WHERE country=$1 LIMIT $2;'
res = await cluster.executeQuery(qs, { parameters: ['United States', 10] })
for await (let row of res.rows()) {
console.log('Found row: ', row)
}
console.log('Metadata: ', res.metadata()) // Execute a streaming query with named parameters.
qs =
'SELECT * FROM
travel-sample.inventory.airline WHERE country=$country LIMIT $limit;'
res = await cluster.executeQuery(qs, {
namedParameters: { country: 'United States', limit: 10 },
})
for await (let row of res.rows()) {
console.log('Found row: ', row)
}
console.log('Metadata: ', res.metadata())
}main()
.then(() => {
console.log('Finished. Exiting app...')
})
.catch((err) => {
console.log('ERR: ', err)
console.log('Exiting app...')
process.exit(1)
})
`ES Modules
Connecting and executing a query
`javascript
import { Certificates, Credential, createInstance } from "couchbase-columnar"async function main() {
// Update this to your cluster
const clusterConnStr = 'couchbases://--your-instance--'
const username = 'username'
const password = 'password'
// User Input ends here.
const credential = new Credential(username, password)
const cluster = createInstance(clusterConnStr, credential)
// Execute a streaming query with positional arguments.
let qs = "SELECT * FROM
travel-sample.inventory.airline LIMIT 10;"
let res = await cluster.executeQuery(qs)
for await (let row of res.rows()) {
console.log("Found row: ", row)
}
console.log("Metadata: ", res.metadata()) // Execute a streaming query with positional arguments.
qs =
"SELECT * FROM
travel-sample.inventory.airline WHERE country=$1 LIMIT $2;"
res = await cluster.executeQuery(qs, { parameters: ["United States", 10] })
for await (let row of res.rows()) {
console.log("Found row: ", row)
}
console.log("Metadata: ", res.metadata()) // Execute a streaming query with named parameters.
qs =
"SELECT * FROM
travel-sample.inventory.airline WHERE country=$country LIMIT $limit;"
res = await cluster.executeQuery(qs, {
namedParameters: { country: "United States", limit: 10 },
})
for await (let row of res.rows()) {
console.log("Found row: ", row)
}
console.log("Metadata: ", res.metadata())
}main()
.then(() => {
console.log("Finished. Exiting app...")
})
.catch((err) => {
console.log("ERR: ", err)
console.log("Exiting app...")
process.exit(1)
})
``