Class: N1qlStringQuery

Extends

• N1qlQuery

Methods

adhoc(adhoc) → {N1qlStringQuery}

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) → {N1qlStringQuery}

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) → {N1qlStringQuery}

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

Returns:

Type

N1qlStringQuery

pipelineCap(pipelineCap) → {N1qlStringQuery}

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

Parameters:

Name	Type	Description
pipelineCap	number

Since:

• 2.3.8

Returns:

Type

N1qlStringQuery

pretty(pretty) → {N1qlStringQuery}

Specifies enable/disable formatting a query result

Parameters:

Name	Type	Description
pretty	boolean

Since:

• 2.3.1

Returns:

Type

N1qlStringQuery

readonly(readonly) → {N1qlStringQuery}

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

Returns:

Type

N1qlStringQuery

scanCap(scanCap) → {N1qlStringQuery}

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

Returns:

Type

N1qlStringQuery

toObject()

Returns the fully prepared object representation of this query.

toString()

Returns the fully prepared string representation of this query.