org.teiid.couchbase

Interface CouchbaseConnection

All Superinterfaces:

javax.resource.cci.Connection

All Known Implementing Classes:

CouchbaseConnectionImpl

public interface CouchbaseConnection
extends javax.resource.cci.Connection

The Logical Hierarchy of a Couchbase cluster looks

   Namespaces
       └── Keyspaces
              └──Documents
 

A Keyspace is a set of JSON documents that may vary in structure, use a self-describing format, flexible Data Model, dynamic schemas. A CouchbaseConnection is a connection to a specific Couchbase Namespace, build upon Couchbase N1QL, used to handle application-level operations (SELECT/UPDATE/INSERT/DELETE) against the documents under a specific Couchbase Namespace.

Author:

kylin

Method Summary

Modifier and Type	Method and Description
com.couchbase.client.java.query.N1qlQueryResult	execute(String statement) Executes the given N1QL statement, which returns a single N1qlQueryResult object.
com.couchbase.client.java.query.N1qlQueryResult	executeQuery(com.couchbase.client.java.query.N1qlQuery query) Executes the given N1qlQuery object which represents a complex N1QL statement.
com.couchbase.client.java.query.N1qlQueryResult	executeQuery(String query) Executes the given N1QL statement, which returns a single N1qlQueryResult object.
String	getNamespace() Returns the name of the Namespace

Methods inherited from interface javax.resource.cci.Connection

close, createInteraction, getLocalTransaction, getMetaData, getResultSetInfo

Method Detail

getNamespace

String getNamespace()

Returns the name of the Namespace

Returns:

executeQuery

com.couchbase.client.java.query.N1qlQueryResult executeQuery(String query)

Executes the given N1QL statement, which returns a single N1qlQueryResult object.

Parameters:

query - is a N1QL statement, analogous to a relational database SQL statement.

Returns:

returns a N1qlQueryResult object that contains the JSON objects produced by the given query.

executeQuery

com.couchbase.client.java.query.N1qlQueryResult executeQuery(com.couchbase.client.java.query.N1qlQuery query)

Executes the given N1qlQuery object which represents a complex N1QL statement. returns a single N1qlQueryResult object.

Parameters:

query - is a N1qlQuery object which represents a complex N1QL statement.

Returns:

returns a N1qlQueryResult object that contains the JSON objects produced by the given query.

execute

com.couchbase.client.java.query.N1qlQueryResult execute(String statement)

Executes the given N1QL statement, which returns a single N1qlQueryResult object.

Parameters:

statement - Any N1QL statement, like Insert, Select, Update, Delete, etc.

Returns: