Class: N1qlStringQuery

N1qlStringQuery


new N1qlStringQuery()

Class for holding a explicitly defined N1QL query string.

Since:
  • 2.0.0 (stability: committed)

Extends

Methods


adhoc(adhoc)

Specifies whether this query is adhoc or should be prepared.

Parameters:
Name Type Description
adhoc boolean
Since:
  • 2.1.0 (stability: committed)
Returns:
Type
N1qlStringQuery

consistency(val)

Specify the consistency level for this query.

Parameters:
Name Type Description
val N1qlQuery.Consistency
Since:
  • 2.0.10 (stability: committed)
Returns:
Type
N1qlStringQuery

consistentWith(state)

Specifies a MutationState object to ensure this query is consistent with.

Parameters:
Name Type Description
state
Since:
  • 2.1.7 (stability: committed)

pipelineBatch(pipelineBatch)

Controls the number of items execution operators can batch for Fetch from the KV node.

Parameters:
Name Type Description
pipelineBatch number
Since:
  • 2.3.8 (stability: committed)
Returns:
Type
N1qlStringQuery

pipelineCap(pipelineCap)

Maximum number of items each execution operator can buffer between various operators.

Parameters:
Name Type Description
pipelineCap number
Since:
  • 2.3.8 (stability: committed)
Returns:
Type
N1qlStringQuery

pretty(pretty)

Specifies enable/disable formatting a query result

Parameters:
Name Type Description
pretty boolean
Since:
  • 2.3.1 (stability: committed)
Returns:
Type
N1qlStringQuery

profile(profileType)

Controls the profiling mode used during query execution.

Parameters:
Name Type Description
profileType N1qlQuery.ProfileType
Since:
  • 2.4.6 (stability: committed)
Returns:
Type
N1qlStringQuery

rawParam(name, value)

Specifies a raw parameter to pass to the query engine.

Parameters:
Name Type Description
name string
value Object
Since:
  • 2.6.0 (stability: committed)
Returns:
Type
N1qlStringQuery

readonly(readonly)

Controls whether a query can change a resulting recordset. If readonly is true, then only SELECT statements are permitted.

Parameters:
Name Type Description
readonly boolean
Since:
  • 2.3.8 (stability: committed)
Returns:
Type
N1qlStringQuery

scanCap(scanCap)

Maximum buffered channel size between the indexer client and the query service for index scans. This parameter controls when to use scan backfill. Use 0 or a negative number to disable.

Parameters:
Name Type Description
scanCap number
Since:
  • 2.3.8 (stability: committed)
Returns:
Type
N1qlStringQuery

toObject()

Returns the fully prepared object representation of this query.


toString()

Returns the fully prepared string representation of this query.

Overrides: