io.crate.action.sql

Class SQLBaseRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<org.elasticsearch.transport.TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<SQLBaseRequest>

io.crate.action.sql.SQLBaseRequest

All Implemented Interfaces:

org.elasticsearch.common.HasContext, org.elasticsearch.common.HasContextAndHeaders, org.elasticsearch.common.HasHeaders, org.elasticsearch.common.io.stream.Streamable

Direct Known Subclasses:

SQLBulkRequest, SQLRequest

public abstract class SQLBaseRequest
extends org.elasticsearch.action.ActionRequest<SQLBaseRequest>

SQL requests can be made either as bulk operation or as single operation. The TransportActions TransportSQLAction TransportSQLBulkAction are responsible to execute them. In order to use the actions either send a SQLRequest or SQLBulkRequest to them using the SQLAction or SQLBulkAction this abstract base class provides the shared components stmt() and includeTypesOnResponse() which both concrete classes use. (not using links for TransportSQLAction as they're not included for the client and would case an error under oraclejdk8)

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

org.elasticsearch.transport.TransportRequest.Empty

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FLAGS_HEADER_KEY
static int	HEADER_FLAG_ALLOW_QUOTED_SUBSCRIPT
static int	HEADER_FLAG_OFF

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
SQLBaseRequest()
SQLBaseRequest(java.lang.String stmt)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultSchema()
int	getRequestFlags()
boolean	includeTypesOnResponse() See also includeTypesOnResponse(boolean)
void	includeTypesOnResponse(boolean includeTypesOnResponse) set to true if the column types should be included in the SQLResponse or SQLBulkResponse if set to false (the default) the types won't be included in the response.
void	readFrom(org.elasticsearch.common.io.stream.StreamInput in)
void	setDefaultSchema(java.lang.String schemaName)
java.lang.String	stmt() SQL statement as string.
SQLBaseRequest	stmt(java.lang.String stmt)
org.elasticsearch.action.ActionRequestValidationException	validate()
void	writeTo(org.elasticsearch.common.io.stream.StreamOutput out)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FLAGS_HEADER_KEY

public static final java.lang.String FLAGS_HEADER_KEY

See Also:

Constant Field Values

HEADER_FLAG_OFF

public static final int HEADER_FLAG_OFF

See Also:

Constant Field Values

HEADER_FLAG_ALLOW_QUOTED_SUBSCRIPT

public static final int HEADER_FLAG_ALLOW_QUOTED_SUBSCRIPT

See Also:

Constant Field Values

Constructor Detail

SQLBaseRequest

public SQLBaseRequest()

SQLBaseRequest

public SQLBaseRequest(java.lang.String stmt)

Method Detail

stmt

public java.lang.String stmt()

SQL statement as string.

stmt

public SQLBaseRequest stmt(java.lang.String stmt)

includeTypesOnResponse

public void includeTypesOnResponse(boolean includeTypesOnResponse)

set to true if the column types should be included in the SQLResponse or SQLBulkResponse if set to false (the default) the types won't be included in the response.

includeTypesOnResponse

public boolean includeTypesOnResponse()

See also includeTypesOnResponse(boolean)

Returns:

true or false indicating if the column dataTypes will be included in the requests response.

setDefaultSchema

public void setDefaultSchema(java.lang.String schemaName)

getRequestFlags

public int getRequestFlags()

getDefaultSchema

@Nullable
public java.lang.String getDefaultSchema()

validate

public org.elasticsearch.action.ActionRequestValidationException validate()

Specified by:

validate in class org.elasticsearch.action.ActionRequest<SQLBaseRequest>

readFrom

public void readFrom(org.elasticsearch.common.io.stream.StreamInput in)
              throws java.io.IOException

Specified by:

readFrom in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

readFrom in class org.elasticsearch.action.ActionRequest<SQLBaseRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(org.elasticsearch.common.io.stream.StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface org.elasticsearch.common.io.stream.Streamable

Overrides:

writeTo in class org.elasticsearch.action.ActionRequest<SQLBaseRequest>

Throws:

java.io.IOException