Introduction

Enzo Server
  Installation
  Quick Start
  Core Features
    Async Calls
    ConnectionStrings
    Edge Cache
    HTTP Access
    Scheduling
    Views
  Advanced Capabilities
    Change Data Capture
  Administration
    Configuration Settings
    Logins & ACL
    Auditing
    Current Executions
    Linked Server
    SSL

  User Guides
     Sharding
     Sharding Overview

     SharePoint

   Adapters
    All Adapters
    Azure Bus
    Azure IoT Hub
    Azure Key Vault
    Azure Storage
    Couchbase
    CSV
    DB (RDBMS)
    Files
    Flight Aware
    FTP
    Geonames
    HttpEndpoint (REST)
    Insteon
    Loggly
    Messaging (SMS/SMTP)
    MongoDB
    Motus
    MSAD
    MSMQ
    Pipeline
    Pressero
    RabbitMQ
    SalesForce
    Shard
    SharePoint
    SQL Server
    Threading
    Twilio
    Twitter
    VellemanDMX
    Weather (Underground)
    Whiparound
    WMI
    Xls (Excel)
    ZIP


  SDK
    Overview
    Installation
    DevHost
    Create A Simple Adapter
    Handler Columns

    Advanced SDK Concepts
      Handler Decorators
      Dynamic Columns
      Table & Table Enumerators
      Virtual Tables

/adapters/couchbase




Couchbase


This adapter allows you to access a Couchbase database.


Configuration Settings



Name Description Default
Boolean _isDefault Make this the default configuration. Defaults to true if configName is already the default.
String userName Bucket user name
String password Bucket password
String nodes Comma separated list of node IPs

Handlers



Buckets
Buckets
Returns a list of buckets available in the current cluster details 

Arguments


SQL Call

SELECT * FROM Couchbase.Buckets


Http Call

/bsc/couchbase/buckets

Output Columns

String name
String type
Int32 nodes
Int64 itemcount
Double opspersec
Double diskfetchespersec
BulkUpsert
BulkUpsert
Upserts an array of JSON documents in Couchbase using a database callback mechanism. details 

Arguments

Name Description Default
loopback R The name of the loopback connection used to get data (SQL Server, Enzo)
bucket R The name of the bucket to bulk upset the records into
sql The SQL statement used to fetch the records to be sent to Couchbase

SQL Call

EXEC Couchbase.BulkUpsert 'default'
EXEC Couchbase.BulkUpsert 'default', 'where effDate > GetDate()'


Http Call

/bsc/couchbase/bulkupsert

Output Columns

String id
String outcome
String message
ClearLoopBack
Loopback
Removes a loopback connection string from this adapter. details 

Arguments

Name Description Default
name R The name of the loopback

SQL Call

EXEC Couchbase.DeleteLoopBack 'localenzo'


Http Call

/bsc/couchbase/clearloopback

Output Columns

This call does not return data.

CreateView
CreateView
Creates a virtual table that points to a Couchbase view details 

Arguments

Name Description Default
name R The name of the view to define
bucket R The name of the bucket
design R The name of the design document
view R The name of the view in Couchbase

SQL Call

exec Couchbase.CreateView 'myview', 'bucket', 'design', 'view'


Http Call

/bsc/couchbase/createview

Output Columns

This call does not return data.

CreateVirtualTable
CreateVirtualTable
Creates a virtual table that is used to access bucket data directly details 

Arguments

Name Description Default
name R Name of the virtual table to create
bucket R The name of the Bucket to access
columns R List of properties for this virtual table

SQL Call

exec Couchbase.CreateVirtualTable 'beers', 'default', 'int id,string name'


Http Call

/bsc/couchbase/createvirtualtable

Output Columns

This call does not return data.

DeleteView
DeleteView
Deletes a virtual table that points to a Couchbase view details 

Arguments

Name Description Default
name R The name of the view to delete

SQL Call

exec Couchbase.DeleteView 'myview'


Http Call

/bsc/couchbase/deleteview

Output Columns

This call does not return data.

DeleteVirtualTable
DeleteVirtualTable
Deletes a virtual table that is used to access bucket data directly details 

Arguments

Name Description Default
name R Class name

SQL Call

exec Couchbase.DeleteVirtualTable 'beers'


Http Call

/bsc/couchbase/deletevirtualtable

Output Columns

This call does not return data.

ListView
ListView
Returns the list of views details 

Arguments


SQL Call

exec Couchbase.ListView


Http Call

/bsc/couchbase/listview

Output Columns

String nameThe name of the view
String commentA description for this view
String bucketThe name of the bucket
String designThe name of the design document
String viewThe name of the view in Couchbase
ListVirtualTable
ListVirtualTable
Returns the list of views details 

Arguments


SQL Call

exec Couchbase.ListVirtualTable


Http Call

/bsc/couchbase/listvirtualtable

Output Columns

String nameName of the virtual table
String commentA description for this table
String bucketThe name of the Bucket
String columnsList of properties for this virtual table
SetLoopBack
Loopback
Sets a connection string pointing to this Enzo, or another Enzo, or a database server. details 

Arguments

Name Description Default
name R The name of the loopback definition
connection R The connection string to Enzo or a database server used for loopback calls

SQL Call

EXEC Couchbase.SetLoopBack 'localenzo', 'server=localhost,9550;uid=sa;pwd=password;initial catalog=bsc'


Http Call

/bsc/couchbase/setloopback

Output Columns

This call does not return data.

UpdateView
UpdateView
Updates a virtual table that points to a Couchbase view details 

Arguments

Name Description Default
name R The name of the view to update
bucket R The name of the bucket
design R The name of the design document
view R The name of the view in Couchbase

SQL Call

exec Couchbase.UpdateView 'myview', 'bucket', 'design', 'view'


Http Call

/bsc/couchbase/updateview

Output Columns

This call does not return data.

UpdateVirtualTable
UpdateVirtualTable
Updates a virtual table that is used to access bucket data directly details 

Arguments

Name Description Default
name R Class name
bucket R The name of the Bucket
columns R List of properties for this class

SQL Call

exec Couchbase.UpdateVirtualTable 'beers', 'default', 'int id,string name'


Http Call

/bsc/couchbase/updatevirtualtable

Output Columns

This call does not return data.