Externals

Classes

AnalyticsQuery
AnalyticsStringQuery
Bucket
AnalyticsQueryResponse
Meta
CbasQueryResponse
FtsQueryResponse
Meta
N1qlQueryResponse
Meta
TranscoderDoc
ViewQueryResponse
Meta
BucketManager
CertAuthenticator
ClassicAuthenticator
Cluster
ClusterManager
CouchbaseError
DocumentFragment
LookupInBuilder
MutateInBuilder
MutationState
N1qlQuery
N1qlStringQuery
PasswordAuthenticator
DateFacet
NumericFacet
TermFacet
SearchQuery
BooleanFieldQuery
BooleanQuery
ConjunctionQuery
DateRangeQuery
DisjunctionQuery
DocIdQuery
GeoBoundingBoxQuery
GeoDistanceQuery
MatchAllQuery
MatchNoneQuery
MatchPhraseQuery
MatchQuery
NumericRangeQuery
PhraseQuery
PrefixQuery
QueryStringQuery
RegexpQuery
TermQuery
TermRangeQuery
WildcardQuery
FieldSort
GeoDistanceSort
IdSort
ScoreSort
SpatialQuery
ViewQuery

Events


end

Emitted once a query has completed executing and emitting all rows.

Parameters:
Name Type Description
meta Bucket.AnalyticsQueryResponse.Meta
Since:
  • 2.0.8 (stability: committed)

error

Emitted if an error occurs while executing a query.

Parameters:
Name Type Description
error Error
Since:
  • 2.0.8 (stability: committed)

row

Emitted whenever a new row is available from a queries result set.

Parameters:
Name Type Description
row Object
meta Bucket.AnalyticsQueryResponse.Meta
Since:
  • 2.0.8 (stability: committed)

rows

Emitted whenever all rows are available from a queries result set.

Parameters:
Name Type Description
rows Array.<Object>
meta Bucket.AnalyticsQueryResponse.Meta
Since:
  • 2.0.8 (stability: committed)

end

Emitted once a query has completed executing and emitting all rows.

Parameters:
Name Type Description
meta Bucket.FtsQueryResponse.Meta
Since:
  • 2.1.7 (stability: uncommitted)

error

Emitted if an error occurs while executing a query.

Parameters:
Name Type Description
error Error
Since:
  • 2.1.7 (stability: uncommitted)

row

Emitted whenever a new row is available from a queries result set.

Parameters:
Name Type Description
row Object
meta Bucket.FtsQueryResponse.Meta
Since:
  • 2.1.7 (stability: uncommitted)

rows

Emitted whenever all rows are available from a queries result set.

Parameters:
Name Type Description
rows Array.<Object>
meta Bucket.FtsQueryResponse.Meta
Since:
  • 2.1.7 (stability: uncommitted)

end

Emitted once a query has completed executing and emitting all rows.

Parameters:
Name Type Description
meta Bucket.N1qlQueryResponse.Meta
Since:
  • 2.0.8 (stability: committed)

error

Emitted if an error occurs while executing a query.

Parameters:
Name Type Description
error Error
Since:
  • 2.0.8 (stability: committed)

row

Emitted whenever a new row is available from a queries result set.

Parameters:
Name Type Description
row Object
meta Bucket.N1qlQueryResponse.Meta
Since:
  • 2.0.8 (stability: committed)

rows

Emitted whenever all rows are available from a queries result set.

Parameters:
Name Type Description
rows Array.<Object>
meta Bucket.N1qlQueryResponse.Meta
Since:
  • 2.0.8 (stability: committed)

end

Emitted once a query has completed executing and emitting all rows.

Parameters:
Name Type Description
meta Bucket.ViewQueryResponse.Meta
Since:
  • 2.0.0 (stability: committed)

error

Emitted if an error occurs while executing a query.

Parameters:
Name Type Description
error Error
Since:
  • 2.0.0 (stability: committed)

row

Emitted whenever a new row is available from a queries result set.

Parameters:
Name Type Description
row Object
meta Bucket.ViewQueryResponse.Meta
Since:
  • 2.0.0 (stability: committed)

rows

Emitted whenever all rows are available from a queries result set.

Parameters:
Name Type Description
rows Array.<Object>
meta Bucket.ViewQueryResponse.Meta
Since:
  • 2.0.0 (stability: committed)

connect

Connected Event. Invoked once the connection has been established successfully.

Since:
  • 2.0.0 (stability: committed)

error

Error Event. Invoked if the connection encounters any errors without having an operation context available to handle the error.

Parameters:
Name Type Description
err Error

The error that occured while attempting to connect to the cluster.

Since:
  • 2.0.0 (stability: committed)