com.marklogic.client.row.RawSQLPlan Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of marklogic-client-api Show documentation

The official MarkLogic Java client API.

The newest version!

/*
 * Copyright © 2024 MarkLogic Corporation. All Rights Reserved.
 */
package com.marklogic.client.row;

import com.marklogic.client.io.marker.TextWriteHandle;

/**
 * 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.
 */
public interface RawSQLPlan extends RawPlan {
    /**
     * Returns the handle for the text of the SQL query.
     * @return	the text handle for the SQL query
     */
    TextWriteHandle getHandle();
    /**
     * Specifies the handle for the text of the SQL query.
     * @param handle	the text handle for the SQL query
     */
    void setHandle(TextWriteHandle handle);
    /**
     * Assigns the handle and returns the raw plan as a convenience.
     * @param handle	the text handle for the SQL query
     * @return	this raw plan object
     */
    RawSQLPlan withHandle(TextWriteHandle handle);
}