Class CopyStatement (0.7.0)

public class CopyStatement extends IntermediatePortalStatement

CopyStatement models a COPY table FROM STDIN statement. The same class is used both as an IntermediatePreparedStatement and IntermediatePortalStatement, as COPY does not support any statement parameters, which means that there is no difference between the two.

Constructors

CopyStatement(ConnectionHandler connectionHandler, OptionsMetadata options, String name, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement)

public CopyStatement(ConnectionHandler connectionHandler, OptionsMetadata options, String name, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement)
Parameters
NameDescription
connectionHandlerConnectionHandler
optionsOptionsMetadata
nameString
parsedStatementParsedStatement
originalStatementcom.google.cloud.spanner.Statement

Methods

bind(String name, byte[][] parameters, List<Short> parameterFormatCodes, List<Short> resultFormatCodes)

public IntermediatePortalStatement bind(String name, byte[][] parameters, List<Short> parameterFormatCodes, List<Short> resultFormatCodes)

Bind this statement (that is to say, transform it into a portal by giving it the data items to complete the statement.

Parameters
NameDescription
nameString
parametersbyte[][]
parameterFormatCodesList<Short>
resultFormatCodesList<Short>
Returns
TypeDescription
IntermediatePortalStatement
Overrides

close()

public void close()

Cleanly close the statement. Does nothing if the statement has not been executed or has no result.

Overrides Exceptions
TypeDescription
Exception

executeAsync(BackendConnection backendConnection)

public void executeAsync(BackendConnection backendConnection)
Parameter
NameDescription
backendConnectionBackendConnection
Overrides

getCopyColumnNames()

public List<String> getCopyColumnNames()
Returns
TypeDescription
List<String>

List of column names specified in COPY statement, if provided.

getDelimiterChar()

public char getDelimiterChar()
Returns
TypeDescription
char

Delimiter character specified in COPY statement, if provided.

getEscapeChar()

public char getEscapeChar()
Returns
TypeDescription
char

Escape character specified in COPY statement, if provided.

getException()

public SpannerException getException()

Returns any execution exception registered for this statement.

Returns
TypeDescription
com.google.cloud.spanner.SpannerException
Overrides

getFormatCode()

public int getFormatCode()
Returns
TypeDescription
int

0 for text/csv formatting and 1 for binary

getFormatType()

public String getFormatType()
Returns
TypeDescription
String

Format type specified in COPY statement, if provided.

getMutationWriter()

public MutationWriter getMutationWriter()
Returns
TypeDescription
MutationWriter

getNullString()

public String getNullString()
Returns
TypeDescription
String

Null string specified in COPY statement, if provided.

getParserFormat()

public CSVFormat getParserFormat()
Returns
TypeDescription
org.apache.commons.csv.CSVFormat

getQuoteChar()

public char getQuoteChar()
Returns
TypeDescription
char

Quote character specified in COPY statement, if provided.

getStatementType()

public AbstractStatementParser.StatementType getStatementType()
Returns
TypeDescription
StatementType
Overrides

getTableColumns()

public Map<String,Type> getTableColumns()
Returns
TypeDescription
Map<String,com.google.cloud.spanner.Type>

Mapping of table column names to column type.

getTableName()

public String getTableName()
Returns
TypeDescription
String

getUpdateCount()

public long getUpdateCount()
Returns
TypeDescription
long
Overrides

hasException()

public boolean hasException()
Returns
TypeDescription
boolean
Overrides

hasHeader()

public boolean hasHeader()
Returns
TypeDescription
boolean

True if copy data contains a header, false otherwise.

setParserFormat(CopyTreeParser.CopyOptions options)

public void setParserFormat(CopyTreeParser.CopyOptions options)

CSVFormat for parsing copy data based on COPY statement options specified.

Parameter
NameDescription
optionsCopyTreeParser.CopyOptions