Class CopyStatement (0.5.1)

public class CopyStatement extends IntermediateStatement

Inheritance

java.lang.Object > IntermediateStatement > CopyStatement

Constructors

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

public CopyStatement(ConnectionHandler connectionHandler, OptionsMetadata options, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement)
Parameters
Name Description
connectionHandler ConnectionHandler
options OptionsMetadata
parsedStatement ParsedStatement
originalStatement com.google.cloud.spanner.Statement

Methods

close()

public void close()

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

Overrides Exceptions
Type Description
Exception

execute()

public void execute()

getCopyColumnNames()

public List<String> getCopyColumnNames()
Returns
Type Description
List<String>

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

getDelimiterChar()

public char getDelimiterChar()
Returns
Type Description
char

Delimiter character specified in COPY statement, if provided.

getEscapeChar()

public char getEscapeChar()
Returns
Type Description
char

Escape character specified in COPY statement, if provided.

getException()

public Exception getException()
Returns
Type Description
Exception
Overrides

getFormatCode()

public int getFormatCode()
Returns
Type Description
int

0 for text/csv formatting and 1 for binary

getFormatType()

public String getFormatType()
Returns
Type Description
String

Format type specified in COPY statement, if provided.

getMutationWriter()

public MutationWriter getMutationWriter()
Returns
Type Description
MutationWriter

getNullString()

public String getNullString()
Returns
Type Description
String

Null string specified in COPY statement, if provided.

getParserFormat()

public CSVFormat getParserFormat()
Returns
Type Description
org.apache.commons.csv.CSVFormat

getQuoteChar()

public char getQuoteChar()
Returns
Type Description
char

Quote character specified in COPY statement, if provided.

getStatementType()

public AbstractStatementParser.StatementType getStatementType()
Returns
Type Description
StatementType
Overrides

getTableColumns()

public Map<String,TypeCode> getTableColumns()
Returns
Type Description
Map<String,com.google.spanner.v1.TypeCode>

Mapping of table column names to column type.

getTableName()

public String getTableName()
Returns
Type Description
String

getUpdateCount()

public long getUpdateCount()
Returns
Type Description
long
Overrides

handleExecutionException(SpannerException exception)

public void handleExecutionException(SpannerException exception)

Clean up and save metadata when an exception occurs.

Parameter
Name Description
exception com.google.cloud.spanner.SpannerException
Overrides

hasHeader()

public boolean hasHeader()
Returns
Type Description
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
Name Description
options CopyTreeParser.CopyOptions