Class CopyStatement (0.20.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.

Inheritance

java.lang.Object > IntermediateStatement > IntermediatePreparedStatement > IntermediatePortalStatement > CopyStatement

Inherited Members

IntermediatePortalStatement.bind(Statement)

IntermediatePortalStatement.describeAsync(BackendConnection)

IntermediatePortalStatement.executeAsync(BackendConnection)

IntermediatePortalStatement.getParameterFormatCode(int)

IntermediatePortalStatement.getPreparedStatement()

IntermediatePortalStatement.getResultFormatCode(int)

IntermediatePortalStatement.setStatementResult(StatementResult)

IntermediatePreparedStatement.autoDescribeParameters(byte[][],BackendConnection)

IntermediatePreparedStatement.createPortal(String,byte[][],List<Short>,List<Short>)

IntermediatePreparedStatement.describe()

IntermediatePreparedStatement.getGivenParameterDataTypes()

IntermediateStatement.close()

IntermediateStatement.containsResultSet()

IntermediateStatement.createDataRowResponse(Converter)

IntermediateStatement.createResultPrefix(ResultSet)

IntermediateStatement.createResultSuffix()

IntermediateStatement.getCommand()

IntermediateStatement.getCommandTag()

IntermediateStatement.getConnection()

IntermediateStatement.getConnectionHandler()

IntermediateStatement.getException()

IntermediateStatement.getSql()

IntermediateStatement.getStatement()

IntermediateStatement.getStatementResult()

IntermediateStatement.getStatementType()

IntermediateStatement.getUpdateCount()

IntermediateStatement.getUpdateCount(IntermediateStatement.ResultNotReadyBehavior)

IntermediateStatement.handleExecutionException(PGException)

IntermediateStatement.hasException()

IntermediateStatement.hasException(IntermediateStatement.ResultNotReadyBehavior)

IntermediateStatement.isBound()

IntermediateStatement.isDescribed()

IntermediateStatement.isExecuted()

IntermediateStatement.isHasMoreData()

IntermediateStatement.setFutureStatementResult(Future<StatementResult>)

IntermediateStatement.setHasMoreData(boolean)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

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

public static IntermediatePortalStatement create(ConnectionHandler connectionHandler, OptionsMetadata options, String name, AbstractStatementParser.ParsedStatement parsedStatement, Statement originalStatement)

Parameters
Name	Description
`connectionHandler`	`ConnectionHandler`
`options`	`OptionsMetadata`
`name`	`String`
`parsedStatement`	`ParsedStatement`
`originalStatement`	`com.google.cloud.spanner.Statement`

Returns
Type	Description
`IntermediatePortalStatement`

Constructors

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

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

Parameters
Name	Description
`connectionHandler`	`ConnectionHandler`
`options`	`OptionsMetadata`
`name`	`String`
`parsedStatement`	`ParsedStatement`
`originalStatement`	`com.google.cloud.spanner.Statement`
`parsedCopyStatement`	`com.google.cloud.spanner.pgadapter.statements.CopyStatement.ParsedCopyStatement`

Methods

close()

public void close()

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

Overrides

IntermediateStatement.close()

Exceptions
Type	Description
`Exception`

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

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

Creates a portal from this statement.

Parameters
Name	Description
`name`	`String`
`parameters`	`byte[][]`
`parameterFormatCodes`	`List<Short>`
`resultFormatCodes`	`List<Short>`

Returns
Type	Description
`IntermediatePortalStatement`

Overrides

IntermediatePreparedStatement.createPortal(String name, byte[][] parameters, List<Short> parameterFormatCodes, List<Short> resultFormatCodes)

executeAsync(BackendConnection backendConnection)

public void executeAsync(BackendConnection backendConnection)

Parameter
Name	Description
`backendConnection`	`BackendConnection`

Overrides

IntermediatePortalStatement.executeAsync(BackendConnection backendConnection)

getCopyColumnNames()

public List<SimpleParser.TableOrIndexName> getCopyColumnNames()

Returns
Type	Description
`List<com.google.cloud.spanner.pgadapter.statements.SimpleParser.TableOrIndexName>`	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.

getFormatCode()

public byte getFormatCode()

Returns
Type	Description
`byte`	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

IntermediateStatement.getStatementType()

getTableColumns()

public Map<String,Type> getTableColumns()

Returns
Type	Description
`Map<String,com.google.cloud.spanner.Type>`	Mapping of table column names to column type.

getTableName()

public SimpleParser.TableOrIndexName getTableName()

Returns
Type	Description
`com.google.cloud.spanner.pgadapter.statements.SimpleParser.TableOrIndexName`

getUpdateCount()

public long getUpdateCount()

Returns
Type	Description
`long`

Overrides

IntermediateStatement.getUpdateCount()

hasException()

public boolean hasException()

Returns
Type	Description
`boolean`

Overrides

IntermediateStatement.hasException()

hasHeader()

public boolean hasHeader()

Returns
Type	Description
`boolean`	True if copy data contains a header, false otherwise.

setParserFormat(CopyStatement.ParsedCopyStatement parsedCopyStatement)

public void setParserFormat(CopyStatement.ParsedCopyStatement parsedCopyStatement)

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

Parameter
Name	Description
`parsedCopyStatement`	`com.google.cloud.spanner.pgadapter.statements.CopyStatement.ParsedCopyStatement`