com.marklogic.client.row

Interface RawSQLPlan

All Superinterfaces:

PlanBuilder.Plan, PlanBuilderBase.PlanBase, RawPlan

public interface RawSQLPlan
extends RawPlan

A Raw SQL Plan provides access to a plan expressed as an SQL SELECT statement. An SQL query can only represent a subset of the capabilities of a plan.

Method Summary

Modifier and Type	Method and Description
TextWriteHandle	getHandle() Returns the handle for the text of the SQL query.
void	setHandle(TextWriteHandle handle) Specifies the handle for the text of the SQL query.
RawSQLPlan	withHandle(TextWriteHandle handle) Assigns the handle and returns the raw plan as a convenience.

Methods inherited from interface com.marklogic.client.expression.PlanBuilder.Plan

bindParam

Methods inherited from interface com.marklogic.client.expression.PlanBuilderBase.PlanBase

bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam, bindParam

Method Detail

getHandle

TextWriteHandle getHandle()

Returns the handle for the text of the SQL query.

Returns:

the text handle for the SQL query

setHandle

void setHandle(TextWriteHandle handle)

Specifies the handle for the text of the SQL query.

Parameters:

handle - the text handle for the SQL query

withHandle

RawSQLPlan withHandle(TextWriteHandle handle)

Assigns the handle and returns the raw plan as a convenience.

Parameters:

handle - the text handle for the SQL query

Returns:

this raw plan object